wp_get_attachment_id3_keys( WP_Post $attachment, string $context = 'display' ): string[]
Returns useful keys to use to lookup data from an attachment’s stored metadata.
Parameters
-
$attachment
WP_Post Required -
The current attachment, provided for context.
-
$context
string Optional -
The context. Accepts
'edit'
,'display'
. Default'display'
.Default:
'display'
Return
string[] Key/value pairs of field keys to labels.
Source
File: wp-includes/media.php
.
View all references
function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
$fields = array(
'artist' => __( 'Artist' ),
'album' => __( 'Album' ),
);
if ( 'display' === $context ) {
$fields['genre'] = __( 'Genre' );
$fields['year'] = __( 'Year' );
$fields['length_formatted'] = _x( 'Length', 'video or audio' );
} elseif ( 'js' === $context ) {
$fields['bitrate'] = __( 'Bitrate' );
$fields['bitrate_mode'] = __( 'Bitrate Mode' );
}
/**
* Filters the editable list of keys to look up data from an attachment's metadata.
*
* @since 3.9.0
*
* @param array $fields Key/value pairs of field keys to labels.
* @param WP_Post $attachment Attachment object.
* @param string $context The context. Accepts 'edit', 'display'. Default 'display'.
*/
return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
}
Hooks
-
apply_filters( 'wp_get_attachment_id3_keys',
array $fields ,WP_Post $attachment ,string $context ) -
Filters the editable list of keys to look up data from an attachment’s metadata.
Changelog
Version | Description |
---|---|
3.9.0 | Introduced. |