WP_REST_Revisions_Controller::prepare_items_query

Advertisement

Summery Summery

Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.

Syntax Syntax

WP_REST_Revisions_Controller::prepare_items_query( array $prepared_args = array(), WP_REST_Request $request = null )

Parameters Parameters

$prepared_args

(array) (Optional) Prepared WP_Query arguments.

Default value: array()

$request

(WP_REST_Request) (Optional) Full details about the request.

Default value: null

Return Return

(array) Items query arguments.

Source Source

File: wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
			$query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
		}

		// Map to proper WP_Query orderby param.
		if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
			$orderby_mappings = array(
				'id'            => 'ID',
				'include'       => 'post__in',
				'slug'          => 'post_name',
				'include_slugs' => 'post_name__in',
			);

			if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {
				$query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];
			}
		}

		return $query_args;
	}

	/**
	 * Prepares the revision for the REST response.
	 *

Advertisement

Changelog Changelog

Changelog
Version Description
5.0.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.