wppaste
WordPress

wp_add_id3_tag_data( array $metadata, array $data )

Since
3.6.0
Source
wp-admin/includes/media.php:3554
Parses ID3v2, ID3v1, and getID3 comments to extract usable data.

Compatibility

WordPress
since 3.6.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$metadataarray
An existing array with data.
$dataarray
Data supplied by ID3 tags.

Performance profile

How much work a call to wp_add_id3_tag_data() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
11–35

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
empty($value)11–20none
!empty($value)16–35reset()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev8211–35142 fewer instructions than PHP 8.5
8.58411–3514
8.48411–35143 fewer instructions than PHP 8.3
8.38711–3514
8.28711–3514
8.18711–35141 fewer instruction than PHP 7.4
7.48811–3514

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

  • wp_kses_post_deep()Navigates through an array, object, or scalar, and sanitizes content for allowed HTML tags for post content.
  • wp_kses_post()Sanitizes content for allowed HTML tags for post content.
  • str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.

Used by · 2

Source code

View on Trac View on GitHub 

function wp_add_id3_tag_data( &$metadata, $data ) {	foreach ( array( 'id3v2', 'id3v1' ) as $version ) {		if ( ! empty( $data[ $version ]['comments'] ) ) {			foreach ( $data[ $version ]['comments'] as $key => $list ) {				if ( 'length' !== $key && ! empty( $list ) ) {					$metadata[ $key ] = is_array( $list ) ? wp_kses_post_deep( reset( $list ) ) : wp_kses_post( $list );					// Fix bug in byte stream analysis.					if ( 'terms_of_use' === $key && str_starts_with( $metadata[ $key ], 'yright notice.' ) ) {						$metadata[ $key ] = 'Cop' . $metadata[ $key ];					}				}			}			break;		}	} 	if ( ! empty( $data['id3v2']['APIC'] ) ) {		$image = reset( $data['id3v2']['APIC'] );		if ( ! empty( $image['data'] ) ) {			$metadata['image'] = array(				'data'   => $image['data'],				'mime'   => $image['image_mime'],				'width'  => $image['image_width'],				'height' => $image['image_height'],			);		}	} elseif ( ! empty( $data['comments']['picture'] ) ) {		$image = reset( $data['comments']['picture'] );		if ( ! empty( $image['data'] ) ) {			$metadata['image'] = array(				'data' => $image['data'],				'mime' => $image['image_mime'],			);		}	}}

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 7.1.0 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.