WireInputDataCookie::get() method

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

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.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani