WP_REST_Attachments_Controller

Hooks fired · 15

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 · 38

• register_routes()Registers the routes for attachments.
• get_endpoint_args_for_item_schema()Retrieves the query params for the attachments collection.
• 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.
• create_item_from_url()Sideloads an external image from a URL into the media library.
• remove_client_side_media_processing_filters()Removes filters added for client-side media processing.
• 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.
• sideload_item_permissions_check()Checks if a given request has access to sideload a file.
• validate_image_size_names()Validates an image size name, or an array of names sharing a single file.
• get_special_image_sizes()Returns the image size names which name a single file rather than a sub-size.
• validate_image_dimensions()Validates that uploaded image dimensions are appropriate for the specified image size.
• dimension_exceeds_max()Checks whether a dimension exceeds the maximum allowed value.
• sideload_item()Side-loads a media file without creating a new attachment.
• filter_wp_unique_filename()Filters wp_unique_filename during sideloads.
• validate_sub_size_provenance()Validates the `sub_sizes` file names against what this attachment produced.
• get_sideloaded_file_names()Returns the file names which a finalize request may store for an attachment.
• get_attachment_upload_subdir()Returns the uploads subdirectory an attachment is stored in.
• finalize_item()Finalizes an attachment after client-side media processing.

Source

View on Trac ↗View on GitHub ↗

27class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {28 29	/**30	 * Whether the controller supports batching.31	 *32	 * @since 5.9.033	 * @var false34	 */35	protected $allow_batch = false;36 37	/**38	 * Image size token for the source-format original preserved alongside a39	 * client-generated derivative (e.g. the HEIC file kept next to its JPEG).40	 *41	 * Used both in the `/sideload` route schema and when dispatching the42	 * sideloaded file to its metadata key, so the two never drift apart.43	 *44	 * @since 7.1.045	 * @var string46	 */47	const IMAGE_SIZE_SOURCE_ORIGINAL = 'source_original';48 49	/**50	 * Metadata key holding the basename of the source-format original.51	 *52	 * Deliberately specific so it never collides with the generic `original`53	 * or `original_image` keys other flows write to.54	 *55	 * @since 7.1.056	 * @var string57	 */58	const META_KEY_SOURCE_IMAGE = 'source_image';59 60	/**61	 * Post meta key recording the file names produced by the sideload endpoint.62	 *63	 * Each successful sideload appends the file name(s) it created for an64	 * attachment under this key. The finalize endpoint reads them back to65	 * confirm every stored sub-size was actually produced here, rather than66	 * trusting a client-supplied name that could point at another attachment's67	 * files. Stored as one row per value (via {@see add_post_meta()}) so concurrent68	 * sideloads never read-modify-write a shared value.69	 *70	 * @since 7.1.071	 * @var string72	 */73	const META_KEY_SIDELOAD_FILE_NAME = '_wp_sideloaded_file';74 75	/**76	 * Registers the routes for attachments.77	 *78	 * @since 5.3.079	 *80	 * @see register_rest_route()81	 */82	public function register_routes() {83		parent::register_routes();84		register_rest_route(85			$this->namespace,86			'/' . $this->rest_base . '/(?P<id>[\d]+)/post-process',87			array(88				'methods'             => WP_REST_Server::CREATABLE,89				'callback'            => array( $this, 'post_process_item' ),90				'permission_callback' => array( $this, 'post_process_item_permissions_check' ),91				'args'                => array(92					'id'     => array(93						'description' => __( 'Unique identifier for the attachment.' ),94						'type'        => 'integer',95					),96					'action' => array(97						'type'     => 'string',98						'enum'     => array( 'create-image-subsizes' ),99						'required' => true,100					),101				),102			)103		);104		register_rest_route(105			$this->namespace,106			'/' . $this->rest_base . '/(?P<id>[\d]+)/edit',

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.1.0 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.