W3cubDocs

/WordPress

wp_update_attachment_metadata( int $attachment_id, array $data )

Updates metadata for an attachment.

Parameters

$attachment_id

(int) (Required) Attachment post ID.

$data

(array) (Required) Attachment meta data.

Return

(int|bool) False if $post is invalid.

Source

File: wp-includes/post.php 

function wp_update_attachment_metadata( $attachment_id, $data ) {
	$attachment_id = (int) $attachment_id;

	$post = get_post( $attachment_id );
	if ( ! $post ) {
		return false;
	}

	/**
	 * Filters the updated attachment meta data.
	 *
	 * @since 2.1.0
	 *
	 * @param array $data          Array of updated attachment meta data.
	 * @param int   $attachment_id Attachment post ID.
	 */
	$data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID );
	if ( $data ) {
		return update_post_meta( $post->ID, '_wp_attachment_metadata', $data );
	} else {
		return delete_post_meta( $post->ID, '_wp_attachment_metadata' );
	}
}

Uses

Uses Description
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: wp_update_attachment_metadata

Filters the updated attachment meta data.
wp-includes/post.php: update_post_meta()

Updates a post meta field based on the given post ID.
wp-includes/post.php: delete_post_meta()

Deletes a post meta field for the given post ID.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Used By

Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::edit_media_item()

Applies edits to a media item and creates a new attachment record.
wp-admin/includes/image.php: wp_update_image_subsizes()

If any of the currently registered image sub-sizes are missing, create them and update the image meta data.
wp-admin/includes/image.php: wp_create_image_subsizes()

Creates image sub-sizes, adds the new data to the image meta sizes array, and updates the image metadata.
wp-admin/includes/image.php: _wp_make_subsizes()

Low-level function to create image sub-sizes.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::create_item()

Creates a single attachment.
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::insert_attachment()

Inserts an attachment.
wp-admin/includes/ajax-actions.php: wp_ajax_crop_image()

Ajax handler for cropping an image.
wp-admin/includes/image-edit.php: wp_restore_image()

Restores the metadata for a given attachment.
wp-admin/includes/image-edit.php: wp_save_image()

Saves image to post, along with enqueued changes in $_REQUEST['history'].
wp-admin/includes/image.php: wp_generate_attachment_metadata()

Generate attachment meta data and create image sub-sizes for images.
wp-admin/includes/media.php: media_handle_upload()

Saves a file submitted from a POST request and create an attachment post for it.
wp-admin/includes/media.php: media_handle_sideload()

Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
wp-admin/includes/post.php: edit_post()

Update an existing post with values provided in $_POST.
wp-admin/includes/ajax-actions.php: wp_ajax_save_attachment()

Ajax handler for updating attachment attributes.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::insert_attachment()

Insert an attachment and its metadata.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-admin/includes/class-custom-background.php: Custom_Background::handle_upload()

Handle an Image upload for the background image.
wp-includes/media.php: wp_maybe_generate_attachment_metadata()

Maybe attempts to generate attachment metadata, if missing.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newMediaObject()

Uploads a file, following your settings.

Changelog

Version Description
2.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_update_attachment_metadata