render_block_core_post_featured_image( array $attributes, string $content, WP_Block $block ): 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

Block attributes.

$contentstring

Block default content.

$blockWP_Block

Block instance.

Return value

string

Returns the featured image for the current post.

Performance profile

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

51–192

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

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

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()one call below render_block_core_post_featured_image()

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 · 160 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 13

• get_block_core_post_featured_image_border_attributes()Generates class names and styles to apply the border support styles for the Post Featured Image block.
• get_block_core_post_featured_image_overlay_element_markup()Generate markup for the HTML element that will be used for the overlay.
• get_the_title()Retrieves the post title.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• safecss_filter_attr()Filters an inline style attribute and removes disallowed rules.
• wp_style_engine_get_styles()Global public interface method to generate styles from a single style object, e.g. the value of a block's attributes.style object or the top level styles in theme.json.
• get_the_post_thumbnail()Retrieves the post thumbnail.
• get_post()Retrieves post data given a post ID or post object.
• esc_url()Checks and cleans a URL.
• get_the_permalink()Retrieves the full permalink for the current post or post ID.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.

Source code

View on Trac ↗View on GitHub ↗

18function render_block_core_post_featured_image( $attributes, $content, $block ) {19	if ( ! isset( $block->context['postId'] ) ) {20		return '';21	}22	$post_ID = $block->context['postId'];23 24	$is_link        = isset( $attributes['isLink'] ) && $attributes['isLink'];25	$size_slug      = $attributes['sizeSlug'] ?? 'post-thumbnail';26	$attr           = get_block_core_post_featured_image_border_attributes( $attributes );27	$overlay_markup = get_block_core_post_featured_image_overlay_element_markup( $attributes );28 29	if ( $is_link ) {30		$title = get_the_title( $post_ID );31		if ( $title ) {32			$attr['alt'] = trim( strip_tags( $title ) );33		} else {34			$attr['alt'] = sprintf(35				// translators: %d is the post ID.36				__( 'Untitled post %d' ),37				$post_ID38			);39		}40	}41 42	$extra_styles = '';43	$has_width    = array_key_exists( 'width', $attributes ) && null !== $attributes['width'] && '' !== $attributes['width'];44	$has_height   = array_key_exists( 'height', $attributes ) && null !== $attributes['height'] && '' !== $attributes['height'];45 46	if ( ! empty( $attributes['aspectRatio'] ) ) {47		// If there's no non-default value set, let the image's width and height attributes determine its intrinsic aspect ratio.48		if ( 'auto' !== $attributes['aspectRatio'] ) {49			$extra_styles .= esc_attr( safecss_filter_attr( 'aspect-ratio:' . $attributes['aspectRatio'] ) ) . ';';50		}51		$extra_styles .= 'width:100%;';52	}53 54	if ( $has_height ) {55		$extra_styles .= esc_attr( safecss_filter_attr( 'height:' . $attributes['height'] ) ) . ';';56	} elseif ( $has_width ) {57		$extra_styles .= 'height:auto;';58	}59 60	if ( $has_width ) {61		$extra_styles .= esc_attr( safecss_filter_attr( 'width:' . $attributes['width'] ) ) . ';';62	}63 64	if ( ! empty( $attributes['scale'] ) ) {65		$extra_styles .= esc_attr( safecss_filter_attr( 'object-fit:' . $attributes['scale'] ) ) . ';';66	}67	if ( ! empty( $attributes['style']['shadow'] ) ) {68		$shadow_styles = wp_style_engine_get_styles( array( 'shadow' => $attributes['style']['shadow'] ) );69 70		if ( ! empty( $shadow_styles['css'] ) ) {71			$extra_styles .= $shadow_styles['css'];72		}73	}74 75	if ( ! empty( $extra_styles ) ) {76		$attr['style'] = empty( $attr['style'] ) ? $extra_styles : $attr['style'] . $extra_styles;77	}78 79	$featured_image = get_the_post_thumbnail( $post_ID, $size_slug, $attr );80 81	// Get the first image from the post.82	if ( $attributes['useFirstImageFromPost'] && ! $featured_image ) {83		$content_post = get_post( $post_ID );84		$content      = $content_post->post_content;85		$processor    = new WP_HTML_Tag_Processor( $content );86 87		/*88		 * Transfer the image tag from the post into a new text snippet.89		 * Because the HTML API doesn't currently expose a way to extract90		 * HTML substrings this is necessary as a workaround. Of note, this91		 * is different than directly extracting the IMG tag:92		 * - If there are duplicate attributes in the source there will only be one in the output.93		 * - If there are single-quoted or unquoted attributes they will be double-quoted in the output.94		 * - If there are named character references in the attribute values they may be replaced with their direct code points. E.g. `…` becomes `…`.95		 * In the future there will likely be a mechanism to copy snippets of HTML from96		 * one document into another, via the HTML Processor's `get_outer_html()` or97		 * equivalent. When that happens it would be appropriate to replace this custom

Changelog

Introduced in 5.8.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/post-featured-image.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.