bp_get_search_default_text( string $component = '' )

Return the default text for the search box for a given component.

Description

Parameters

$component

(Optional) Component name. Default: current component.

Default value: ''

Return

(string) Placeholder text for search field.

Source

File: bp-core/bp-core-template.php

function bp_get_search_default_text( $component = '' ) {
 
    $bp = buddypress();
 
    if ( empty( $component ) ) {
        $component = bp_current_component();
    }
 
    $default_text = __( 'Search anything&hellip;', 'buddyboss' );
 
    // Most of the time, $component will be the actual component ID.
    if ( !empty( $component ) ) {
        if ( !empty( $bp->{$component}->search_string ) ) {
            $default_text = $bp->{$component}->search_string;
        } else {
            // When the request comes through AJAX, we need to get the component
            // name out of $bp->pages.
            if ( !empty( $bp->pages->{$component}->slug ) ) {
                $key = $bp->pages->{$component}->slug;
                if ( !empty( $bp->{$key}->search_string ) ) {
                    $default_text = $bp->{$key}->search_string;
                }
            }
        }
    }
 
    /**
     * Filters the default text for the search box for a given component.
     *
     * @since BuddyPress 1.5.0
     *
     * @param string $default_text Default text for search box.
     * @param string $component    Current component displayed.
     */
    return apply_filters( 'bp_get_search_default_text', $default_text, $component );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-template.php: bp_current_component()	Return the name of the current component.
bp-core/bp-core-template.php: bp_get_search_default_text	Filters the default text for the search box for a given component.

Used By
Used By	Description
bp-blogs/bp-blogs-template.php: bp_directory_blogs_search_form()	Output the blog directory search form.
bp-messages/bp-messages-template.php: bp_message_search_form()	Output the Private Message search form.
bp-groups/bp-groups-template.php: bp_directory_groups_search_form()	Output group search form on group directory page.
bp-members/bp-members-template.php: bp_directory_members_search_form()	Output the Members directory search form.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_search_default_text()	Output the default search text for the search object
bp-templates/bp-nouveau/includes/functions.php: bp_nouveau_ajax_querystring()	This function looks scarier than it actually is. Each object loop (activity/members/groups/blogs/forums) contains default parameters to show specific information based on the page we are currently looking at.
bp-core/bp-core-template.php: bp_get_search_placeholder()	Get the placeholder text for the search box for a given component.
bp-core/bp-core-template.php: bp_search_default_text()	Output the default text for the search box for a given component.

Show 3 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents