$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->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->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()
string intRetrieve matching URL segment number or pattern 
$input->urlSegment1()
string int boolSame as urlSegment() method but apply only to 1st URL segment. (since 3.0.155)
Can also be used as property: $input->urlSegment1
$input->urlSegment2()
string int boolSame as urlSegment() method but apply only to 2nd URL segment. (since 3.0.155)
Can also be used as property: $input->urlSegment2
$input->urlSegment3()
string int boolSame as urlSegment() method but apply only to 3rd URL segment. (since 3.0.155)
Can also be used as property: $input->urlSegment3
$input->urlSegmentFirst()
string int boolSame as urlSegment() method but apply only to first URL segment. (since 3.0.155)
Can also be used as property: $input->urlSegmentFirst
$input->urlSegmentLast()
string int boolSame as urlSegment() method but apply only to last URL segment. (since 3.0.155)
Can also be used as property: $input->urlSegmentLast
$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->canonicalUrl()
stringGenerate canonical URL for current page and request 
$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->httpsUrl()
stringSame as httpUrl() method but always uses https scheme, rather than current request scheme 
$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->queryStringClean()
stringReturn a cleaned query string that was part of this request, or blank if none 
$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.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH