wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_get_attachment_id3_keys › WordPress Function

Since3.9.0
Deprecatedn/a
› wp_get_attachment_id3_keys ( $attachment, $context = 'display' )
Parameters: (2)
  • (WP_Post) $attachment The current attachment, provided for context.
    Required: Yes
  • (string) $context Optional. The context. Accepts 'edit', 'display'. Default 'display'.
    Required: No
    Default: 'display'
Returns:
  • (string[]) Key/value pairs of field keys to labels.
Defined at:
Codex:

Returns useful keys to use to lookup data from an attachment's stored metadata.



Related Functions: wp_get_attachment_link, wp_get_attachment_image, wp_get_attachment_image_src, wp_delete_attachment_files, wp_get_attachment_url

Source 

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 );
}