$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->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.137

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.