render_block_core_button( 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 content.

Return value

string

The block content.

Performance profile

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

Moderate

Only touches the object cache, via wp_cache_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–124

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

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

• cacheobject cachewp_cache_get()one call below render_block_core_button()

What one call costs · 46 distinct outcomes

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

Uses · 5

• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_get_global_settings()Gets the settings resulting of merging core, theme, and user data.
• str_ends_with()Polyfill for `str_ends_with()` 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_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

18function render_block_core_button( $attributes, $content ) {19	$p = new WP_HTML_Tag_Processor( $content );20 21	/*22	 * The button block can render an `<a>` or `<button>` and also has a23	 * `<div>` wrapper. Find the a or button tag.24	 */25	$tag = null;26	while ( $p->next_tag() ) {27		$tag = $p->get_tag();28		if ( 'A' === $tag || 'BUTTON' === $tag ) {29			break;30		}31	}32 33	/*34	 * If this happens, the likelihood is there's no block content,35	 * or the block has been modified by a plugin.36	 */37	if ( null === $tag ) {38		return $content;39	}40 41	// If the next token is the closing tag, the button is empty.42	$is_empty = true;43	while ( $p->next_token() && $tag !== $p->get_token_name() && $is_empty ) {44		if ( '#comment' !== $p->get_token_type() ) {45			/**46			 * Anything else implies this is not empty.47			 * This might include any text content (including a space),48			 * inline images or other HTML.49			 */50			$is_empty = false;51		}52	}53 54	/*55	 * When there's no text, render nothing for the block.56	 * See https://github.com/WordPress/gutenberg/issues/17221 for the57	 * reasoning behind this.58	 */59	if ( $is_empty ) {60		return '';61	}62 63	$width = $attributes['style']['dimensions']['width'] ?? null;64 65	if ( $width ) {66		// Resolve preset references to their actual values.67		$resolved_width = $width;68		$is_preset      = str_starts_with( $width, 'var:preset|dimension|' );69 70		if ( $is_preset ) {71			$slug              = substr( $width, strlen( 'var:preset|dimension|' ) );72			$dimension_presets = wp_get_global_settings(73				array( 'dimensions', 'dimensionSizes' ),74				array( 'block_name' => 'core/button' )75			);76 77			// Search origins in priority order: custom > theme > default.78			if ( is_array( $dimension_presets ) ) {79				foreach ( array( 'custom', 'theme', 'default' ) as $origin ) {80					if ( empty( $dimension_presets[ $origin ] ) || ! is_array( $dimension_presets[ $origin ] ) ) {81						continue;82					}83					foreach ( $dimension_presets[ $origin ] as $preset ) {84						if ( isset( $preset['slug'] ) && $preset['slug'] === $slug ) {85							$resolved_width = $preset['size'] ?? $width;86							break 2;87						}88					}89				}90			}91		}92 93		$is_percentage = str_ends_with( $resolved_width, '%' );94 95		$processor = new WP_HTML_Tag_Processor( $content );96		// Target the outer wrapper div.97		if ( $processor->next_tag( array( 'class_name' => 'wp-block-button' ) ) ) {

Changelog

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