rest_preload_api_request( array $memo, string $path ): array

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$memoarray

Reduce accumulator.

$pathstring

REST API path to preload.

Return value

array

Modified reduce accumulator.

Performance profile

How much work a call to rest_preload_api_request() 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

7–100

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 15 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_preload_api_request() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while rest_preload_api_request() runs, in this order:

1. 1
   apply_filters( rest_post_dispatch )filterline 2961 (+43 into the body)

   Filters the REST API response.

Uses · 7

• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• rest_do_request()Do a REST request.
• rest_get_server()Retrieves the current REST server instance.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_parse_embed_param()Parses the "_embed" parameter into the list of resources to embed.
• WP_REST_Request::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

2918function rest_preload_api_request( $memo, $path ) {2919	/*2920	 * array_reduce() doesn't support passing an array in PHP 5.2,2921	 * so we need to make sure we start with one.2922	 */2923	if ( ! is_array( $memo ) ) {2924		$memo = array();2925	}2926 2927	if ( empty( $path ) ) {2928		return $memo;2929	}2930 2931	$method = 'GET';2932	if ( is_array( $path ) && 2 === count( $path ) ) {2933		$method = end( $path );2934		$path   = reset( $path );2935 2936		if ( ! in_array( $method, array( 'GET', 'OPTIONS' ), true ) ) {2937			$method = 'GET';2938		}2939	}2940 2941	$path = untrailingslashit( $path );2942	if ( empty( $path ) ) {2943		$path = '/';2944	}2945 2946	$path_parts = parse_url( $path );2947	if ( false === $path_parts ) {2948		return $memo;2949	}2950 2951	$request = new WP_REST_Request( $method, $path_parts['path'] );2952	if ( ! empty( $path_parts['query'] ) ) {2953		parse_str( $path_parts['query'], $query_params );2954		$request->set_query_params( $query_params );2955	}2956 2957	$response = rest_do_request( $request );2958	if ( 200 === $response->status ) {2959		$server = rest_get_server();2960		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */2961		$response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $server, $request );2962		$embed    = $request->has_param( '_embed' ) ? rest_parse_embed_param( $request['_embed'] ) : false;2963		$data     = (array) $server->response_to_data( $response, $embed );2964 2965		if ( 'OPTIONS' === $method ) {2966			$memo[ $method ][ $path ] = array(2967				'body'    => $data,2968				'headers' => $response->headers,2969			);2970		} else {2971			$memo[ $path ] = array(2972				'body'    => $data,2973				'headers' => $response->headers,2974			);2975		}2976	}2977 2978	return $memo;2979}

Changelog

Introduced in 5.0.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.7.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.