Located in file /wire/core/WireInputData.php
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Wire class also inherits all the methods and properties of: Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Wire Wire Wire | array | Sanitize array or CSV String to an array, optionally running elements through specified $sanitizer. | |
Wire Wire Wire | bool | Sanitize value to boolean (true or false) | |
Wire Wire Wire | string int array float null | Maps to Sanitizer functions | |
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | string | Validate and return $varName in the given PHP date() or strftime() format. | |
Wire Wire Wire | string | Sanitize email address, converting to blank if invalid | |
Wire Wire Wire | string | Sanitize string for use in an email header | |
Wire Wire Wire | string | Return an entity encoded version of the value | |
Wire Wire Wire | string | Sanitize to ProcessWire Field name format | |
Wire Wire Wire | string | Sanitize to valid file basename as used by filenames in ProcessWire | |
Wire Wire Wire | array | Find all input vars that match given pattern in name (or optionally value) | |
Wire Wire Wire | string int float array null | Find one input var that matches given pattern in name (or optionally value) | |
Wire Wire Wire | float | Sanitize value to float with optional min and max values. | |
Wire Wire Wire | string int float array null | Get a value | |
Wire Wire Wire | array | Get associative array of all input variables | |
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | int | Sanitize value to integer with optional min and max. Unsigned if max >= 0, signed if max < 0. | |
Wire Wire Wire | array | Sanitize array or CSV string to an array of integers with optional min and max values. | |
Wire Wire Wire | int | Sanitize value to signed integer with optional min and max. | |
Wire Wire Wire | int | Sanitize value to unsigned integer with optional min and max. | |
Wire Wire Wire | string | Sanitize to ProcessWire name format | |
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | (nothing) | ||
Wire Wire Wire | string null | Return value of $varName only if it exists in $allowedValues. | |
Wire Wire Wire | array | Return all values in array $varName that also exist in $allowedValues. | |
Wire Wire Wire | string | Sanitize to ProcessWire Page name format | |
Wire Wire Wire | string | Sanitize to ProcessWire Page name format with translation of non-ASCII characters to ASCII equivalents | |
Wire Wire Wire | string | Sanitize to what could be a valid page path in ProcessWire | |
Wire Wire Wire | string | Return a value run through HTML Purifier (value assumed to contain HTML) | |
Wire Wire Wire | $this | Remove a value from input | |
Wire Wire Wire | $this | Remove all values from input | |
Wire Wire Wire | string | Sanitize a field name for use in a selector string | |
Wire Wire Wire | string | Sanitize a value for use in a selector string | |
Wire Wire Wire | $this | Set a value | |
Wire Wire Wire | $this | Set associative array of variables to store | |
Wire Wire Wire | (nothing) | Set whether or not slashes should be stripped | |
Wire Wire Wire | string | Return a value guaranteed to be a string, regardless of what type $varName is. Does not sanitize. | |
Wire Wire Wire | string | Sanitize to ProcessWire Template name format | |
Wire Wire Wire | string | ) Sanitize to single line of text up to 255 characters (1024 bytes max), HTML markup is removed | |
Wire Wire Wire | string | Sanitize to multi-line text up to 16k characters (48k bytes), HTML markup is removed | |
Wire Wire Wire | string | Sanitize to a valid URL, or convert to blank if it can't be sanitized | |
Wire Wire Wire | string | Sanitize to PHP variable name format |
Additional methods and properties
In addition to the methods and properties above, Wire
API reference based on ProcessWire core version 3.0.236