render_block_core_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

The block attributes.

$contentstring

The block content.

$blockWP_Block

The block object.

Return value

string

The block content with the data-id attribute added.

Performance profile

How much work a call to render_block_core_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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

10–108

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

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 one call costs · 23 distinct outcomes

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

Uses · 7

• stripos()
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• block_core_image_get_lightbox_settings()Adds the lightboxEnabled flag to the block data.
• wp_enqueue_script_module()Marks the script module to be enqueued in the page.
• add_filter()Adds a callback function to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• class@anonymous::__construct()

Source code

View on Trac ↗View on GitHub ↗

20function render_block_core_image( $attributes, $content, $block ) {21	if ( false === stripos( $content, '<img' ) ) {22		return '';23	}24 25	$processor = new class( $content ) extends WP_HTML_Tag_Processor {26		/**27		 * Return input span for an empty FIGCAPTION element.28		 *29		 * Returns span of input for an empty FIGCAPTION, if currently matched on a30		 * FIGCAPTION opening tag and if the element is properly closed and empty.31		 *32		 * @since 6.9.033		 *34		 * @return WP_HTML_Span|false Span of input if the element is empty; otherwise false.35		 */36		public function block_core_image_extract_empty_figcaption_element() {37			$this->set_bookmark( 'here' );38			$opener = $this->bookmarks['here'];39 40			// Allow comments within the definition of “empty.”41			while ( $this->next_token() && '#comment' === $this->get_token_name() ) {42				continue;43			}44 45			if ( 'FIGCAPTION' !== $this->get_tag() || ! $this->is_tag_closer() ) {46				return false;47			}48 49			$this->set_bookmark( 'here' );50			$closer = $this->bookmarks['here'];51 52			return new WP_HTML_Span( $opener->start, $closer->start + $closer->length - $opener->start );53		}54	};55 56	if ( ! $processor->next_tag( 'img' ) || ! $processor->get_attribute( 'src' ) ) {57		return '';58	}59 60	$has_id_binding = isset( $attributes['metadata']['bindings']['id'] ) && isset( $attributes['id'] );61 62	// Ensure the `wp-image-id` classname on the image block supports block bindings.63	if ( $has_id_binding ) {64		// If there's a mismatch with the 'wp-image-' class and the actual id, the id was65		// probably overridden by block bindings. Update it to the correct value.66		// See https://github.com/WordPress/gutenberg/issues/62886 for why this is needed.67		$id                       = $attributes['id'];68		$image_classnames         = $processor->get_attribute( 'class' );69		$class_with_binding_value = "wp-image-$id";70		if ( is_string( $image_classnames ) && ! str_contains( $image_classnames, $class_with_binding_value ) ) {71			$image_classnames = preg_replace( '/wp-image-(\d+)/', $class_with_binding_value, $image_classnames );72			$processor->set_attribute( 'class', $image_classnames );73		}74	}75 76	// For backwards compatibility, the data-id html attribute is only set for77	// image blocks nested in a gallery. Detect if the image is in a gallery by78	// checking the data-id attribute.79	// See the `block_core_gallery_data_id_backcompatibility` function.80	if ( isset( $attributes['data-id'] ) ) {81		// If there's a binding for the `id`, the `id` attribute is used for the82		// value, since `data-id` does not support block bindings.83		// Else the `data-id` is used for backwards compatibility, since84		// third parties may be filtering its value.85		$data_id = $has_id_binding ? $attributes['id'] : $attributes['data-id'];86		$processor->set_attribute( 'data-id', $data_id );87	}88 89	/*90	 * If the `caption` attribute is empty and we encounter a `<figcaption>` element,91	 * we take note of its span so we can remove it later.92	 */93	if ( $processor->next_tag( 'FIGCAPTION' ) && empty( $attributes['caption'] ) ) {94		$figcaption_span = $processor->block_core_image_extract_empty_figcaption_element();95	}96 97	$link_destination  = $attributes['linkDestination'] ?? 'none';98	$lightbox_settings = block_core_image_get_lightbox_settings( $block->parsed_block );99

Changelog

Introduced in 5.9.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/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.