Posts, Post Types: Correct the check for non-existing post in get_post_permalink().

The function was erroneously calling `is_wp_error()` on the result of a `get_post()` call, which returns `null` on failure, and never returns a `WP_Error` object.

Previously, passing a non-existing post ID to the function would result in a home URL being returned and a few `Attempt to read property "post_type, post_name, hierarchical..." on null` PHP warnings.

This commit ensures `get_post_permalink()` returns `false` on failure, which brings parity with `get_permalink()`.

Includes a unit test to confirm the correct behavior.

Follow-up to [12923], [13023], [32606].

Props renegeuze, manzoorwani.jk.
Fixes #45329.

git-svn-id: https://develop.svn.wordpress.org/trunk@53733 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2022-07-20 15:39:18 +00:00
parent 57f4d6c7b2
commit b698f8f475
2 changed files with 25 additions and 7 deletions

View File

@@ -152,7 +152,7 @@ function wp_force_plain_post_permalink( $post = null, $sample = null ) {
*
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
* @return string|false The permalink URL or false if post does not exist.
* @return string|false The permalink URL. False if the post does not exist.
*/
function get_the_permalink( $post = 0, $leavename = false ) {
return get_permalink( $post, $leavename );
@@ -165,7 +165,7 @@ function get_the_permalink( $post = 0, $leavename = false ) {
*
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
* @return string|false The permalink URL or false if post does not exist.
* @return string|false The permalink URL. False if the post does not exist.
*/
function get_permalink( $post = 0, $leavename = false ) {
$rewritecode = array(
@@ -314,15 +314,15 @@ function get_permalink( $post = 0, $leavename = false ) {
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional. Whether to keep post name. Default false.
* @param bool $sample Optional. Is it a sample permalink. Default false.
* @return string|WP_Error The post permalink.
* @return string|false The post permalink URL. False if the post does not exist.
*/
function get_post_permalink( $post = 0, $leavename = false, $sample = false ) {
global $wp_rewrite;
$post = get_post( $post );
if ( is_wp_error( $post ) ) {
return $post;
if ( ! $post ) {
return false;
}
$post_link = $wp_rewrite->get_extra_permastruct( $post->post_type );
@@ -3923,8 +3923,8 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
* @since 4.6.0
*
* @param int|WP_Post $post Optional. Post ID or object. Default is global `$post`.
* @return string|false The canonical URL, or false if the post does not exist or has not
* been published yet.
* @return string|false The canonical URL. False if the post does not exist
* or has not been published yet.
*/
function wp_get_canonical_url( $post = null ) {
$post = get_post( $post );

View File

@@ -0,0 +1,18 @@
<?php
/**
* @group link
* @covers ::get_post_permalink
*/
class Tests_Link_GetPostPermalink extends WP_UnitTestCase {
public function test_get_post_permalink_should_return_string_on_success() {
$post = self::factory()->post->create();
$this->assertIsString( get_post_permalink( $post ) );
}
public function test_get_post_permalink_should_return_false_for_non_existing_post() {
$this->assertFalse( get_post_permalink( -1 ) );
}
}