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

Compatibility

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

Parameters

$prepared_argsarrayoptional

Array of prepared arguments. Default empty array.Default: array()

$requestWP_REST_Requestoptional

Request to prepare items for.Default: null

Return value

array

Array of query arguments.

Performance profile

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

22–50

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

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 one call costs · 4 distinct outcomes

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

Uses · 3

• add_filter()Adds a callback function to a filter hook.
• WP_REST_Posts_Controller::prepare_items_query()Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.
• WP_REST_Attachments_Controller::get_media_types()Retrieves the supported media types.

Source code

View on Trac ↗View on GitHub ↗

79	protected function prepare_items_query( $prepared_args = array(), $request = null ) {80		$query_args = parent::prepare_items_query( $prepared_args, $request );81 82		if ( empty( $query_args['post_status'] ) ) {83			$query_args['post_status'] = 'inherit';84		}85 86		$all_mime_types = array();87		$media_types    = $this->get_media_types();88 89		if ( ! empty( $request['media_type'] ) && is_array( $request['media_type'] ) ) {90			foreach ( $request['media_type'] as $type ) {91				if ( isset( $media_types[ $type ] ) ) {92					$all_mime_types = array_merge( $all_mime_types, $media_types[ $type ] );93				}94			}95		}96 97		if ( ! empty( $request['mime_type'] ) && is_array( $request['mime_type'] ) ) {98			foreach ( $request['mime_type'] as $mime_type ) {99				$parts = explode( '/', $mime_type );100				if ( isset( $media_types[ $parts[0] ] ) && in_array( $mime_type, $media_types[ $parts[0] ], true ) ) {101					$all_mime_types[] = $mime_type;102				}103			}104		}105 106		if ( ! empty( $all_mime_types ) ) {107			$query_args['post_mime_type'] = array_values( array_unique( $all_mime_types ) );108		}109 110		// Filter query clauses to include filenames.111		if ( isset( $query_args['s'] ) ) {112			add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );113		}114 115		return $query_args;116	}

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.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-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.