Changeset 53741

Timestamp:

07/20/2022 09:11:30 PM (2 years ago)

Author:

audrasjb

Message:

Themes: Add a hook to filter theme header image URL.

This changeset introduces the get_header_image filter, which can be used to modify header image URL returned by get_header_image(), in themes that support the Header Image feature.

Props hztyfoon, audrasjb, mukesh27, SergeyBiryukov, costdev.
Fixes #56180.

Location:

trunk

Files:

• src/wp-includes/theme.php (modified) (1 diff)
• tests/phpunit/tests/theme/customHeader.php (modified) (1 diff)

trunk/src/wp-includes/theme.php

@@ -1180 +1180 @@
     }
 
+    /**
+     * Filters the header image URL.
+     *
+     * @since 6.1.0
+     *
+     * @param string $url Header image URL.
+     */
+    $url = apply_filters( 'get_header_image', $url );
+
+    if ( ! is_string( $url ) ) {
+        return false;
+    }
+
+    $url = trim( $url );
     return sanitize_url( set_url_scheme( $url ) );
 }

trunk/tests/phpunit/tests/theme/customHeader.php

@@ -80 +80 @@
         $this->assertFalse( has_header_image() );
         $this->assertFalse( $image );
+    }
+
+    /**
+     * Tests the "get_header_image" filter.
+     *
+     * @ticket 56180
+     *
+     * @covers get_header_image
+     *
+     * @dataProvider data_filter_header_image
+     *
+     * @param mixed  $header_image The header image.
+     * @param string $expected     The expected return value from get_header_image().
+     */
+    public function test_filter_header_image( $header_image, $expected ) {
+        add_filter(
+            'get_header_image',
+            static function() use ( $header_image ) {
+                return $header_image;
+            }
+        );
+
+        $this->assertSame( $expected, get_header_image() );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_filter_header_image() {
+        return array(
+            'an image url'         => array(
+                'header_image' => 'http://example.org/image.png',
+                'expected'     => 'http://example.org/image.png',
+            ),
+            'an empty string'      => array(
+                'header_image' => '',
+                'expected'     => '',
+            ),
+            'a string with spaces' => array(
+                'header_image' => ' ',
+                'expected'     => '',
+            ),
+            'null'                 => array(
+                'header_image' => null,
+                'expected'     => false,
+            ),
+            'false'                => array(
+                'header_image' => false,
+                'expected'     => false,
+            ),
+        );
     }