rest_get_server(): WP_REST_Server
- Since
- 4.5.0
- Source
wp-includes/rest-api.php:629
Description
Instantiates a new instance if none exists already.
Compatibility
- WordPress
- since 4.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.
Return value
WP_REST_Server- REST server instance.
Performance profile
How much work a call to rest_get_server() 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–17
- Plugin surface
- 2 hooks
- Called by
- 7
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.
Third-party callbacks on 'wp_rest_server_class', 'rest_api_init' run inside this call, and their cost is not bounded by anything here.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
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_get_server() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($wp_rest_server) | 4 | none |
empty($wp_rest_server) | 17 | apply_filters(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 17 instructions, 4–17 executed per call, 1 branch. The work does not change between versions.
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.
Hooks and filters fired · 2
2 hooks fire while rest_get_server() runs, in this order:
- apply_filters( wp_rest_server_class )filterline 644 (+15 into the body)
Filters the REST Server Class.
- do_action( rest_api_init )actionline 657 (+28 into the body)
Fires when preparing to serve a REST API request.
Uses · 2
- apply_filters()Calls the callback functions that have been added to a filter hook.
- do_action()Calls the callback functions that have been added to an action hook.
Used by · 7
- WP_REST_Controller::prepare_response_for_collection()Prepares a response for insertion into a collection.
- WP_REST_Server::get_target_hints_for_link()Gets the target hints for a REST API Link.
- register_rest_route()Registers a REST API route.
- rest_api_loaded()Loads the REST API.
- rest_cookie_check_errors()Checks for errors when using cookie-based authentication.
- rest_do_request()Do a REST request.
- rest_preload_api_request()Append result of internal request to REST API for purpose of preloading data to be attached to a page.
Changelog
Introduced in 4.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.