render_block_core_search( array $attributes ): string

Parameters

$attributesarray

The block attributes.

Return

string

The search block markup.

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

View on Trac ↗View on GitHub ↗

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

History

Introduced in 6.3.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 6.9.7 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.