wp_read_audio_metadata( string $file ): array|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$filestring

Path to file.

Return value

array|false

Returns array of metadata, if found.

Performance profile

How much work a call to wp_read_audio_metadata() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

6–93

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 95.

Plugin surface

1 hook

Third-party callbacks on 'wp_read_audio_metadata' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_read_audio_metadata() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_read_audio_metadata() runs, in this order:

1. 1
   apply_filters( wp_read_audio_metadata )filterline 3758 (+72 into the body)

   Filters the array of metadata retrieved from an audio file.

Uses · 5

• get_temp_dir()Determines a writable directory for temporary files.
• wp_get_media_creation_timestamp()Parses creation date from media metadata.
• wp_add_id3_tag_data()Parses ID3v2, ID3v1, and getID3 comments to extract usable data.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• getID3::__construct()

Used by · 2

• media_handle_upload()Saves a file submitted from a POST request and create an attachment post for it.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.

Source code

View on Trac ↗View on GitHub ↗

3686function wp_read_audio_metadata( $file ) {3687	if ( ! file_exists( $file ) ) {3688		return false;3689	}3690 3691	$metadata = array();3692 3693	if ( ! defined( 'GETID3_TEMP_DIR' ) ) {3694		define( 'GETID3_TEMP_DIR', get_temp_dir() );3695	}3696 3697	if ( ! class_exists( 'getID3', false ) ) {3698		require ABSPATH . WPINC . '/ID3/getid3.php';3699	}3700 3701	$id3 = new getID3();3702	// Required to get the `created_timestamp` value.3703	$id3->options_audiovideo_quicktime_ReturnAtomData = true; // phpcs:ignore WordPress.NamingConventions.ValidVariableName3704 3705	$data = $id3->analyze( $file );3706 3707	if ( ! empty( $data['audio'] ) ) {3708		unset( $data['audio']['streams'] );3709		$metadata = $data['audio'];3710	}3711 3712	if ( ! empty( $data['fileformat'] ) ) {3713		$metadata['fileformat'] = $data['fileformat'];3714	}3715 3716	if ( ! empty( $data['filesize'] ) ) {3717		$metadata['filesize'] = (int) $data['filesize'];3718	}3719 3720	if ( ! empty( $data['mime_type'] ) ) {3721		$metadata['mime_type'] = $data['mime_type'];3722	}3723 3724	if ( ! empty( $data['playtime_seconds'] ) ) {3725		$metadata['length'] = (int) round( $data['playtime_seconds'] );3726	}3727 3728	if ( ! empty( $data['playtime_string'] ) ) {3729		$metadata['length_formatted'] = $data['playtime_string'];3730	}3731 3732	if ( empty( $metadata['created_timestamp'] ) ) {3733		$created_timestamp = wp_get_media_creation_timestamp( $data );3734 3735		if ( false !== $created_timestamp ) {3736			$metadata['created_timestamp'] = $created_timestamp;3737		}3738	}3739 3740	wp_add_id3_tag_data( $metadata, $data );3741 3742	$file_format = isset( $metadata['fileformat'] ) ? $metadata['fileformat'] : null;3743 3744	/**3745	 * Filters the array of metadata retrieved from an audio file.3746	 *3747	 * In core, usually this selection is what is stored.3748	 * More complete data can be parsed from the `$data` parameter.3749	 *3750	 * @since 6.1.03751	 *3752	 * @param array       $metadata    Filtered audio metadata.3753	 * @param string      $file        Path to audio file.3754	 * @param string|null $file_format File format of audio, as analyzed by getID3.3755	 *                                 Null if unknown.3756	 * @param array       $data        Raw metadata from getID3.3757	 */3758	return apply_filters( 'wp_read_audio_metadata', $metadata, $file, $file_format, $data );3759}

Changelog

Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/media.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.