wp_get_canonical_url() WordPress Function

The wp_get_canonical_url() function is used to retrieve the canonical URL for a post or page. This is the URL that is used as the permanent link for a post or page.

wp_get_canonical_url( int|WP_Post $post = null ) #

Returns the canonical URL for a post.

Description
Parameters
Return
Source
Related
- Uses
- Used By
Changelog

Description

When the post is the same as the current requested page the function will handle the pagination arguments too.

Top ↑

Parameters

$post

(int|WP_Post)(Optional) Post ID or object. Default is global $post.

Default value: null

Top ↑

Return

(string|false) The canonical URL, or false if the post does not exist or has not been published yet.

Top ↑

Source

File: wp-includes/link-template.php

function wp_get_canonical_url( $post = null ) {
    $post = get_post( $post );
 
    if ( ! $post ) {
        return false;
    }
 
    if ( 'publish' !== $post->post_status ) {
        return false;
    }
 
    $canonical_url = get_permalink( $post );
 
    // If a canonical is being generated for the current page, make sure it has pagination if needed.
    if ( get_queried_object_id() === $post->ID ) {
        $page = get_query_var( 'page', 0 );
        if ( $page >= 2 ) {
            if ( ! get_option( 'permalink_structure' ) ) {
                $canonical_url = add_query_arg( 'page', $page, $canonical_url );
            } else {
                $canonical_url = trailingslashit( $canonical_url ) . user_trailingslashit( $page, 'single_paged' );
            }
        }
 
        $cpage = get_query_var( 'cpage', 0 );
        if ( $cpage ) {
            $canonical_url = get_comments_pagenum_link( $cpage );
        }
    }
 
    /**
     * Filters the canonical URL for a post.
     *
     * @since 4.6.0
     *
     * @param string  $canonical_url The post's canonical URL.
     * @param WP_Post $post          Post object.
     */
    return apply_filters( 'get_canonical_url', $canonical_url, $post );
}

Expand full source code Collapse full source codeView on TracView on GitHub

Top ↑

Uses

Uses
Uses	Description
wp-includes/link-template.php:get_canonical_url	Filters the canonical URL for a post.
wp-includes/formatting.php:trailingslashit()	Appends a trailing slash.
wp-includes/query.php:get_queried_object_id()	Retrieves the ID of the currently queried object.
wp-includes/query.php:get_query_var()	Retrieves the value of a query variable in the WP_Query class.
wp-includes/functions.php:add_query_arg()	Retrieves a modified URL query string.
wp-includes/link-template.php:get_comments_pagenum_link()	Retrieves the comments page number link.
wp-includes/link-template.php:get_permalink()	Retrieves the full permalink for the current post or post ID.
wp-includes/link-template.php:user_trailingslashit()	Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
wp-includes/plugin.php:apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/option.php:get_option()	Retrieves an option value based on an option name.
wp-includes/post.php:get_post()	Retrieves post data given a post ID or post object.