Ticket #40969: 40969.10.diff

src/wp-includes/general-template.php

@@ -16 +16 @@
  * "special".
  *
  * @since 1.5.0
+ * @since 5.5.0 A return value was added.
  *
  * @param string $name The name of the specialised header.
+ * @return void|false Void on success, false if the template does not exist.
  */
 function get_header( $name = null ) {
         /**
@@ -38 +40 @@
 
         $templates[] = 'header.php';
 
-        locate_template( $templates, true );
+        if ( ! locate_template( $templates, true ) ) {
+                return false;
+        }
 }
 
 /**
@@ -51 +55 @@
  * "special".
  *
  * @since 1.5.0
+ * @since 5.5.0 A return value was added.
  *
  * @param string $name The name of the specialised footer.
+ * @return void|false Void on success, false if the template does not exist.
  */
 function get_footer( $name = null ) {
         /**
@@ -73 +79 @@
 
         $templates[] = 'footer.php';
 
-        locate_template( $templates, true );
+        if ( ! locate_template( $templates, true ) ) {
+                return false;
+        }
 }
 
 /**
@@ -86 +94 @@
  * "special".
  *
  * @since 1.5.0
+ * @since 5.5.0 A return value was added.
  *
  * @param string $name The name of the specialised sidebar.
+ * @return void|false Void on success, false if the template does not exist.
  */
 function get_sidebar( $name = null ) {
         /**
@@ -108 +118 @@
 
         $templates[] = 'sidebar.php';
 
-        locate_template( $templates, true );
+        if ( ! locate_template( $templates, true ) ) {
+                return false;
+        }
 }
 
 /**
@@ -128 +140 @@
  * "special".
  *
  * @since 3.0.0
+ * @since 5.5.0 A return value was added.
  *
  * @param string $slug The slug name for the generic template.
  * @param string $name The name of the specialised template.
+ * @return void|false Void on success, false if the template does not exist.
  */
 function get_template_part( $slug, $name = null ) {
         /**
@@ -165 +179 @@
          */
         do_action( 'get_template_part', $slug, $name, $templates );
 
-        locate_template( $templates, true, false );
+        if ( ! locate_template( $templates, true, false ) ) {
+                return false;
+        }
 }
 
 /**

new file tests/phpunit/data/themedir1/default/footer.php

@@ +1 @@
+Footer

new file tests/phpunit/data/themedir1/default/header.php

@@ +1 @@
+Header

new file tests/phpunit/data/themedir1/default/sidebar.php

@@ +1 @@
+Sidebar

tests/phpunit/tests/general/template.php

@@ -631 +631 @@
         /**
          * @ticket 40969
          */
-        function test_get_template_part_returns_nothing() {
-                ob_start();
+        function test_get_template_part_returns_nothing_on_success() {
+                $this->expectOutputRegex( '/^Template Part$/' );
 
                 // The `get_template_part()` function must not return anything
                 // due to themes in the wild that echo its return value.
-                $part   = get_template_part( 'template', 'part' );
-                $output = ob_get_clean();
+                $this->assertNull( get_template_part( 'template', 'part' ) );
+        }
+
+        /**
+         * @ticket 40969
+         */
+        function test_get_template_part_returns_false_on_failure() {
+                $this->assertFalse( get_template_part( 'non-existing-template' ) );
+        }
+
+        /**
+         * @ticket 40969
+         */
+        function test_get_header_returns_nothing_on_success() {
+                $this->expectOutputRegex( '/^Header$/' );
+
+                // The `get_header()` function must not return anything
+                // due to themes in the wild that may echo its return value.
+                $this->assertNull( get_header() );
+        }
+
+        /**
+         * @ticket 40969
+         */
+        function test_get_footer_returns_nothing_on_success() {
+                $this->expectOutputRegex( '/^Footer$/' );
+
+                // The `get_footer()` function must not return anything
+                // due to themes in the wild that may echo its return value.
+                $this->assertNull( get_footer() );
+        }
+
+        /**
+         * @ticket 40969
+         */
+        function test_get_sidebar_returns_nothing_on_success() {
+                $this->expectOutputRegex( '/^Sidebar$/' );
 
-                self::assertSame( 'Template Part', trim( $output ) );
-                self::assertSame( null, $part );
+                // The `get_sidebar()` function must not return anything
+                // due to themes in the wild that may echo its return value.
+                $this->assertNull( get_sidebar() );
         }
 }