render_block_core_cover( array $attributes, string $content ): string

Compatibility

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

Parameters

$attributesarray

The block attributes.

$contentstring

The block rendered content.

Return value

string

Returns the cover block markup, if useFeaturedImage is true.

Performance profile

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

Constant

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

Instructions

8–141

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

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_cover()
• querycontent queryget_post()one call below render_block_core_cover()

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

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

Uses · 11

• wp_oembed_get()Attempts to fetch the embed HTML for a provided URL using oEmbed.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• esc_url()Checks and cleans a URL.
• get_the_post_thumbnail()Retrieves the post thumbnail.
• in_the_loop()Determines whether the caller is in the Loop.
• update_post_thumbnail_cache()Updates cache for thumbnails in the current loop.
• get_the_post_thumbnail_url()Returns the post thumbnail URL.
• get_post_thumbnail_id()Retrieves the post thumbnail ID.
• get_post_meta()Retrieves a post meta field for the given post ID.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

18function render_block_core_cover( $attributes, $content ) {19	// Handle embed video background.20	if (21		isset( $attributes['backgroundType'] ) &&22		'embed-video' === $attributes['backgroundType'] &&23		isset( $attributes['url'] ) &&24		! empty( $attributes['url'] ) &&25		is_string( $attributes['url'] )26	) {27		$url = $attributes['url'];28 29		// Use WordPress's native oEmbed processing (includes caching).30		$oembed_html = wp_oembed_get( $url );31 32		if ( $oembed_html ) {33			// Extract iframe src from the oEmbed HTML.34			preg_match( '/src=["\']([^"\']+)["\']/', $oembed_html, $src_matches );35			if ( ! empty( $src_matches[1] ) ) {36				$iframe_src = $src_matches[1];37 38				// Detect provider from iframe src URL.39				$lower_src = strtolower( $iframe_src );40				$provider  = null;41 42				if ( str_contains( $lower_src, 'youtube.com' ) || str_contains( $lower_src, 'youtu.be' ) ) {43					$provider = 'youtube';44				} elseif ( str_contains( $lower_src, 'vimeo.com' ) ) {45					$provider = 'vimeo';46				} elseif ( str_contains( $lower_src, 'videopress.com' ) ) {47					$provider = 'videopress';48				} elseif ( str_contains( $lower_src, 'wordpress.tv' ) ) {49					$provider = 'wordpress-tv';50				}51 52				// Modify iframe src to add background video parameters based on provider.53				$parsed_url = wp_parse_url( $iframe_src );54				if ( $parsed_url && isset( $parsed_url['host'] ) ) {55					// Parse existing query parameters.56					$query_params = array();57					if ( isset( $parsed_url['query'] ) ) {58						parse_str( $parsed_url['query'], $query_params );59					}60 61					// Add background video parameters based on provider.62					if ( 'youtube' === $provider ) {63						$query_params['autoplay']       = '1';64						$query_params['mute']           = '1';65						$query_params['loop']           = '1';66						$query_params['controls']       = '0';67						$query_params['modestbranding'] = '1';68						$query_params['playsinline']    = '1';69 70						// For loop to work, we need the playlist parameter.71						$path          = $parsed_url['path'] ?? '';72						$path_segments = explode( '/', $path );73						$video_id      = end( $path_segments );74						if ( $video_id ) {75								$query_params['playlist'] = $video_id;76						}77					} elseif ( 'vimeo' === $provider ) {78						$query_params['autoplay']    = '1';79						$query_params['muted']       = '1';80						$query_params['loop']        = '1';81						$query_params['background']  = '1';82						$query_params['controls']    = '0';83						$query_params['transparent'] = '0';84					} elseif ( 'videopress' === $provider || 'wordpress-tv' === $provider ) {85						$query_params['autoplay'] = '1';86						$query_params['loop']     = '1';87						$query_params['muted']    = '1';88					}89 90					// Rebuild the URL with new parameters.91					$iframe_src = $parsed_url['scheme'] . '://' . $parsed_url['host'];92					if ( isset( $parsed_url['path'] ) ) {93						$iframe_src .= $parsed_url['path'];94					}95					if ( ! empty( $query_params ) ) {96						$iframe_src .= '?' . http_build_query( $query_params );97					}

Changelog

Introduced in 6.0.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-includes/blocks/cover.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.