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

Compatibility

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

Parameters

$attributesarray

Attributes of the block being rendered.

$contentstring

Content of the block being rendered.

Return value

string

The content of the block being rendered.

Performance profile

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

5

Executed per call on PHP 8.5. The body compiles to 166.

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 · 1 distinct outcome

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

Uses · 5

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• _wp_to_kebab_case()This function is trying to replicate what lodash's kebabCase (JS library) does in the client.
• wp_unique_id()Gets unique ID.
• wp_style_engine_get_stylesheet_from_css_rules()Returns compiled CSS from a collection of selectors and declarations.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

46function block_core_gallery_render( $attributes, $content ) {47	// Adds a style tag for the --wp--style--unstable-gallery-gap var.48	// The Gallery block needs to recalculate Image block width based on49	// the current gap setting in order to maintain the number of flex columns50	// so a css var is added to allow this.51 52	$gap = $attributes['style']['spacing']['blockGap'] ?? null;53	// Skip if gap value contains unsupported characters.54	// Regex for CSS value borrowed from `safecss_filter_attr`, and used here55	// because we only want to match against the value, not the CSS attribute.56	if ( is_array( $gap ) ) {57		foreach ( $gap as $key => $value ) {58			// Make sure $value is a string to avoid PHP 8.1 deprecation error in preg_match() when the value is null.59			$value = is_string( $value ) ? $value : '';60			$value = $value && preg_match( '%[\\\(&=}]|/\*%', $value ) ? null : $value;61 62			// Get spacing CSS variable from preset value if provided.63			if ( is_string( $value ) && str_contains( $value, 'var:preset|spacing|' ) ) {64				$index_to_splice = strrpos( $value, '|' ) + 1;65				$slug            = _wp_to_kebab_case( substr( $value, $index_to_splice ) );66				$value           = "var(--wp--preset--spacing--$slug)";67			}68 69			$gap[ $key ] = $value;70		}71	} else {72		// Make sure $gap is a string to avoid PHP 8.1 deprecation error in preg_match() when the value is null.73		$gap = is_string( $gap ) ? $gap : '';74		$gap = $gap && preg_match( '%[\\\(&=}]|/\*%', $gap ) ? null : $gap;75 76		// Get spacing CSS variable from preset value if provided.77		if ( is_string( $gap ) && str_contains( $gap, 'var:preset|spacing|' ) ) {78			$index_to_splice = strrpos( $gap, '|' ) + 1;79			$slug            = _wp_to_kebab_case( substr( $gap, $index_to_splice ) );80			$gap             = "var(--wp--preset--spacing--$slug)";81		}82	}83 84	$unique_gallery_classname = wp_unique_id( 'wp-block-gallery-' );85	$processed_content        = new WP_HTML_Tag_Processor( $content );86	$processed_content->next_tag();87	$processed_content->add_class( $unique_gallery_classname );88 89	// --gallery-block--gutter-size is deprecated. --wp--style--gallery-gap-default should be used by themes that want to set a default90	// gap on the gallery.91	$fallback_gap = 'var( --wp--style--gallery-gap-default, var( --gallery-block--gutter-size, var( --wp--style--block-gap, 0.5em ) ) )';92	$gap_value    = $gap ? $gap : $fallback_gap;93	$gap_column   = $gap_value;94 95	if ( is_array( $gap_value ) ) {96		$gap_row    = isset( $gap_value['top'] ) ? $gap_value['top'] : $fallback_gap;97		$gap_column = isset( $gap_value['left'] ) ? $gap_value['left'] : $fallback_gap;98		$gap_value  = $gap_row === $gap_column ? $gap_row : $gap_row . ' ' . $gap_column;99	}100 101	// The unstable gallery gap calculation requires a real value (such as `0px`) and not `0`.102	if ( '0' === $gap_column ) {103		$gap_column = '0px';104	}105 106	// Set the CSS variable to the column value, and the `gap` property to the combined gap value.107	$gallery_styles = array(108		array(109			'selector'     => ".wp-block-gallery.{$unique_gallery_classname}",110			'declarations' => array(111				'--wp--style--unstable-gallery-gap' => $gap_column,112				'gap'                               => $gap_value,113			),114		),115	);116 117	wp_style_engine_get_stylesheet_from_css_rules(118		$gallery_styles,119		array(120			'context' => 'block-supports',121		)122	);123 124	// The WP_HTML_Tag_Processor class calls get_updated_html() internally125	// when the instance is treated as a string, but here we explicitly

Changelog

Introduced in 6.0.0. One change between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

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