bp_core_get_component_search_query_arg( string|null $component = null )

Get the ‘search’ query argument for a given component.

Description

Parameters

$component

(string|null) (Optional) Component name. Defaults to current component.

Default value: null

Return

(string|bool) Query argument on success. False on failure.

Source

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

function bp_core_get_component_search_query_arg( $component = null ) {
	if ( ! $component ) {
		$component = bp_current_component();
	}

	$query_arg = false;
	if ( isset( buddypress()->{$component}->search_query_arg ) ) {
		$query_arg = sanitize_title( buddypress()->{$component}->search_query_arg );
	}

	/**
	 * Filters the query arg for a component search string.
	 *
	 * @since BuddyPress 2.4.0
	 *
	 * @param string $query_arg Query argument.
	 * @param string $component Component name.
	 */
	return apply_filters( 'bp_core_get_component_search_query_arg', $query_arg, $component );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.4.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-functions.php: bp_core_get_component_search_query_arg	Filters the query arg for a component search string.

Used By
Used By	Description
bp-document/bp-document-template.php: bp_has_folders()	Initialize the folder loop.
bp-document/bp-document-template.php: bp_has_document()	Initialize the document loop.
bp-media/bp-media-template.php: bp_has_albums()	Initialize the album loop.
bp-media/bp-media-template.php: bp_has_media()	Initialize the media loop.
bp-blogs/bp-blogs-template.php: bp_directory_blogs_search_form()	Output the blog directory search form.
bp-blogs/bp-blogs-template.php: bp_has_blogs()	Initialize the blogs loop.
bp-groups/classes/class-bp-groups-template.php: BP_Groups_Template::__construct()	Constructor method.
bp-groups/bp-groups-template.php: bp_directory_groups_search_form()	Output group search form on group directory page.
bp-groups/bp-groups-template.php: bp_group_hidden_fields()	Output hidden form fields for group.
bp-groups/bp-groups-template.php: bp_group_has_members()	Initialize a group member query loop.
bp-groups/bp-groups-template.php: bp_has_groups()	Start the Groups Template Loop.
bp-members/classes/class-bp-core-members-template.php: BP_Core_Members_Template::__construct()	Constructor method.
bp-members/bp-members-template.php: bp_directory_members_search_form()	Output the Members directory search form.
bp-members/bp-members-template.php: bp_member_hidden_fields()	Output hidden input for preserving member search params on form submit.
bp-members/bp-members-template.php: bp_has_members()	Initialize the members loop.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_search_selector_name()	Output the name attribute of a selector.
bp-core/bp-core-template.php: bp_get_search_placeholder()	Get the placeholder text for the search box for a given component.
bp-core/profile-search/bps-search.php: bp_ps_set_request()	Set BuddyBoss Profile Search request.
bp-activity/bp-activity-template.php: bp_has_activities()	Initialize the activity loop.

Show 14 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