SearchControl components let users display a search control.

Check out the Storybook page for a visual exploration of this component.

Development guidelines


Render a user interface to input the name of an additional css class.

import { useState } from 'react';
import { __ } from '@wordpress/i18n';
import { SearchControl } from '@wordpress/components';

function MySearchControl( { className, setState } ) {
    const [ searchInput, setSearchInput ] = useState( '' );

    return (
            label={ __( 'Search posts' ) }
            value={ searchInput }
            onChange={ setSearchInput }


The set of props accepted by the component will be specified below.
Props not included in this set will be applied to the input element.


The accessible label for the input.

A label should always be provided as an accessibility best practice, even when a placeholder is defined
and hideLabelFromVision is true.

  • Type: String
  • Required: No
  • Default: __( 'Search' )


If this property is added, a specific placeholder will be used for the input.

  • Type: String
  • Required: No
  • Default: __( 'Search' )


The current value of the input.

  • Type: String
  • Required: No


The class that will be added to the classes of the wrapper div.

  • Type: String
  • Required: No


A function that receives the value of the input.

  • Type: function
  • Required: Yes


When an onClose callback is provided, the search control will render a close button that will trigger the given callback.

Use this if you want the button to trigger your own logic to close the search field entirely, rather than just clearing the input value.

  • Type: function
  • Required: No


If this property is added, a help text will be generated using help property as the content.

  • Type: String|Element
  • Required: No


If true, the label will not be visible, but will be read by screen readers. Defaults to true.

  • Type: Boolean
  • Required: No
  • Default: true


Start opting into the new margin-free styles that will become the default in a future version.

  • Type: Boolean
  • Required: No
  • Default: false

size: 'default' | 'compact'

The size of the component.

  • Required: No
  • Default: 'default'
  • To offer users more constrained options for input, use TextControl, SelectControl, RadioControl, CheckboxControl, or RangeControl.