bbp_is_search()

Check if current page is a search page

Description

Return

(bool) Is it a search page?

Source

function bbp_is_search() {
    global $wp_query;
 
    // Bail if search is disabled
    if ( ! bbp_allow_search() )
        return false;
 
    // Assume false
    $retval = false;
 
    // Check query
    if ( !empty( $wp_query->bbp_is_search ) && ( true === $wp_query->bbp_is_search ) )
        $retval = true;
 
    // Check query name
    if ( empty( $retval ) && bbp_is_query_name( bbp_get_search_rewrite_id() ) )
        $retval = true;
 
    // Check $_GET
    if ( empty( $retval ) && isset( $_REQUEST[ bbp_get_search_rewrite_id() ] ) && empty( $_REQUEST[ bbp_get_search_rewrite_id() ] ) )
        $retval = true;
 
    return (bool) apply_filters( 'bbp_is_search', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r4579)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/functions.php: bbp_get_search_rewrite_id()	Return the unique ID for all search rewrite rules
bp-forums/core/options.php: bbp_allow_search()	Is forum-wide searching allowed
bp-forums/common/template.php: bbp_is_query_name()	Check the passed parameter against the current _bbp_query_name

Used By
Used By	Description
bp-forums/core/theme-compat.php: bbp_template_include_theme_compat()	Reset main query vars and filter ‘the_content’ to output a Forums template part as needed.
bp-forums/core/template-loader.php: bbp_template_include_theme_supports()	Possibly intercept the template being loaded
bp-forums/common/template.php: bbp_title()	Custom page title for Forums pages
bp-forums/common/template.php: bbp_get_breadcrumb()	Return a breadcrumb ( forum -> topic -> reply )
bp-forums/common/template.php: is_bbpress()	Use the above is_() functions to return if in any Forums page
bp-forums/common/template.php: bbp_body_class()	Use the above is_() functions to output a body class for each scenario

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