bp_search_form_type_select()
Generate the basic search form as used in BP-Default’s header.
Description Description
Return Return
(string) HTML <select> element.
Source Source
File: bp-core/bp-core-template.php
function bp_search_form_type_select() {
$options = array();
if ( bp_is_active( 'xprofile' ) ) {
$options['members'] = _x( 'Members', 'search form', 'buddypress' );
}
if ( bp_is_active( 'groups' ) ) {
$options['groups'] = _x( 'Groups', 'search form', 'buddypress' );
}
if ( bp_is_active( 'blogs' ) && is_multisite() ) {
$options['blogs'] = _x( 'Blogs', 'search form', 'buddypress' );
}
$options['posts'] = _x( 'Posts', 'search form', 'buddypress' );
// Eventually this won't be needed and a page will be built to integrate all search results.
$selection_box = '<label for="search-which" class="accessibly-hidden">' . _x( 'Search these:', 'search form', 'buddypress' ) . '</label>';
$selection_box .= '<select name="search-which" id="search-which" style="width: auto">';
/**
* Filters all of the component options available for search scope.
*
* @since 1.5.0
*
* @param array $options Array of options to add to select field.
*/
$options = apply_filters( 'bp_search_form_type_select_options', $options );
foreach( (array) $options as $option_value => $option_title ) {
$selection_box .= sprintf( '<option value="%s">%s</option>', $option_value, $option_title );
}
$selection_box .= '</select>';
/**
* Filters the complete <select> input used for search scope.
*
* @since 1.0.0
*
* @param string $selection_box <select> input for selecting search scope.
*/
return apply_filters( 'bp_search_form_type_select', $selection_box );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |