rest_is_integer( mixed $maybe_integer ): bool
- Since
- 5.5.0
- Source
wp-includes/rest-api.php:1598
Description
This reports whether the value represents an integer; it does not guarantee that the value can be represented as a native PHP integer. Values whose magnitude exceeds PHP_INT_MAX are still reported as integer-like, even though the (int) cast that rest_sanitize_value_from_schema() applies for the 'integer' type cannot round-trip them: an out-of-range numeric string saturates to PHP_INT_MAX or PHP_INT_MIN, while an out-of-range float is an undefined conversion in PHP that yields an arbitrary wrapped value. Likewise, a numeric value with a fractional part that is too large for the fraction to be represented as a float (greater than 2 ** 53) is reported as integer-like.
Compatibility
- WordPress
- since 5.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$maybe_integermixed- The value being evaluated.
Return value
bool- True if an integer, otherwise false.
Performance profile
How much work a call to rest_is_integer() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 4–15
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 18.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_is_integer() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 4–10 | none |
!is_int($maybe_integer) && $maybe_integer | 13–15 | floor() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 18 | 4–15 | 4 | |
| 8.5 | 18 | 4–15 | 4 | |
| 8.4 | 18 | 4–15 | 4 | 5 fewer instructions than PHP 8.3 |
| 8.3 | 23 | 4–20 | 4 | |
| 8.2 | 23 | 4–20 | 4 | |
| 8.1 | 23 | 4–20 | 4 | |
| 7.4 | 23 | 4–20 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Used by · 1
- rest_validate_integer_value_from_schema()Validates an integer value based on a schema.
Source code
function rest_is_integer( $maybe_integer ): bool { if ( is_int( $maybe_integer ) ) { return true; } // A canonical integer string of any magnitude — verified without float conversion. if ( is_string( $maybe_integer ) && preg_match( '/^\s*[+-]?[0-9]+\s*$/', $maybe_integer ) ) { return true; } // Decimal and scientific-notation strings (and floats) keep their historical behavior. if ( ! is_numeric( $maybe_integer ) ) { return false; } $float_value = (float) $maybe_integer; /* * The strict equality here is not the unreliable "are two computed floats equal" comparison * (e.g. 0.1 + 0.2 === 0.3, which is false). It compares a float to its own floor() to ask * "does this float have a fractional part?". A float is whole exactly when it equals its floor, * so the comparison is exact and safe regardless of floating-point representation error. */ return floor( $float_value ) === $float_value;}Changelog
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.