rest_api_loaded()
- Since
- 4.4.0
- Source
wp-includes/rest-api.php:428
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.
Performance profile
How much work a call to rest_api_loaded() 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
- 5–51
- Plugin surface
- None
- Called by
- 0
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 53.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below rest_api_loaded()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_api_loaded() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($value) | 5 | none |
!empty($value) && isset($value) && $value instanceof && ->is_dispatching() | 14 | ->is_dispatching() |
!empty($value) | 31–35 | rest_get_server(), untrailingslashit(), ->serve_request(), exit() |
!empty($value) && isset($value) && $value instanceof && !->is_dispatching() | 38–39 | ->is_dispatching(), rest_get_server(), untrailingslashit(), ->serve_request(), exit() |
!empty($value) | 43–47 | __(), wp_die(), rest_get_server(), untrailingslashit(), ->serve_request(), exit() |
!empty($value) && isset($value) && $value instanceof && !->is_dispatching() | 50–51 | ->is_dispatching(), __(), wp_die(), rest_get_server(), untrailingslashit(), ->serve_request(), exit() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 53 | 5–51 | 6 | |
| 8.5 | 53 | 5–51 | 6 | |
| 8.4 | 53 | 5–51 | 6 | 2 more instructions than PHP 8.3 |
| 8.3 | 51 | 5–49 | 6 | |
| 8.2 | 51 | 5–49 | 6 | |
| 8.1 | 51 | 5–49 | 6 | 6 fewer instructions than PHP 7.4 |
| 7.4 | 57 | 6–55 | 6 |
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.
Uses · 5
- __()Retrieves the translation of $text.
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- rest_get_server()Retrieves the current REST server instance.
- untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
- WP_Error::__construct()Initializes the error.
Source code
function rest_api_loaded() { if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) { return; } // Short-circuit before define()/die() if a REST dispatch is already in flight. // serve_request() enforces this too; guarding here avoids the trailing die(). if ( isset( $GLOBALS['wp_rest_server'] ) && $GLOBALS['wp_rest_server'] instanceof WP_REST_Server && $GLOBALS['wp_rest_server']->is_dispatching() ) { return; } // Return an error message if query_var is not a string. if ( ! is_string( $GLOBALS['wp']->query_vars['rest_route'] ) ) { $rest_type_error = new WP_Error( 'rest_path_invalid_type', __( 'The REST route parameter must be a string.' ), array( 'status' => 400 ) ); wp_die( $rest_type_error ); } /** * Whether this is a REST Request. * * @since 4.4.0 * @var bool */ define( 'REST_REQUEST', true ); // Initialize the server. $server = rest_get_server(); // Fire off the request. $route = untrailingslashit( $GLOBALS['wp']->query_vars['rest_route'] ); if ( empty( $route ) ) { $route = '/'; } $server->serve_request( $route ); // We're done. die();}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.