WP_REST_Attachments_Controller::get_collection_params() public WP 4.7.0
Retrieves the query params for collections of attachments.
{} It's a method of the class: WP_REST_Attachments_Controller{}
No Hooks.
Return
Array. Query parameters for the attachment collection as an array.
Usage
$WP_REST_Attachments_Controller = new WP_REST_Attachments_Controller(); $WP_REST_Attachments_Controller->get_collection_params();
Changelog
Since 4.7.0 | Introduced. |
Code of WP_REST_Attachments_Controller::get_collection_params() WP REST Attachments Controller::get collection params WP 5.6
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;
}