WP_REST_Attachments_Controller::get_collection_params(): array

Retrieves the query params for collections of attachments.


Return

array Query parameters for the attachment collection as an array.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php. View all references

public function get_collection_params() {
	$params                            = parent::get_collection_params();
	$params['status']['default']       = 'inherit';
	$params['status']['items']['enum'] = array( 'inherit', 'private', 'trash' );
	$media_types                       = $this->get_media_types();

	$params['media_type'] = array(
		'default'     => null,
		'description' => __( 'Limit result set to attachments of a particular media type.' ),
		'type'        => 'string',
		'enum'        => array_keys( $media_types ),
	);

	$params['mime_type'] = array(
		'default'     => null,
		'description' => __( 'Limit result set to attachments of a particular MIME type.' ),
		'type'        => 'string',
	);

	return $params;
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.