WireInputDataCookie::get()

Get a cookie value

Gets a previously set cookie value or null if cookie not present or expired. Cookies are a type of user input, so always sanitize (and validate where appropriate) any values.

Example

$val = $input->cookie->foo;
$val = $input->cookie->get('foo'); // same as above
$val = $input->cookie->text('foo'); // get and use text sanitizer

Usage

// basic usage
$string = $wireInputDataCookie->get(string $key);

// usage with all arguments
$string = $wireInputDataCookie->get(string $key, $options = []);

Arguments

NameType(s)Description
$keystring

Name of cookie to get

$options (optional)array int string

Options not currently used, but available for descending classes or future use

Return value

string int float array null

$value


WireInputDataCookie methods and properties

API reference based on ProcessWire core version 3.0.251