Contents

Code Reference Functions bbp_is_favorites()

bbp_is_favorites()

Check if current page is a Forums user’s favorites page (profile page)

Description

Return

(bool) True if it's the favorites page, false if not

Source

File: bp-forums/common/template.php

571
572
573
574
575
576
577
578
579
580
581
582
function bbp_is_favorites() {
    global $wp_query;
 
    // Assume false
    $retval = false;
 
    // Check query
    if ( !empty( $wp_query->bbp_is_single_user_favs ) && ( true === $wp_query->bbp_is_single_user_favs ) )
        $retval = true;
 
    return (bool) apply_filters( 'bbp_is_favorites', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2652) Introduced.
Used By
Used By Description
bp-forums/core/template-loader.php: bbp_template_include_theme_supports()

Possibly intercept the template being loaded
bp-forums/topics/template.php: bbp_has_topics()

The main topic loop. WordPress makes this easy for us
bp-forums/users/template.php: bbp_get_user_favorites_link()

User favorites link
bp-forums/users/functions.php: bbp_favorites_handler()

Handles the front end adding and removing of favorite topics
bp-forums/forums/functions.php: bbp_exclude_forum_ids()

Returns a meta_query that either includes or excludes hidden forum IDs from a query.
bp-forums/common/template.php: bbp_title()

Custom page title for Forums pages
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 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.