render_block_core_playlist( array $attributes, string $content, WP_Block $block ): string

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attributesarray

The block attributes.

$contentstring

The block content.

$blockWP_Block

The block instance.

Return value

string

Returns the Playlist.

Performance profile

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

16–175

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below render_block_core_playlist()

Further down the call graph this can also reach option, cache, serialize, query 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 · 11 distinct outcomes

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

Uses · 12

• wp_unique_id()Gets unique ID.
• __()Retrieves the translation of $text.
• _x()Retrieves translated string with gettext context.
• esc_url()Checks and cleans a URL.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• wp_enqueue_script_module()Marks the script module to be enqueued in the page.
• wp_interactivity_state()Gets and/or sets the initial state of an Interactivity API store for a given namespace.
• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• esc_attr_x()Translates string with gettext context, and escapes it for safe use in an attribute.
• esc_attr()Escaping for HTML attributes.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

19function render_block_core_playlist( $attributes, $content, $block ) {20	$playlist_id              = wp_unique_id( 'playlist-' );21	$playlist_tracks          = array();22	$tracks_data              = array();23	$show_play_button_artwork = ! empty( $attributes['showPlayButtonArtwork'] );24 25	// Parse inner blocks to extract track data.26	// This approach avoids duplicating track data in the HTML output.27	if ( ! empty( $block->inner_blocks ) ) {28		foreach ( $block->inner_blocks as $inner_block ) {29			if ( 'core/playlist-track' === $inner_block->name ) {30				$track_attributes = $inner_block->attributes;31 32				if ( empty( $track_attributes['id'] ) ) {33					continue;34				}35 36				$track_id          = 'track-' . count( $playlist_tracks );37				$playlist_tracks[] = $track_id;38 39				// Extract track metadata from block attributes.40				$title      = isset( $track_attributes['title'] ) && ! empty( $track_attributes['title'] ) ? $track_attributes['title'] : __( 'Unknown title' );41				$artist     = $track_attributes['artist'] ?? '';42				$album      = $track_attributes['album'] ?? '';43				$image      = $track_attributes['image'] ?? '';44				$image_alt  = $track_attributes['imageAlt'] ?? '';45				$url        = $track_attributes['src'] ?? '';46				$aria_label = $title;47 48				if ( $title && $artist && $album ) {49					$aria_label = sprintf(50						/* translators: %1$s: track title, %2$s: artist name, %3$s: album name. */51						_x( '%1$s by %2$s from the album %3$s', 'track title, artist name, album name' ),52						$title,53						$artist,54						$album55					);56				}57 58				// Data is passed to wp_interactivity_state() which JSON-encodes it,59				// so we use wp_strip_all_tags() instead of esc_html() to prevent60				// HTML injection without double-encoding. URLs still use esc_url().61				$tracks_data[ $track_id ] = array(62					'url'       => esc_url( $url ),63					'title'     => wp_strip_all_tags( $title ),64					'artist'    => wp_strip_all_tags( $artist ),65					'album'     => wp_strip_all_tags( $album ),66					'image'     => esc_url( $image ),67					'imageAlt'  => wp_strip_all_tags( $image_alt ),68					'ariaLabel' => wp_strip_all_tags( $aria_label ),69				);70			}71		}72	}73 74	if ( empty( $playlist_tracks ) ) {75		return '';76	}77 78	wp_enqueue_script_module( '@wordpress/block-library/playlist/view' );79 80	// Add the playlist tracks to the global state,81	// but keep them isolated from other playlists with the help of playlistId.82	wp_interactivity_state(83		'core/playlist',84		array(85			'playlists' => array(86				$playlist_id => array(87					'tracks' => $tracks_data,88				),89			),90		)91	);92 93	// Add waveform player container with translated button labels.94	$label_play  = esc_attr__( 'Play' );95	$label_pause = esc_attr__( 'Pause' );96	$label_seek  = esc_attr__( 'Seek' );97	/* translators: %1$s: current audio time, %2$s: total audio duration. */98	$label_seek_value                       = esc_attr_x(

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/playlist.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.