Question

wp_get_canonical_url( int|WP_Post $post = null )

Returns the canonical URL for a post.

---

description

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

---

参数

$post

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

Default value: null

---

返回值

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

---

源代码

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 ( $post->ID === get_queried_object_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 );
}

---

更新日志

Version	description
4.6.0	Introduced.

---

相关函数

Uses

• wp-includes/link-template.php: get_canonical_url
• wp-includes/formatting.php: trailingslashit()
• wp-includes/query.php: get_queried_object_id()
• wp-includes/query.php: get_query_var()
• wp-includes/functions.php: add_query_arg()
• wp-includes/link-template.php: get_comments_pagenum_link()
• wp-includes/link-template.php: get_permalink()
• wp-includes/link-template.php: user_trailingslashit()
• wp-includes/plugin.php: apply_filters()
• wp-includes/option.php: get_option()
• wp-includes/post.php: get_post()
Show 6 more uses Hide more uses

---

Used By

• wp-includes/link-template.php: rel_canonical()

---

User Contributed Notes