Changeset 60108

Timestamp:

03/30/2025 11:32:38 PM (17 months ago)

Author:

audrasjb

Message:

Canonical: Use get_post_status() to determine whether the post has a publish post status in wp_get_canonical_url().

This changeset fixes an issue where wp_get_canonical_url() always returned false for attachments. Attachments have a inherit post status rather than publish. The wp_get_canonical_url() function was directly checking $post->post_status === 'publish', causing it to always return false for attachments. Using get_post_status() fixes the issue as if the post is an attachment, then the parent post status will be given instead.

Follow-up to [37685].

Props othernoel, ankitkumarshah, SirLouen,
Fixes #63041.

Location:

trunk

Files:

• src/wp-includes/link-template.php (modified) (1 diff)
• tests/phpunit/tests/link/wpGetCanonicalUrl.php (modified) (3 diffs)

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

@@ -4064 +4064 @@
         }
 
-        if ( 'publish' !== $post->post_status ) {
+        if ( 'publish' !== get_post_status( $post ) ) {
                 return false;
         }

trunk/tests/phpunit/tests/link/wpGetCanonicalUrl.php

@@ -1 +1 @@
 <?php
-
 /**
+ * Tests for the wp_get_canonical_url() function.
+ *
+ * @package WordPress
+ * @subpackage Link
+ */
+
+/**
+ * Class for Testing the wp_get_canonical_url() function.
+ * 
  * @group link
  * @group canonical
  * @covers ::wp_get_canonical_url
  */
-class Tests_Link_wpGetCanonicalUrl extends WP_UnitTestCase {
+class Tests_Link_WpGetCanonicalUrl extends WP_UnitTestCase {
+        /**
+         * The ID of the post.
+         *
+         * @var int
+         */
         public static $post_id;
 
+        /**
+         * The ID of the attachment.
+         *
+         * @var int
+         */
+        public static $attachment_id;
+
+        /**
+         * Sets up the test environment before any tests are run.
+         *
+         * @param WP_UnitTest_Factory $factory The factory object.
+         */
         public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
                 self::$post_id = $factory->post->create(
@@ -16 +41 @@
                         )
                 );
+
+                self::$attachment_id = $factory->attachment->create_object(
+                        array(
+                                'file'        => DIR_TESTDATA . '/images/canola.jpg',
+                                'post_parent' => self::$post_id,
+                                'post_status' => 'inherit',
+                        )
+                );
         }
 
@@ -139 +172 @@
 
                 $this->assertSame( $expected, wp_get_canonical_url( self::$post_id ) );
+        }
+
+        /**
+         * This test ensures that attachments with 'inherit' status properly receive a canonical URL.
+         *
+         * @ticket 63041
+         */
+        public function test_attachment_canonical_url() {
+                $this->go_to( get_attachment_link( self::$attachment_id ) );
+                $canonical_url = wp_get_canonical_url( self::$attachment_id );
+
+                $this->assertNotFalse( $canonical_url, 'Attachment should have a canonical URL' );
+                $this->assertSame( get_attachment_link( self::$attachment_id ), $canonical_url, 'Canonical URL should match the attachment permalink' );
         }