bp_get_canonical_url( array $args = array() )

Get the canonical URL of the current page.

Description

Parameters

$args

(Optional) Optional array of arguments.

'include_query_args'
(bool) Whether to include current URL arguments in the canonical URL returned from the function.

Default value: array()

Return

(string) Canonical URL for the current page.

Source

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

function bp_get_canonical_url( $args = array() ) {
 
    // For non-BP content, return the requested url, and let WP do the work.
    if ( bp_is_blog_page() ) {
        return bp_get_requested_url();
    }
 
    $bp = buddypress();
 
    $defaults = array(
        'include_query_args' => false // Include URL arguments, eg ?foo=bar&foo2=bar2.
    );
    $r = wp_parse_args( $args, $defaults );
    extract( $r );
 
    // Special case: when a BuddyPress directory (eg example.com/members)
    // is set to be the front page, ensure that the current canonical URL
    // is the home page URL.
    if ( 'page' == get_option( 'show_on_front' ) && $page_on_front = (int) get_option( 'page_on_front' ) ) {
        $front_page_component = array_search( $page_on_front, bp_core_get_directory_page_ids() );
 
        /*
         * If requesting the front page component directory, canonical
         * URL is the front page. We detect whether we're detecting a
         * component *directory* by checking that bp_current_action()
         * is empty - ie, this not a single item, a feed, or an item
         * type directory.
         */
        if ( false !== $front_page_component && bp_is_current_component( $front_page_component ) && ! bp_current_action() && ! bp_get_current_member_type() ) {
            $bp->canonical_stack['canonical_url'] = trailingslashit( bp_get_root_domain() );
 
        // Except when the front page is set to the registration page
        // and the current user is logged in. In this case we send to
        // the members directory to avoid redirect loops.
        } elseif ( bp_is_register_page() && 'register' == $front_page_component && is_user_logged_in() ) {
 
            /**
             * Filters the logged in register page redirect URL.
             *
             * @since BuddyPress 1.5.1
             *
             * @param string $value URL to redirect logged in members to.
             */
            $bp->canonical_stack['canonical_url'] = apply_filters( 'bp_loggedin_register_page_redirect_to', bp_get_members_directory_permalink() );
        }
    }
 
    if ( empty( $bp->canonical_stack['canonical_url'] ) ) {
        // Build the URL in the address bar.
        $requested_url  = bp_get_requested_url();
 
        // Stash query args.
        $url_stack      = explode( '?', $requested_url );
 
        // Build the canonical URL out of the redirect stack.
        if ( isset( $bp->canonical_stack['base_url'] ) )
            $url_stack[0] = $bp->canonical_stack['base_url'];
 
        if ( isset( $bp->canonical_stack['component'] ) )
            $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['component'] );
 
        if ( isset( $bp->canonical_stack['action'] ) )
            $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['action'] );
 
        if ( !empty( $bp->canonical_stack['action_variables'] ) ) {
            foreach( (array) $bp->canonical_stack['action_variables'] as $av ) {
                $url_stack[0] = trailingslashit( $url_stack[0] . $av );
            }
        }
 
        // Add trailing slash.
        $url_stack[0] = trailingslashit( $url_stack[0] );
 
        // Stash in the $bp global.
        $bp->canonical_stack['canonical_url'] = implode( '?', $url_stack );
    }
 
    $canonical_url = $bp->canonical_stack['canonical_url'];
 
    if ( !$include_query_args ) {
        $canonical_url = array_reverse( explode( '?', $canonical_url ) );
        $canonical_url = array_pop( $canonical_url );
    }
 
    /**
     * Filters the canonical url of the current page.
     *
     * @since BuddyPress 1.6.0
     *
     * @param string $canonical_url Canonical URL of the current page.
     * @param array  $args          Array of arguments to help determine canonical URL.
     */
    return apply_filters( 'bp_get_canonical_url', $canonical_url, $args );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.6.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-members/bp-members-functions.php: bp_get_current_member_type()	Get the “current” profile type, if one is provided, in member directories.
bp-members/bp-members-template.php: bp_get_members_directory_permalink()	Return member directory permalink.
bp-core/bp-core-template.php: bp_is_register_page()	Is the current page the Register page?
bp-core/bp-core-template.php: bp_is_blog_page()	Is this a blog page, ie a non-BP page?
bp-core/bp-core-template.php: bp_is_current_component()	Check to see whether the current page belongs to the specified component.
bp-core/bp-core-template.php: bp_get_root_domain()	Return the “root domain”, the URL of the BP root blog.
bp-core/bp-core-template.php: bp_current_action()	Return the name of the current action.
bp-core/bp-core-functions.php: bp_core_get_directory_page_ids()	Fetch a list of BP directory pages from the appropriate meta table.
bp-core/bp-core-catchuri.php: bp_get_requested_url()	Return the URL as requested on the current page load by the user agent.
bp-members/screens/register.php: bp_loggedin_register_page_redirect_to	Filters the URL to redirect logged in users to when visiting registration page.
bp-core/bp-core-catchuri.php: bp_get_canonical_url	Filters the canonical url of the current page.

Show 7 more uses Hide more uses

Used By
Used By	Description
bp-core/bp-core-catchuri.php: bp_rel_canonical()	Output rel=canonical header tag for BuddyPress content.
bp-core/bp-core-catchuri.php: bp_redirect_canonical()	Canonicalize BuddyPress URLs.

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