rest_get_server(): WP_REST_Server

Description

Compatibility

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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

4–17

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 17.

Plugin surface

2 hooks

Third-party callbacks on 'wp_rest_server_class', 'rest_api_init' run inside this call, and their cost is not bounded by anything here.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_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.

Hooks and filters fired · 2

2 hooks fire while rest_get_server() runs, in this order:

1. 1
   apply_filters( wp_rest_server_class )filterline 632 (+15 into the body)

   Filters the REST Server Class.

2. 2
   do_action( rest_api_init )actionline 645 (+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.

Source code

View on Trac ↗View on GitHub ↗

617function rest_get_server() {618	/* @var WP_REST_Server $wp_rest_server */619	global $wp_rest_server;620 621	if ( empty( $wp_rest_server ) ) {622		/**623		 * Filters the REST Server Class.624		 *625		 * This filter allows you to adjust the server class used by the REST API, using a626		 * different class to handle requests.627		 *628		 * @since 4.4.0629		 *630		 * @param string $class_name The name of the server class. Default 'WP_REST_Server'.631		 */632		$wp_rest_server_class = apply_filters( 'wp_rest_server_class', 'WP_REST_Server' );633		$wp_rest_server       = new $wp_rest_server_class();634 635		/**636		 * Fires when preparing to serve a REST API request.637		 *638		 * Endpoint objects should be created and register their hooks on this action rather639		 * than another action to ensure they're only loaded when needed.640		 *641		 * @since 4.4.0642		 *643		 * @param WP_REST_Server $wp_rest_server Server object.644		 */645		do_action( 'rest_api_init', $wp_rest_server );646	}647 648	return $wp_rest_server;649}

Changelog

Introduced in 4.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 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.