$input API variable / WireInput class

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.

Show $var?             Show args?        

Common

NameReturnSummary 
$input->cookie()
null mixed WireInputDataRetrieve a named COOKIE variable value or all COOKIE variables
Can also be used as property: $input->cookie
 
$input->get()
null mixed WireInputDataRetrieve a named GET variable value, or all GET variables (from URL query string)
Can also be used as property: $input->get
 
$input->httpsUrl()
stringSame as httpUrl() method but always uses https scheme, rather than current request scheme 
$input->is(string $method)
boolIs the current request of the specified type? 
$input->post()
null mixed WireInputDataRetrieve a named POST variable value, or all POST variables
Can also be used as property: $input->post
 
$input->requestMethod()
string boolReturn the current request method (i.e. GET, POST, etc.) or blank if not known 
$input->setLazy()
(nothing)Set for lazy loading 
$input->whitelist()
null mixed WireInputDataGet or set a whitelist variable
Can also be used as property: $input->whitelist
 

URL segments

NameReturnSummary 
$input->pageNum()
intReturn the current pagination/page number (starting from 1)
Can also be used as property: $input->pageNum
 
$input->pageNumStr()
stringReturn the string that represents the page number URL segment 
$input->setPageNum(int $num)
(nothing)Set the current page number. 
$input->setUrlSegment(int $num, $value)
(nothing)Set a URL segment value 
$input->urlSegment()
stringRetrieve 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()
stringGet the string of URL segments separated by slashes
Can also be used as property: $input->urlSegmentStr
 
$input->urlSegments()
arrayRetrieve array of all URL segments
Can also be used as property: $input->urlSegments
 

URLs

NameReturnSummary 
$input->httpHostUrl()
stringGet current scheme and URL for hostname without any path or query string 
$input->httpUrl()
stringGet 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()
stringReturn the unsanitized query string that was part of this request, or blank if none
Can also be used as property: $input->queryString
 
$input->scheme()
stringReturn the current access scheme/protocol
Can also be used as property: $input->scheme
 
$input->url()
stringGet 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:

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull