WP_REST_Attachments_Controller

Hooks fired · 10

Every hook that fires from inside WP_REST_Attachments_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 1

$allow_batchfalseprotected

Whether the controller supports batching.

Methods · 24

• register_routes()Registers the routes for attachments.
• prepare_items_query()Determines the allowed query_vars for a get_items() response and prepares for WP_Query.
• create_item_permissions_check()Checks if a given request has access to create an attachment.
• create_item()Creates a single attachment.
• insert_attachment()Inserts the attachment post in the database. Does not update the attachment meta.
• handle_featured_media()Determines the featured media based on a request param.
• update_item()Updates a single attachment.
• post_process_item()Performs post-processing on an attachment.
• post_process_item_permissions_check()Checks if a given request can perform post-processing on an attachment.
• edit_media_item_permissions_check()Checks if a given request has access to editing media.
• edit_media_item()Applies edits to a media item and creates a new attachment record.
• prepare_item_for_database()Prepares a single attachment for create or update.
• prepare_item_for_response()Prepares a single attachment output for response.
• prepare_links()Prepares attachment links for the request.
• get_item_schema()Retrieves the attachment's schema, conforming to JSON Schema.
• upload_from_data()Handles an upload via raw POST data.
• get_filename_from_disposition()Parses filename from a Content-Disposition header value.
• get_collection_params()Retrieves the query params for collections of attachments.
• upload_from_file()Handles an upload via multipart/form-data ($_FILES).
• get_media_types()Retrieves the supported media types.
• check_upload_size()Determine if uploaded file exceeds space quota on multisite.
• get_edit_media_item_args()Gets the request args for the edit item route.
• get_attachment_filename()Gets the attachment's original file name.
• get_attachment_filesize()Gets the attachment's file size in bytes.

Source

View on Trac ↗View on GitHub ↗

17class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {18 19	/**20	 * Whether the controller supports batching.21	 *22	 * @since 5.9.023	 * @var false24	 */25	protected $allow_batch = false;26 27	/**28	 * Registers the routes for attachments.29	 *30	 * @since 5.3.031	 *32	 * @see register_rest_route()33	 */34	public function register_routes() {35		parent::register_routes();36		register_rest_route(37			$this->namespace,38			'/' . $this->rest_base . '/(?P<id>[\d]+)/post-process',39			array(40				'methods'             => WP_REST_Server::CREATABLE,41				'callback'            => array( $this, 'post_process_item' ),42				'permission_callback' => array( $this, 'post_process_item_permissions_check' ),43				'args'                => array(44					'id'     => array(45						'description' => __( 'Unique identifier for the attachment.' ),46						'type'        => 'integer',47					),48					'action' => array(49						'type'     => 'string',50						'enum'     => array( 'create-image-subsizes' ),51						'required' => true,52					),53				),54			)55		);56		register_rest_route(57			$this->namespace,58			'/' . $this->rest_base . '/(?P<id>[\d]+)/edit',59			array(60				'methods'             => WP_REST_Server::CREATABLE,61				'callback'            => array( $this, 'edit_media_item' ),62				'permission_callback' => array( $this, 'edit_media_item_permissions_check' ),63				'args'                => $this->get_edit_media_item_args(),64			)65		);66	}67 68	/**69	 * Determines the allowed query_vars for a get_items() response and70	 * prepares for WP_Query.71	 *72	 * @since 4.7.073	 * @since 6.9.0 Extends the `media_type` and `mime_type` request arguments to support array values.74	 *75	 * @param array           $prepared_args Optional. Array of prepared arguments. Default empty array.76	 * @param WP_REST_Request $request       Optional. Request to prepare items for.77	 * @return array Array of query arguments.78	 */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

History

Introduced in 4.7.0. 17 changes between 6.7.7 and 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 7.0.4 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.