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.
Available since version 3.0.141. You can also get directly or use __get(), both of which are compatible with all versions
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
Name | Type(s) | Description |
---|---|---|
key | string | 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.236