WP_REST_Abilities_V1_List_Controller::get_items( WP_REST_Request $request ): WP_REST_Response

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.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

Response object on success.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

65–109

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

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

• hookthird-party callbacksapply_filters()one call below WP_REST_Abilities_V1_List_Controller::get_items()

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 · 12 distinct outcomes

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

Uses · 8

• wp_get_abilities()Retrieves registered abilities, optionally filtered by the given arguments.
• 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_Response::__construct()
• WP_REST_Abilities_V1_List_Controller::prepare_item_for_response()Prepares an ability for response.
• WP_REST_Abilities_V1_List_Controller::prepare_response_for_collection()

Source code

View on Trac ↗View on GitHub ↗

88	public function get_items( $request ) {89		$query_args = array(90			'meta' => array( 'show_in_rest' => true ),91		);92 93		if ( ! empty( $request['category'] ) ) {94			$query_args['category'] = $request['category'];95		}96 97		if ( ! empty( $request['namespace'] ) ) {98			$query_args['namespace'] = $request['namespace'];99		}100 101		if ( ! empty( $request['meta'] ) ) {102			// Merge caller meta first so the forced show_in_rest filter wins. This keeps a caller from using meta to reveal abilities hidden from REST.103			$query_args['meta'] = array_merge( $request['meta'], $query_args['meta'] );104		}105 106		$abilities = wp_get_abilities( $query_args );107 108		$page     = $request['page'];109		$per_page = $request['per_page'];110		$offset   = ( $page - 1 ) * $per_page;111 112		$total_abilities = count( $abilities );113		$max_pages       = (int) ceil( $total_abilities / $per_page );114 115		if ( $request->get_method() === 'HEAD' ) {116			$response = new WP_REST_Response( array() );117		} else {118			$abilities = array_slice( $abilities, $offset, $per_page );119 120			$data = array();121			foreach ( $abilities as $ability ) {122				$item   = $this->prepare_item_for_response( $ability, $request );123				$data[] = $this->prepare_response_for_collection( $item );124			}125 126			$response = rest_ensure_response( $data );127		}128 129		$response->header( 'X-WP-Total', (string) $total_abilities );130		$response->header( 'X-WP-TotalPages', (string) $max_pages );131 132		$query_params = $request->get_query_params();133		$base         = add_query_arg( urlencode_deep( $query_params ), rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ) );134 135		if ( $page > 1 ) {136			$prev_page = $page - 1;137			$prev_link = add_query_arg( 'page', $prev_page, $base );138			$response->link_header( 'prev', $prev_link );139		}140 141		if ( $page < $max_pages ) {142			$next_page = $page + 1;143			$next_link = add_query_arg( 'page', $next_page, $base );144			$response->link_header( 'next', $next_link );145		}146 147		return $response;148	}

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-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.