Provides a means to get user input from URLs, GET, POST, and COOKIE variables and more.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireInput class also inherits all the methods and properties of: Wire.

Common / URL segments / URLs

Common

Name Return Summary  
$input->cookie() null, mixed or WireInputData Retrieve a named COOKIE variable value or all COOKIE variables
Can also be used as property: $input->cookie
$input->get() null, mixed or WireInputData Retrieve a named GET variable value, or all GET variables (from URL query string)
Can also be used as property: $input->get
$input->post() null, mixed or WireInputData Retrieve a named POST variable value, or all POST variables
Can also be used as property: $input->post
$input->requestMethod() string Return the current request method (i.e. GET, POST, etc.) or blank if not known
$input->whitelist() null, mixed or WireInputData Get or set a whitelist variable
Can also be used as property: $input->whitelist

URL segments

Name Return Summary  
$input->pageNum() int Return the current pagination/page number (starting from 1)
Can also be used as property: $input->pageNum
$input->setPageNum(int $num) (nothing) Set the current page number.
$input->setUrlSegment(int $num, $value) (nothing) Set a URL segment value
$input->urlSegment() string Retrieve the URL segment with the given index (starting from 1)
$input->urlSegment1 string First URL segment
$input->urlSegment2 string Second URL segment
$input->urlSegment3 string Third URL segment, and so on...
$input->urlSegmentStr() string Get the string of URL segments separated by slashes
Can also be used as property: $input->urlSegmentStr
$input->urlSegments() array Retrieve array of all URL segments
Can also be used as property: $input->urlSegments

URLs

Name Return Summary  
$input->httpUrl() string Get the http URL that initiated the current request, including scheme, URL segments and page numbers
Can also be used as property: $input->httpUrl
$input->queryString() string Return the unsanitized query string that was part of this request, or blank if none
Can also be used as property: $input->queryString
$input->scheme() string Return the current access scheme/protocol
Can also be used as property: $input->scheme
$input->url() string Get the URL that initiated the current request, including URL segments and page numbers
Can also be used as property: $input->url

Additional methods and properties

In addition to the methods and properties above, WireInput also inherits the methods and properties of these classes: