wp_audio_shortcode( array $attr, string $content = '' ): string|void

Description

Compatibility

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

Parameters

$attrarray

Attributes of the audio shortcode.

• $srcstringdefault: empty

  URL to the source of the audio file.

• $loopstringdefault: empty

  The 'loop' attribute for the <audio> element.

• $autoplaystringdefault: empty

  The 'autoplay' attribute for the <audio> element.

• $mutedstringdefault: 'false'

  The 'muted' attribute for the <audio> element.

• $preloadstringdefault: 'none'

  The 'preload' attribute for the <audio> element.

• $classstringdefault: 'wp-audio-shortcode'

  The 'class' attribute for the <audio> element.

• $stylestringdefault: 'width: 100%;'

  The 'style' attribute for the <audio> element.

$contentstringoptional

Shortcode content.Default: ''

Return value

string|void

HTML content to display audio.

Performance profile

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

Reaches the database via get_post().

Scaling

Scales with input

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

Instructions

20–175

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

Plugin surface

4 hooks

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

Called by

3

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 60 distinct outcomes

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

Hooks and filters fired · 4

4 hooks fire while wp_audio_shortcode() runs, in this order:

1. 1
   apply_filters( wp_audio_shortcode_override )filterline 3414 (+18 into the body)

   Filters the default audio shortcode output.

2. 2
   apply_filters( wp_audio_shortcode_library )filterline 3484 (+88 into the body)

   Filters the media library used for the audio shortcode.

3. 3
   apply_filters( wp_audio_shortcode_class )filterline 3500 (+104 into the body)

   Filters the class attribute for the audio shortcode output container.

4. 4
   apply_filters( wp_audio_shortcode )filterline 3570 (+174 into the body)

   Filters the audio shortcode output.

Uses · 18

• get_post()Retrieves post data given a post ID or post object.
• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_audio_extensions()Returns a filtered list of supported audio formats.
• shortcode_atts()Combines user attributes with known attributes and fill in defaults when needed.
• wp_check_filetype()Retrieves the file type from the file name.
• wp_get_mime_types()Retrieves the list of mime types and file extensions.
• esc_url()Checks and cleans a URL.
• esc_html()Escaping for HTML blocks.
• get_attached_media()Retrieves media attached to the passed post.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• did_action()Retrieves the number of times an action has been fired during the current request.

Used by · 3

• WP_Widget_Media_Audio::render_media()Render the media on the frontend.
• edit_form_image_editor()Displays the image and editor in the post editor
• prepend_attachment()Wraps attachment in paragraph tag before content.

Source code

View on Trac ↗View on GitHub ↗

3396function wp_audio_shortcode( $attr, $content = '' ) {3397	$post_id = get_post() ? get_the_ID() : 0;3398 3399	static $instance = 0;3400	++$instance;3401 3402	/**3403	 * Filters the default audio shortcode output.3404	 *3405	 * If the filtered output isn't empty, it will be used instead of generating the default audio template.3406	 *3407	 * @since 3.6.03408	 *3409	 * @param string $html     Empty variable to be replaced with shortcode markup.3410	 * @param array  $attr     Attributes of the shortcode. See {@see wp_audio_shortcode()}.3411	 * @param string $content  Shortcode content.3412	 * @param int    $instance Unique numeric ID of this audio shortcode instance.3413	 */3414	$override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instance );3415 3416	if ( '' !== $override ) {3417		return $override;3418	}3419 3420	$audio = null;3421 3422	$default_types = wp_get_audio_extensions();3423	$defaults_atts = array(3424		'src'      => '',3425		'loop'     => '',3426		'autoplay' => '',3427		'muted'    => 'false',3428		'preload'  => 'none',3429		'class'    => 'wp-audio-shortcode',3430		'style'    => 'width: 100%;',3431	);3432	foreach ( $default_types as $type ) {3433		$defaults_atts[ $type ] = '';3434	}3435 3436	$atts = shortcode_atts( $defaults_atts, $attr, 'audio' );3437 3438	$primary = false;3439	if ( ! empty( $atts['src'] ) ) {3440		$type = wp_check_filetype( $atts['src'], wp_get_mime_types() );3441 3442		if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) {3443			return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );3444		}3445 3446		$primary = true;3447		array_unshift( $default_types, 'src' );3448	} else {3449		foreach ( $default_types as $ext ) {3450			if ( ! empty( $atts[ $ext ] ) ) {3451				$type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );3452 3453				if ( strtolower( $type['ext'] ) === $ext ) {3454					$primary = true;3455				}3456			}3457		}3458	}3459 3460	if ( ! $primary ) {3461		$audios = get_attached_media( 'audio', $post_id );3462 3463		if ( empty( $audios ) ) {3464			return;3465		}3466 3467		$audio       = reset( $audios );3468		$atts['src'] = wp_get_attachment_url( $audio->ID );3469 3470		if ( empty( $atts['src'] ) ) {3471			return;3472		}3473 3474		array_unshift( $default_types, 'src' );3475	}

Changelog

Introduced in 3.6.0. One change between 6.7.7 and 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-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.