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–122

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

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 · 27 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 2998 (+52 into the body)

   Filters the REST API response.

Uses · 8

• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• 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 ↗

2946function rest_preload_api_request( $memo, $path ) {2947	/*2948	 * array_reduce() doesn't support passing an array in PHP 5.2,2949	 * so we need to make sure we start with one.2950	 */2951	if ( ! is_array( $memo ) ) {2952		$memo = array();2953	}2954 2955	if ( empty( $path ) ) {2956		return $memo;2957	}2958 2959	$method = 'GET';2960	if ( is_array( $path ) && 2 === count( $path ) ) {2961		$method = end( $path );2962		$path   = reset( $path );2963 2964		if ( ! in_array( $method, array( 'GET', 'OPTIONS' ), true ) ) {2965			$method = 'GET';2966		}2967	}2968 2969	// Remove trailing slashes at the end of the REST API path (query part).2970	$path = untrailingslashit( $path );2971	if ( empty( $path ) ) {2972		$path = '/';2973	}2974 2975	$path_parts = parse_url( $path );2976	if ( false === $path_parts ) {2977		return $memo;2978	}2979 2980	if ( isset( $path_parts['path'] ) && '/' !== $path_parts['path'] ) {2981		// Remove trailing slashes from the "path" part of the REST API path.2982		$path_parts['path'] = untrailingslashit( $path_parts['path'] );2983		$path               = str_contains( $path, '?' ) ?2984			$path_parts['path'] . '?' . ( $path_parts['query'] ?? '' ) :2985			$path_parts['path'];2986	}2987 2988	$request = new WP_REST_Request( $method, $path_parts['path'] );2989	if ( ! empty( $path_parts['query'] ) ) {2990		parse_str( $path_parts['query'], $query_params );2991		$request->set_query_params( $query_params );2992	}2993 2994	$response = rest_do_request( $request );2995	if ( 200 === $response->status ) {2996		$server = rest_get_server();2997		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */2998		$response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $server, $request );2999		$embed    = $request->has_param( '_embed' ) ? rest_parse_embed_param( $request['_embed'] ) : false;3000		$data     = (array) $server->response_to_data( $response, $embed );3001 3002		if ( 'OPTIONS' === $method ) {3003			$memo[ $method ][ $path ] = array(3004				'body'    => $data,3005				'headers' => $response->headers,3006			);3007		} else {3008			$memo[ $path ] = array(3009				'body'    => $data,3010				'headers' => $response->headers,3011			);3012		}3013	}3014 3015	return $memo;3016}

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 7.0.4 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.