Changeset 53733

Timestamp:

07/20/2022 03:39:18 PM (11 months ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk

Files:

• src/wp-includes/link-template.php (modified) (5 diffs)
• tests/phpunit/tests/link/getPostPermalink.php (added)

trunk/src/wp-includes/link-template.php

@@ -153 +153 @@
  * @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 ) {
@@ -166 +166 @@
  * @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 ) {
@@ -315 +315 @@
  * @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 ) {
@@ -322 +322 @@
     $post = get_post( $post );
 
-    if ( is_wp_error( $post ) ) {
-        return $post;
+    if ( ! $post ) {
+        return false;
     }
 
@@ -3924 +3924 @@
  *
  * @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 ) {