WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_read_audio_metadata()

wp_read_audio_metadata( string $file ): array|false

In this article

Back to top

Retrieves metadata from an audio file’s ID3 tags.

Parameters

$filestringrequired
Path to file.

Return

array|false Returns array of metadata, if found.

Source

function wp_read_audio_metadata( $file ) {	if ( ! file_exists( $file ) ) {	return false;	}	$metadata = array();	if ( ! defined( 'GETID3_TEMP_DIR' ) ) {	define( 'GETID3_TEMP_DIR', get_temp_dir() );	}	if ( ! class_exists( 'getID3', false ) ) {	require ABSPATH . WPINC . '/ID3/getid3.php';	}	$id3 = new getID3();	// Required to get the `created_timestamp` value.	$id3->options_audiovideo_quicktime_ReturnAtomData = true; // phpcs:ignore WordPress.NamingConventions.ValidVariableName	$data = $id3->analyze( $file );	if ( ! empty( $data['audio'] ) ) {	unset( $data['audio']['streams'] );	$metadata = $data['audio'];	}	if ( ! empty( $data['fileformat'] ) ) {	$metadata['fileformat'] = $data['fileformat'];	}	if ( ! empty( $data['filesize'] ) ) {	$metadata['filesize'] = (int) $data['filesize'];	}	if ( ! empty( $data['mime_type'] ) ) {	$metadata['mime_type'] = $data['mime_type'];	}	if ( ! empty( $data['playtime_seconds'] ) ) {	$metadata['length'] = (int) round( $data['playtime_seconds'] );	}	if ( ! empty( $data['playtime_string'] ) ) {	$metadata['length_formatted'] = $data['playtime_string'];	}	if ( empty( $metadata['created_timestamp'] ) ) {	$created_timestamp = wp_get_media_creation_timestamp( $data );	if ( false !== $created_timestamp ) {	$metadata['created_timestamp'] = $created_timestamp;	}	}	wp_add_id3_tag_data( $metadata, $data );	$file_format = isset( $metadata['fileformat'] ) ? $metadata['fileformat'] : null;	/** * Filters the array of metadata retrieved from an audio file. * * In core, usually this selection is what is stored. * More complete data can be parsed from the `$data` parameter. * * @since 6.1.0 * * @param array $metadata Filtered audio metadata. * @param string $file Path to audio file. * @param string|null $file_format File format of audio, as analyzed by getID3. * Null if unknown. * @param array $data Raw metadata from getID3. */	return apply_filters( 'wp_read_audio_metadata', $metadata, $file, $file_format, $data ); }

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_read_audio_metadata’, array $metadata, string $file, string|null $file_format, array $data )

Filters the array of metadata retrieved from an audio file.

UsesDescription
wp_get_media_creation_timestamp()wp-admin/includes/media.php

Parses creation date from media metadata.

wp_add_id3_tag_data()wp-admin/includes/media.php

Parses ID3v2, ID3v1, and getID3 comments to extract usable data.

get_temp_dir()wp-includes/functions.php

Determines a writable directory for temporary files.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 1 moreShow less
Used byDescription
wp_generate_attachment_metadata()wp-admin/includes/image.php

Generates attachment meta data and create image sub-sizes for images.

media_handle_upload()wp-admin/includes/media.php

Saves a file submitted from a POST request and create an attachment post for it.

Changelog

VersionDescription
3.6.0Introduced.

User Contributed Notes

  2. Skip to note 4 content
    Lucas Marini Falbo
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    This function does not work on the front-end, so if you need to call it on the front-end, first you need to require the library.

    // Requires the media library that unlocks the function require_once ABSPATH . 'wp-admin/includes/media.php'; // Get the audio metadata $meta = wp_read_audio_metadata( $path );

    One important detail that people misses is that the function expects the file path, not the url.

You must log in before being able to contribute a note or feedback.