rest_parse_date( string $date, bool $force_utc = false ): int|false
- Since
- 4.4.0
- Source
wp-includes/rest-api.php:1333
Description
Explicitly check for false to detect failure, as zero is a valid return value on success.
Compatibility
- WordPress
- since 4.4.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
$datestring- RFC3339 timestamp.
$force_utcbooloptional- Whether to force UTC timezone instead of using the timestamp's timezone. Default false.Default:
false
Return value
int|false- Unix timestamp on success, false on failure.
Performance profile
How much work a call to rest_parse_date() 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
- 10–16
- Plugin surface
- None
- Called by
- 2
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 17.
Nothing here hands control to plugin code.
2 places 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_parse_date() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!preg_match() | 10–13 | preg_match() |
preg_match() | 13–16 | preg_match(), strtotime() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 17 | 10–16 | 2 | |
| 8.5 | 17 | 10–16 | 2 | |
| 8.4 | 17 | 10–16 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 20 | 10–19 | 2 | |
| 8.2 | 20 | 10–19 | 2 | |
| 8.1 | 20 | 10–19 | 2 | |
| 7.4 | 20 | 10–19 | 2 |
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 · 2
- rest_get_date_with_gmt()Parses a date into both its local and UTC equivalent, in MySQL datetime format.
- rest_validate_value_from_schema()Validate a value based on a schema.
Source code
function rest_parse_date( $date, $force_utc = false ) { if ( $force_utc ) { $date = preg_replace( '/[+-]\d+:?\d+$/', '+00:00', $date ); } $regex = '#^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}(?::\d{2})?)?$#'; if ( ! preg_match( $regex, $date, $matches ) ) { return false; } return strtotime( $date );}Changelog
Introduced in 4.4.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 6.8.8 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.