WP_REST_Comments_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 error object on failure.

Performance profile

How much work a call to WP_REST_Comments_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

Heavy

Reaches the database via ->query().

Scaling

Scales with input

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

Instructions

82–163

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

Plugin surface

1 hook

Third-party callbacks on 'rest_comment_query' 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
• sqldatabase query->query()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 24 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( rest_comment_query )filterline 275 (+81 into the body)

   Filters WP_Comment_Query arguments when querying comments via the REST API.

Uses · 12

• absint()Converts a value to non-negative integer.
• 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).
• add_query_arg()Retrieves a modified URL query string.
• urlencode_deep()Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
• rest_url()Retrieves the URL to a REST endpoint.
• WP_REST_Comments_Controller::get_collection_params()Retrieves the query params for collections.
• WP_REST_Comments_Controller::normalize_query_param()Prepends internal property prefix to query parameters to match our response fields.
• WP_Comment_Query::__construct()Constructor.
• WP_REST_Comments_Controller::check_read_permission()Checks if the comment can be read.
• WP_REST_Comments_Controller::prepare_item_for_response()Prepares a single comment output for response.
• WP_REST_Comments_Controller::prepare_response_for_collection()

Source code

View on Trac ↗View on GitHub ↗

194	public function get_items( $request ) {195 196		// Retrieve the list of registered collection query parameters.197		$registered = $this->get_collection_params();198 199		/*200		 * This array defines mappings between public API query parameters whose201		 * values are accepted as-passed, and their internal WP_Query parameter202		 * name equivalents (some are the same). Only values which are also203		 * present in $registered will be set.204		 */205		$parameter_mappings = array(206			'author'         => 'author__in',207			'author_email'   => 'author_email',208			'author_exclude' => 'author__not_in',209			'exclude'        => 'comment__not_in',210			'include'        => 'comment__in',211			'offset'         => 'offset',212			'order'          => 'order',213			'parent'         => 'parent__in',214			'parent_exclude' => 'parent__not_in',215			'per_page'       => 'number',216			'post'           => 'post__in',217			'search'         => 'search',218			'status'         => 'status',219			'type'           => 'type',220		);221 222		$prepared_args = array();223 224		/*225		 * For each known parameter which is both registered and present in the request,226		 * set the parameter's value on the query $prepared_args.227		 */228		foreach ( $parameter_mappings as $api_param => $wp_param ) {229			if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {230				$prepared_args[ $wp_param ] = $request[ $api_param ];231			}232		}233 234		// Ensure certain parameter values default to empty strings.235		foreach ( array( 'author_email', 'search' ) as $param ) {236			if ( ! isset( $prepared_args[ $param ] ) ) {237				$prepared_args[ $param ] = '';238			}239		}240 241		if ( isset( $registered['orderby'] ) ) {242			$prepared_args['orderby'] = $this->normalize_query_param( $request['orderby'] );243		}244 245		$prepared_args['no_found_rows'] = false;246 247		$prepared_args['update_comment_post_cache'] = true;248 249		$prepared_args['date_query'] = array();250 251		// Set before into date query. Date query must be specified as an array of an array.252		if ( isset( $registered['before'], $request['before'] ) ) {253			$prepared_args['date_query'][0]['before'] = $request['before'];254		}255 256		// Set after into date query. Date query must be specified as an array of an array.257		if ( isset( $registered['after'], $request['after'] ) ) {258			$prepared_args['date_query'][0]['after'] = $request['after'];259		}260 261		if ( isset( $registered['page'] ) && empty( $request['offset'] ) ) {262			$prepared_args['offset'] = $prepared_args['number'] * ( absint( $request['page'] ) - 1 );263		}264 265		/**266		 * Filters WP_Comment_Query arguments when querying comments via the REST API.267		 *268		 * @since 4.7.0269		 *270		 * @link https://developer.wordpress.org/reference/classes/wp_comment_query/271		 *272		 * @param array           $prepared_args Array of arguments for WP_Comment_Query.273		 * @param WP_REST_Request $request       The REST API request.

Changelog

Introduced in 4.7.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/endpoints/class-wp-rest-comments-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.