bp_get_search_placeholder( string $component = '' )

Get the placeholder text for the search box for a given component.

Description

Parameters

$component

(Optional) Component name. Defaults to current component.

Default value: ''

Return

(string) Placeholder text for the search field.

Source

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

function bp_get_search_placeholder( $component = '' ) {
	$query_arg = bp_core_get_component_search_query_arg( $component );

	if ( $query_arg && ! empty( $_REQUEST[ $query_arg ] ) ) {
		$placeholder = wp_unslash( $_REQUEST[ $query_arg ] );
	} else {
		$placeholder = bp_get_search_default_text( $component );
	}

	return $placeholder;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.7.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-template.php: bp_get_search_default_text()	Return the default text for the search box for a given component.
bp-core/bp-core-functions.php: bp_core_get_component_search_query_arg()	Get the ‘search’ query argument for a given component.

Used By
Used By	Description
bp-core/bp-core-template.php: bp_search_placeholder()	Output the placeholder text for the search box for a given component.

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