WP_REST_Attachments_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters 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.

Changelog

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.