$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

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #297
    In the 297th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.149) and introduce a new third party module called StaticWire. Read on!
    Weekly.pw / 18 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer