123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547 |
- <?php
- /**
- * Server-side rendering of the `core/search` block.
- *
- * @package WordPress
- */
- /**
- * Dynamically renders the `core/search` block.
- *
- * @param array $attributes The block attributes.
- *
- * @return string The search block markup.
- */
- function render_block_core_search( $attributes ) {
- // Older versions of the Search block defaulted the label and buttonText
- // attributes to `__( 'Search' )` meaning that many posts contain `<!--
- // wp:search /-->`. Support these by defaulting an undefined label and
- // buttonText to `__( 'Search' )`.
- $attributes = wp_parse_args(
- $attributes,
- array(
- 'label' => __( 'Search' ),
- 'buttonText' => __( 'Search' ),
- )
- );
- $input_id = wp_unique_id( 'wp-block-search__input-' );
- $classnames = classnames_for_block_core_search( $attributes );
- $show_label = ( ! empty( $attributes['showLabel'] ) ) ? true : false;
- $use_icon_button = ( ! empty( $attributes['buttonUseIcon'] ) ) ? true : false;
- $show_input = ( ! empty( $attributes['buttonPosition'] ) && 'button-only' === $attributes['buttonPosition'] ) ? false : true;
- $show_button = ( ! empty( $attributes['buttonPosition'] ) && 'no-button' === $attributes['buttonPosition'] ) ? false : true;
- $query_params = ( ! empty( $attributes['query'] ) ) ? $attributes['query'] : array();
- $input_markup = '';
- $button_markup = '';
- $query_params_markup = '';
- $inline_styles = styles_for_block_core_search( $attributes );
- $color_classes = get_color_classes_for_block_core_search( $attributes );
- $typography_classes = get_typography_classes_for_block_core_search( $attributes );
- $is_button_inside = ! empty( $attributes['buttonPosition'] ) &&
- 'button-inside' === $attributes['buttonPosition'];
- // Border color classes need to be applied to the elements that have a border color.
- $border_color_classes = get_border_color_classes_for_block_core_search( $attributes );
- $label_inner_html = empty( $attributes['label'] ) ? __( 'Search' ) : wp_kses_post( $attributes['label'] );
- $label_markup = sprintf(
- '<label for="%1$s" class="wp-block-search__label screen-reader-text">%2$s</label>',
- esc_attr( $input_id ),
- $label_inner_html
- );
- if ( $show_label && ! empty( $attributes['label'] ) ) {
- $label_classes = array( 'wp-block-search__label' );
- if ( ! empty( $typography_classes ) ) {
- $label_classes[] = $typography_classes;
- }
- $label_markup = sprintf(
- '<label for="%1$s" class="%2$s" %3$s>%4$s</label>',
- esc_attr( $input_id ),
- esc_attr( implode( ' ', $label_classes ) ),
- $inline_styles['label'],
- $label_inner_html
- );
- }
- if ( $show_input ) {
- $input_classes = array( 'wp-block-search__input' );
- if ( $is_button_inside ) {
- $input_classes[] = $border_color_classes;
- }
- if ( ! empty( $typography_classes ) ) {
- $input_classes[] = $typography_classes;
- }
- $input_markup = sprintf(
- '<input type="search" id="%s" class="wp-block-search__input %s" name="s" value="%s" placeholder="%s" %s required />',
- $input_id,
- esc_attr( implode( ' ', $input_classes ) ),
- get_search_query(),
- esc_attr( $attributes['placeholder'] ),
- $inline_styles['input']
- );
- }
- if ( count( $query_params ) > 0 ) {
- foreach ( $query_params as $param => $value ) {
- $query_params_markup .= sprintf(
- '<input type="hidden" name="%s" value="%s" />',
- esc_attr( $param ),
- esc_attr( $value )
- );
- }
- }
- if ( $show_button ) {
- $button_classes = array( 'wp-block-search__button' );
- $button_internal_markup = '';
- if ( ! empty( $color_classes ) ) {
- $button_classes[] = $color_classes;
- }
- if ( ! empty( $typography_classes ) ) {
- $button_classes[] = $typography_classes;
- }
- $aria_label = '';
- if ( ! $is_button_inside && ! empty( $border_color_classes ) ) {
- $button_classes[] = $border_color_classes;
- }
- if ( ! $use_icon_button ) {
- if ( ! empty( $attributes['buttonText'] ) ) {
- $button_internal_markup = wp_kses_post( $attributes['buttonText'] );
- }
- } else {
- $aria_label = sprintf( 'aria-label="%s"', esc_attr( wp_strip_all_tags( $attributes['buttonText'] ) ) );
- $button_classes[] = 'has-icon';
- $button_internal_markup =
- '<svg class="search-icon" viewBox="0 0 24 24" width="24" height="24">
- <path d="M13.5 6C10.5 6 8 8.5 8 11.5c0 1.1.3 2.1.9 3l-3.4 3 1 1.1 3.4-2.9c1 .9 2.2 1.4 3.6 1.4 3 0 5.5-2.5 5.5-5.5C19 8.5 16.5 6 13.5 6zm0 9.5c-2.2 0-4-1.8-4-4s1.8-4 4-4 4 1.8 4 4-1.8 4-4 4z"></path>
- </svg>';
- }
- // Include the button element class.
- $button_classes[] = wp_theme_get_element_class_name( 'button' );
- $button_markup = sprintf(
- '<button type="submit" class="%s" %s %s>%s</button>',
- esc_attr( implode( ' ', $button_classes ) ),
- $inline_styles['button'],
- $aria_label,
- $button_internal_markup
- );
- }
- $field_markup_classes = $is_button_inside ? $border_color_classes : '';
- $field_markup = sprintf(
- '<div class="wp-block-search__inside-wrapper %s" %s>%s</div>',
- esc_attr( $field_markup_classes ),
- $inline_styles['wrapper'],
- $input_markup . $query_params_markup . $button_markup
- );
- $wrapper_attributes = get_block_wrapper_attributes(
- array( 'class' => $classnames )
- );
- return sprintf(
- '<form role="search" method="get" action="%s" %s>%s</form>',
- esc_url( home_url( '/' ) ),
- $wrapper_attributes,
- $label_markup . $field_markup
- );
- }
- /**
- * Registers the `core/search` block on the server.
- */
- function register_block_core_search() {
- register_block_type_from_metadata(
- __DIR__ . '/search',
- array(
- 'render_callback' => 'render_block_core_search',
- )
- );
- }
- add_action( 'init', 'register_block_core_search' );
- /**
- * Builds the correct top level classnames for the 'core/search' block.
- *
- * @param array $attributes The block attributes.
- *
- * @return string The classnames used in the block.
- */
- function classnames_for_block_core_search( $attributes ) {
- $classnames = array();
- if ( ! empty( $attributes['buttonPosition'] ) ) {
- if ( 'button-inside' === $attributes['buttonPosition'] ) {
- $classnames[] = 'wp-block-search__button-inside';
- }
- if ( 'button-outside' === $attributes['buttonPosition'] ) {
- $classnames[] = 'wp-block-search__button-outside';
- }
- if ( 'no-button' === $attributes['buttonPosition'] ) {
- $classnames[] = 'wp-block-search__no-button';
- }
- if ( 'button-only' === $attributes['buttonPosition'] ) {
- $classnames[] = 'wp-block-search__button-only';
- }
- }
- if ( isset( $attributes['buttonUseIcon'] ) ) {
- if ( ! empty( $attributes['buttonPosition'] ) && 'no-button' !== $attributes['buttonPosition'] ) {
- if ( $attributes['buttonUseIcon'] ) {
- $classnames[] = 'wp-block-search__icon-button';
- } else {
- $classnames[] = 'wp-block-search__text-button';
- }
- }
- }
- return implode( ' ', $classnames );
- }
- /**
- * This generates a CSS rule for the given border property and side if provided.
- * Based on whether the Search block is configured to display the button inside
- * or not, the generated rule is injected into the appropriate collection of
- * styles for later application in the block's markup.
- *
- * @param array $attributes The block attributes.
- * @param string $property Border property to generate rule for e.g. width or color.
- * @param string $side Optional side border. The dictates the value retrieved and final CSS property.
- * @param array $wrapper_styles Current collection of wrapper styles.
- * @param array $button_styles Current collection of button styles.
- * @param array $input_styles Current collection of input styles.
- *
- * @return void
- */
- function apply_block_core_search_border_style( $attributes, $property, $side, &$wrapper_styles, &$button_styles, &$input_styles ) {
- $is_button_inside = 'button-inside' === _wp_array_get( $attributes, array( 'buttonPosition' ), false );
- $path = array( 'style', 'border', $property );
- if ( $side ) {
- array_splice( $path, 2, 0, $side );
- }
- $value = _wp_array_get( $attributes, $path, false );
- if ( empty( $value ) ) {
- return;
- }
- if ( 'color' === $property && $side ) {
- $has_color_preset = str_contains( $value, 'var:preset|color|' );
- if ( $has_color_preset ) {
- $named_color_value = substr( $value, strrpos( $value, '|' ) + 1 );
- $value = sprintf( 'var(--wp--preset--color--%s)', $named_color_value );
- }
- }
- $property_suffix = $side ? sprintf( '%s-%s', $side, $property ) : $property;
- if ( $is_button_inside ) {
- $wrapper_styles[] = sprintf( 'border-%s: %s;', $property_suffix, esc_attr( $value ) );
- } else {
- $button_styles[] = sprintf( 'border-%s: %s;', $property_suffix, esc_attr( $value ) );
- $input_styles[] = sprintf( 'border-%s: %s;', $property_suffix, esc_attr( $value ) );
- }
- }
- /**
- * This adds CSS rules for a given border property e.g. width or color. It
- * injects rules into the provided wrapper, button and input style arrays for
- * uniform "flat" borders or those with individual sides configured.
- *
- * @param array $attributes The block attributes.
- * @param string $property Border property to generate rule for e.g. width or color.
- * @param array $wrapper_styles Current collection of wrapper styles.
- * @param array $button_styles Current collection of button styles.
- * @param array $input_styles Current collection of input styles.
- *
- * @return void
- */
- function apply_block_core_search_border_styles( $attributes, $property, &$wrapper_styles, &$button_styles, &$input_styles ) {
- apply_block_core_search_border_style( $attributes, $property, null, $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_style( $attributes, $property, 'top', $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_style( $attributes, $property, 'right', $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_style( $attributes, $property, 'bottom', $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_style( $attributes, $property, 'left', $wrapper_styles, $button_styles, $input_styles );
- }
- /**
- * Builds an array of inline styles for the search block.
- *
- * The result will contain one entry for shared styles such as those for the
- * inner input or button and a second for the inner wrapper should the block
- * be positioning the button "inside".
- *
- * @param array $attributes The block attributes.
- *
- * @return array Style HTML attribute.
- */
- function styles_for_block_core_search( $attributes ) {
- $wrapper_styles = array();
- $button_styles = array();
- $input_styles = array();
- $label_styles = array();
- $is_button_inside = ! empty( $attributes['buttonPosition'] ) &&
- 'button-inside' === $attributes['buttonPosition'];
- $show_label = ( isset( $attributes['showLabel'] ) ) && false !== $attributes['showLabel'];
- // Add width styles.
- $has_width = ! empty( $attributes['width'] ) && ! empty( $attributes['widthUnit'] );
- $button_only = ! empty( $attributes['buttonPosition'] ) && 'button-only' === $attributes['buttonPosition'];
- if ( $has_width && ! $button_only ) {
- $wrapper_styles[] = sprintf(
- 'width: %d%s;',
- esc_attr( $attributes['width'] ),
- esc_attr( $attributes['widthUnit'] )
- );
- }
- // Add border width and color styles.
- apply_block_core_search_border_styles( $attributes, 'width', $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_styles( $attributes, 'color', $wrapper_styles, $button_styles, $input_styles );
- apply_block_core_search_border_styles( $attributes, 'style', $wrapper_styles, $button_styles, $input_styles );
- // Add border radius styles.
- $has_border_radius = ! empty( $attributes['style']['border']['radius'] );
- if ( $has_border_radius ) {
- $default_padding = '4px';
- $border_radius = $attributes['style']['border']['radius'];
- if ( is_array( $border_radius ) ) {
- // Apply styles for individual corner border radii.
- foreach ( $border_radius as $key => $value ) {
- if ( null !== $value ) {
- // Convert camelCase key to kebab-case.
- $name = strtolower( preg_replace( '/(?<!^)[A-Z]/', '-$0', $key ) );
- // Add shared styles for individual border radii for input & button.
- $border_style = sprintf(
- 'border-%s-radius: %s;',
- esc_attr( $name ),
- esc_attr( $value )
- );
- $input_styles[] = $border_style;
- $button_styles[] = $border_style;
- // Add adjusted border radius styles for the wrapper element
- // if button is positioned inside.
- if ( $is_button_inside && intval( $value ) !== 0 ) {
- $wrapper_styles[] = sprintf(
- 'border-%s-radius: calc(%s + %s);',
- esc_attr( $name ),
- esc_attr( $value ),
- $default_padding
- );
- }
- }
- }
- } else {
- // Numeric check is for backwards compatibility purposes.
- $border_radius = is_numeric( $border_radius ) ? $border_radius . 'px' : $border_radius;
- $border_style = sprintf( 'border-radius: %s;', esc_attr( $border_radius ) );
- $input_styles[] = $border_style;
- $button_styles[] = $border_style;
- if ( $is_button_inside && intval( $border_radius ) !== 0 ) {
- // Adjust wrapper border radii to maintain visual consistency
- // with inner elements when button is positioned inside.
- $wrapper_styles[] = sprintf(
- 'border-radius: calc(%s + %s);',
- esc_attr( $border_radius ),
- $default_padding
- );
- }
- }
- }
- // Add color styles.
- $has_text_color = ! empty( $attributes['style']['color']['text'] );
- if ( $has_text_color ) {
- $button_styles[] = sprintf( 'color: %s;', $attributes['style']['color']['text'] );
- }
- $has_background_color = ! empty( $attributes['style']['color']['background'] );
- if ( $has_background_color ) {
- $button_styles[] = sprintf( 'background-color: %s;', $attributes['style']['color']['background'] );
- }
- $has_custom_gradient = ! empty( $attributes['style']['color']['gradient'] );
- if ( $has_custom_gradient ) {
- $button_styles[] = sprintf( 'background: %s;', $attributes['style']['color']['gradient'] );
- }
- // Get typography styles to be shared across inner elements.
- $typography_styles = esc_attr( get_typography_styles_for_block_core_search( $attributes ) );
- if ( ! empty( $typography_styles ) ) {
- $label_styles [] = $typography_styles;
- $button_styles[] = $typography_styles;
- $input_styles [] = $typography_styles;
- }
- // Typography text-decoration is only applied to the label and button.
- if ( ! empty( $attributes['style']['typography']['textDecoration'] ) ) {
- $text_decoration_value = sprintf( 'text-decoration: %s;', esc_attr( $attributes['style']['typography']['textDecoration'] ) );
- $button_styles[] = $text_decoration_value;
- // Input opts out of text decoration.
- if ( $show_label ) {
- $label_styles[] = $text_decoration_value;
- }
- }
- return array(
- 'input' => ! empty( $input_styles ) ? sprintf( ' style="%s"', esc_attr( safecss_filter_attr( implode( ' ', $input_styles ) ) ) ) : '',
- 'button' => ! empty( $button_styles ) ? sprintf( ' style="%s"', esc_attr( safecss_filter_attr( implode( ' ', $button_styles ) ) ) ) : '',
- 'wrapper' => ! empty( $wrapper_styles ) ? sprintf( ' style="%s"', esc_attr( safecss_filter_attr( implode( ' ', $wrapper_styles ) ) ) ) : '',
- 'label' => ! empty( $label_styles ) ? sprintf( ' style="%s"', esc_attr( safecss_filter_attr( implode( ' ', $label_styles ) ) ) ) : '',
- );
- }
- /**
- * Returns typography classnames depending on whether there are named font sizes/families .
- *
- * @param array $attributes The block attributes.
- *
- * @return string The typography color classnames to be applied to the block elements.
- */
- function get_typography_classes_for_block_core_search( $attributes ) {
- $typography_classes = array();
- $has_named_font_family = ! empty( $attributes['fontFamily'] );
- $has_named_font_size = ! empty( $attributes['fontSize'] );
- if ( $has_named_font_size ) {
- $typography_classes[] = sprintf( 'has-%s-font-size', esc_attr( $attributes['fontSize'] ) );
- }
- if ( $has_named_font_family ) {
- $typography_classes[] = sprintf( 'has-%s-font-family', esc_attr( $attributes['fontFamily'] ) );
- }
- return implode( ' ', $typography_classes );
- }
- /**
- * Returns typography styles to be included in an HTML style tag.
- * This excludes text-decoration, which is applied only to the label and button elements of the search block.
- *
- * @param array $attributes The block attributes.
- *
- * @return string A string of typography CSS declarations.
- */
- function get_typography_styles_for_block_core_search( $attributes ) {
- $typography_styles = array();
- // Add typography styles.
- if ( ! empty( $attributes['style']['typography']['fontSize'] ) ) {
- $typography_styles[] = sprintf(
- 'font-size: %s;',
- wp_get_typography_font_size_value(
- array(
- 'size' => $attributes['style']['typography']['fontSize'],
- )
- )
- );
- }
- if ( ! empty( $attributes['style']['typography']['fontFamily'] ) ) {
- $typography_styles[] = sprintf( 'font-family: %s;', $attributes['style']['typography']['fontFamily'] );
- }
- if ( ! empty( $attributes['style']['typography']['letterSpacing'] ) ) {
- $typography_styles[] = sprintf( 'letter-spacing: %s;', $attributes['style']['typography']['letterSpacing'] );
- }
- if ( ! empty( $attributes['style']['typography']['fontWeight'] ) ) {
- $typography_styles[] = sprintf( 'font-weight: %s;', $attributes['style']['typography']['fontWeight'] );
- }
- if ( ! empty( $attributes['style']['typography']['fontStyle'] ) ) {
- $typography_styles[] = sprintf( 'font-style: %s;', $attributes['style']['typography']['fontStyle'] );
- }
- if ( ! empty( $attributes['style']['typography']['lineHeight'] ) ) {
- $typography_styles[] = sprintf( 'line-height: %s;', $attributes['style']['typography']['lineHeight'] );
- }
- if ( ! empty( $attributes['style']['typography']['textTransform'] ) ) {
- $typography_styles[] = sprintf( 'text-transform: %s;', $attributes['style']['typography']['textTransform'] );
- }
- return implode( '', $typography_styles );
- }
- /**
- * Returns border color classnames depending on whether there are named or custom border colors.
- *
- * @param array $attributes The block attributes.
- *
- * @return string The border color classnames to be applied to the block elements.
- */
- function get_border_color_classes_for_block_core_search( $attributes ) {
- $border_color_classes = array();
- $has_custom_border_color = ! empty( $attributes['style']['border']['color'] );
- $has_named_border_color = ! empty( $attributes['borderColor'] );
- if ( $has_custom_border_color || $has_named_border_color ) {
- $border_color_classes[] = 'has-border-color';
- }
- if ( $has_named_border_color ) {
- $border_color_classes[] = sprintf( 'has-%s-border-color', esc_attr( $attributes['borderColor'] ) );
- }
- return implode( ' ', $border_color_classes );
- }
- /**
- * Returns color classnames depending on whether there are named or custom text and background colors.
- *
- * @param array $attributes The block attributes.
- *
- * @return string The color classnames to be applied to the block elements.
- */
- function get_color_classes_for_block_core_search( $attributes ) {
- $classnames = array();
- // Text color.
- $has_named_text_color = ! empty( $attributes['textColor'] );
- $has_custom_text_color = ! empty( $attributes['style']['color']['text'] );
- if ( $has_named_text_color ) {
- $classnames[] = sprintf( 'has-text-color has-%s-color', $attributes['textColor'] );
- } elseif ( $has_custom_text_color ) {
- // If a custom 'textColor' was selected instead of a preset, still add the generic `has-text-color` class.
- $classnames[] = 'has-text-color';
- }
- // Background color.
- $has_named_background_color = ! empty( $attributes['backgroundColor'] );
- $has_custom_background_color = ! empty( $attributes['style']['color']['background'] );
- $has_named_gradient = ! empty( $attributes['gradient'] );
- $has_custom_gradient = ! empty( $attributes['style']['color']['gradient'] );
- if (
- $has_named_background_color ||
- $has_custom_background_color ||
- $has_named_gradient ||
- $has_custom_gradient
- ) {
- $classnames[] = 'has-background';
- }
- if ( $has_named_background_color ) {
- $classnames[] = sprintf( 'has-%s-background-color', $attributes['backgroundColor'] );
- }
- if ( $has_named_gradient ) {
- $classnames[] = sprintf( 'has-%s-gradient-background', $attributes['gradient'] );
- }
- return implode( ' ', $classnames );
- }
|