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

Latest news

  • ProcessWire Weekly #523
    In the 523rd issue of ProcessWire Weekly we'll check out what's new in the core this week, share some new module related news, and more. Read on!
    Weekly.pw / 18 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits