wp_update_attachment_metadata( int $attachment_id, array $data ): int|false
Updates metadata for an attachment.
Parameters
-
$attachment_idint Required -
Attachment post ID.
-
$dataarray Required -
Attachment meta data.
Return
int|false False if $post is invalid.
Source
File: wp-includes/post.php.
View all references
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' );
}
}
Hooks
-
apply_filters( 'wp_update_attachment_metadata',
array $data ,int $attachment_id ) -
Filters the updated attachment meta data.
Changelog
| Version | Description |
|---|---|
| 2.1.0 | Introduced. |