bbp_get_search_terms( string $passed_terms = '' )

Get the search terms

Description

Parameters

$passed_terms

(Optional) Search terms

Default value: ''

Return

(bool|string) Search terms on success, false on failure

Source

File: bp-forums/search/template.php

function bbp_get_search_terms( $passed_terms = '' ) {
 
    // Sanitize terms if they were passed in
    if ( !empty( $passed_terms ) ) {
        $search_terms = sanitize_title( $passed_terms );
 
    // Use query variable if not
    } else {
        $search_terms = get_query_var( bbp_get_search_rewrite_id() );
    }
 
    // Trim whitespace and decode, or set explicitly to false if empty
    $search_terms = !empty( $search_terms ) ? urldecode( trim( $search_terms ) ) : false;
 
    return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r4579) If search terms are supplied, those are used. Otherwise check the search rewrite id query var.	Introduced.

Uses

Uses
Uses	Description
bp-forums/search/functions.php: bbp_get_search_type_ids()	Return an array of search types
bp-forums/search/functions.php: bbp_sanitize_search_request()	Sanitize a query argument used to pass some search terms.
bp-forums/core/functions.php: bbp_get_search_rewrite_id()	Return the unique ID for all search rewrite rules

Used By
Used By	Description
bp-forums/core/template-functions.php: bbp_parse_query()	Add checks for Forums conditions to parse_query action
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_search()	Display the contents of search results in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/common/template.php: bbp_get_breadcrumb()	Return a breadcrumb ( forum -> topic -> reply )
bp-forums/search/functions.php: bbp_get_search_query_args()	Return the search’s query args
bp-forums/search/template.php: bbp_has_search_results()	The main search loop. WordPress does the heavy lifting.
bp-forums/search/template.php: bbp_get_search_title()	Get the search page title
bp-forums/search/template.php: bbp_get_search_results_url()	Return the search url
bp-forums/search/template.php: bbp_search_terms()	Output the search terms

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