wp_maybe_generate_attachment_metadata() WordPress Function
The wp_maybe_generate_attachment_metadata() function allows you to check if an attachment has metadata and if not, generate it. This can be useful when you want to ensure that an attachment has all the necessary data before displaying it on your website.
wp_maybe_generate_attachment_metadata( WP_Post $attachment ) #
Maybe attempts to generate attachment metadata, if missing.
Parameters
- $attachment
(WP_Post)(Required)Attachment object.
Source
File: wp-includes/media.php
function wp_maybe_generate_attachment_metadata( $attachment ) { if ( empty( $attachment ) || empty( $attachment->ID ) ) { return; } $attachment_id = (int) $attachment->ID; $file = get_attached_file( $attachment_id ); $meta = wp_get_attachment_metadata( $attachment_id ); if ( empty( $meta ) && file_exists( $file ) ) { $_meta = get_post_meta( $attachment_id ); $_lock = 'wp_generating_att_' . $attachment_id; if ( ! array_key_exists( '_wp_attachment_metadata', $_meta ) && ! get_transient( $_lock ) ) { set_transient( $_lock, $file ); wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) ); delete_transient( $_lock ); } } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.9.0 | Introduced. |