WP_REST_Pattern_Directory_Controller::get_items( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

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

Expensive

Reaches an outbound HTTP request via wp_remote_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

47–115

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• transienttransientget_site_transient()called directly
• httpoutbound HTTP requestwp_remote_get()called directly
• serializeserialisationjson_decode()called directly
• querycontent queryget_user_by()one call below WP_REST_Pattern_Directory_Controller::get_items()
• hookthird-party callbacksapply_filters()one call below WP_REST_Pattern_Directory_Controller::get_items()
• cacheobject cachewp_cache_get()one call below WP_REST_Pattern_Directory_Controller::get_items()
• optionnetwork optionget_site_option()one call below WP_REST_Pattern_Directory_Controller::get_items()

What one call costs · 10 distinct outcomes

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

Uses · 16

• get_user_locale()Retrieves the locale of a user.
• wp_get_wp_version()Returns the current WordPress version.
• get_site_transient()Retrieves the value of a site transient.
• build_query()Builds URL query based on an associative and, or indexed array.
• wp_http_supports()Determines if there is an HTTP Transport that can process this request.
• set_url_scheme()Sets the scheme for a URL.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• set_site_transient()Sets/updates the value of a site transient.
• WP_REST_Pattern_Directory_Controller::get_transient_key()Include a hash of the query args, so that different requests are stored in separate caches.

Source code

View on Trac ↗View on GitHub ↗

89	public function get_items( $request ) {90		$valid_query_args = array(91			'offset'   => true,92			'order'    => true,93			'orderby'  => true,94			'page'     => true,95			'per_page' => true,96			'search'   => true,97			'slug'     => true,98		);99		$query_args       = array_intersect_key( $request->get_params(), $valid_query_args );100 101		$query_args['locale']             = get_user_locale();102		$query_args['wp-version']         = wp_get_wp_version();103		$query_args['pattern-categories'] = isset( $request['category'] ) ? $request['category'] : false;104		$query_args['pattern-keywords']   = isset( $request['keyword'] ) ? $request['keyword'] : false;105 106		$query_args = array_filter( $query_args );107 108		$transient_key = $this->get_transient_key( $query_args );109 110		/*111		 * Use network-wide transient to improve performance. The locale is the only site112		 * configuration that affects the response, and it's included in the transient key.113		 */114		$raw_patterns = get_site_transient( $transient_key );115 116		if ( ! $raw_patterns ) {117			$api_url = 'http://api.wordpress.org/patterns/1.0/?' . build_query( $query_args );118			if ( wp_http_supports( array( 'ssl' ) ) ) {119				$api_url = set_url_scheme( $api_url, 'https' );120			}121 122			/*123			 * Default to a short TTL, to mitigate cache stampedes on high-traffic sites.124			 * This assumes that most errors will be short-lived, e.g., packet loss that causes the125			 * first request to fail, but a follow-up one will succeed. The value should be high126			 * enough to avoid stampedes, but low enough to not interfere with users manually127			 * re-trying a failed request.128			 */129			$cache_ttl      = 5;130			$wporg_response = wp_remote_get( $api_url );131			$raw_patterns   = json_decode( wp_remote_retrieve_body( $wporg_response ) );132 133			if ( is_wp_error( $wporg_response ) ) {134				$raw_patterns = $wporg_response;135 136			} elseif ( ! is_array( $raw_patterns ) ) {137				// HTTP request succeeded, but response data is invalid.138				$raw_patterns = new WP_Error(139					'pattern_api_failed',140					sprintf(141						/* translators: %s: Support forums URL. */142						__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),143						__( 'https://wordpress.org/support/forums/' )144					),145					array(146						'response' => wp_remote_retrieve_body( $wporg_response ),147					)148				);149 150			} else {151				// Response has valid data.152				$cache_ttl = HOUR_IN_SECONDS;153			}154 155			set_site_transient( $transient_key, $raw_patterns, $cache_ttl );156		}157 158		if ( is_wp_error( $raw_patterns ) ) {159			$raw_patterns->add_data( array( 'status' => 500 ) );160 161			return $raw_patterns;162		}163 164		if ( $request->is_method( 'HEAD' ) ) {165			// Return early as this handler doesn't add any response headers.166			return new WP_REST_Response( array() );167		}168

Changelog

Introduced in 5.8.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.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.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.