render_block_core_search( array $attributes ): 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

The block attributes.

Return value

string

The search block markup.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

142–290

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

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_search()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block_core_search() 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 · 19

• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• wp_unique_id()Gets unique ID.
• classnames_for_block_core_search()Builds the correct top level classnames for the 'core/search' block.
• styles_for_block_core_search()Builds an array of inline styles for the search block.
• get_color_classes_for_block_core_search()Returns color classnames depending on whether there are named or custom text and background colors.
• get_typography_classes_for_block_core_search()Returns typography classnames depending on whether there are named font sizes/families.
• get_border_color_classes_for_block_core_search()Returns border color classnames depending on whether there are named or custom border colors.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• get_search_query()Retrieves the contents of the search WordPress query variable.
• wp_enqueue_script_module()Marks the script module to be enqueued in the page.
• esc_attr()Escaping for HTML attributes.

Source code

View on Trac ↗View on GitHub ↗

19function render_block_core_search( $attributes ) {20	// Older versions of the Search block defaulted the label and buttonText21	// attributes to `__( 'Search' )` meaning that many posts contain `<!--22	// wp:search /-->`. Support these by defaulting an undefined label and23	// buttonText to `__( 'Search' )`.24	$attributes = wp_parse_args(25		$attributes,26		array(27			'label'      => __( 'Search' ),28			'buttonText' => __( 'Search' ),29		)30	);31 32	$input_id            = wp_unique_id( 'wp-block-search__input-' );33	$classnames          = classnames_for_block_core_search( $attributes );34	$show_label          = ( ! empty( $attributes['showLabel'] ) ) ? true : false;35	$use_icon_button     = ( ! empty( $attributes['buttonUseIcon'] ) ) ? true : false;36	$show_button         = ( ! empty( $attributes['buttonPosition'] ) && 'no-button' === $attributes['buttonPosition'] ) ? false : true;37	$button_position     = $show_button ? $attributes['buttonPosition'] : null;38	$query_params        = ( ! empty( $attributes['query'] ) ) ? $attributes['query'] : array();39	$button              = '';40	$query_params_markup = '';41	$inline_styles       = styles_for_block_core_search( $attributes );42	$color_classes       = get_color_classes_for_block_core_search( $attributes );43	$typography_classes  = get_typography_classes_for_block_core_search( $attributes );44	$is_button_inside    = ! empty( $attributes['buttonPosition'] ) &&45		'button-inside' === $attributes['buttonPosition'];46	// Border color classes need to be applied to the elements that have a border color.47	$border_color_classes = get_border_color_classes_for_block_core_search( $attributes );48	// This variable is a constant and its value is always false at this moment.49	// It is defined this way because some values depend on it, in case it changes in the future.50	$open_by_default = false;51 52	$label_inner_html = empty( $attributes['label'] ) ? __( 'Search' ) : wp_kses_post( $attributes['label'] );53	$label            = new WP_HTML_Tag_Processor( sprintf( '<label %1$s>%2$s</label>', $inline_styles['label'], $label_inner_html ) );54	if ( $label->next_tag() ) {55		$label->set_attribute( 'for', $input_id );56		$label->add_class( 'wp-block-search__label' );57		if ( $show_label && ! empty( $attributes['label'] ) ) {58			if ( ! empty( $typography_classes ) ) {59				$label->add_class( $typography_classes );60			}61		} else {62			$label->add_class( 'screen-reader-text' );63		}64	}65 66	$input         = new WP_HTML_Tag_Processor( sprintf( '<input type="search" name="s" required %s/>', $inline_styles['input'] ) );67	$input_classes = array( 'wp-block-search__input' );68	if ( ! $is_button_inside && ! empty( $border_color_classes ) ) {69		$input_classes[] = $border_color_classes;70	}71	if ( ! empty( $typography_classes ) ) {72		$input_classes[] = $typography_classes;73	}74	if ( $input->next_tag() ) {75		$input->add_class( implode( ' ', $input_classes ) );76		$input->set_attribute( 'id', $input_id );77		$input->set_attribute( 'value', get_search_query() );78		$input->set_attribute( 'placeholder', $attributes['placeholder'] );79 80		// If it's interactive, enqueue the script module and add the directives.81		$is_expandable_searchfield = 'button-only' === $button_position;82		if ( $is_expandable_searchfield ) {83			wp_enqueue_script_module( '@wordpress/block-library/search/view' );84 85			$input->set_attribute( 'data-wp-bind--aria-hidden', '!context.isSearchInputVisible' );86			$input->set_attribute( 'data-wp-bind--tabindex', 'state.tabindex' );87 88			// Adding these attributes manually is needed until the Interactivity API89			// SSR logic is added to core.90			$input->set_attribute( 'aria-hidden', 'true' );91			$input->set_attribute( 'tabindex', '-1' );92		}93	}94 95	if ( count( $query_params ) > 0 ) {96		foreach ( $query_params as $param => $value ) {97			$query_params_markup .= sprintf(98				'<input type="hidden" name="%s" value="%s" />',

Changelog

Introduced in 6.3.0. Unchanged from 6.7.10 through 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.7.10 tag, from src/wp-includes/blocks/search.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.