Changeset 48209 for trunk/src/wp-includes/general-template.php

Timestamp:

06/28/2020 11:08:57 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Themes: Add a return value to theme functions calling locate_template():

• get_header()
• get_footer()
• get_sidebar()
• get_template_part()

These functions now return false if the template file could not be found, to allow for easier debugging.

Props tferry, sphakka, johnbillion, pento, davidbinda, desrosj, birgire, garrett-eclipse, williampatton, davidbaumwald, SergeyBiryukov.
Fixes #40969.

File:

• trunk/src/wp-includes/general-template.php (modified) (8 diffs)

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

@@ -17 +17 @@
  *
  * @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 ) {
@@ -39 +41 @@
     $templates[] = 'header.php';
 
-    locate_template( $templates, true );
+    if ( ! locate_template( $templates, true ) ) {
+        return false;
+    }
 }
 
@@ -52 +56 @@
  *
  * @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 ) {
@@ -74 +80 @@
     $templates[] = 'footer.php';
 
-    locate_template( $templates, true );
+    if ( ! locate_template( $templates, true ) ) {
+        return false;
+    }
 }
 
@@ -87 +95 @@
  *
  * @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 ) {
@@ -109 +119 @@
     $templates[] = 'sidebar.php';
 
-    locate_template( $templates, true );
+    if ( ! locate_template( $templates, true ) ) {
+        return false;
+    }
 }
 
@@ -129 +141 @@
  *
  * @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 ) {
@@ -166 +180 @@
     do_action( 'get_template_part', $slug, $name, $templates );
 
-    locate_template( $templates, true, false );
+    if ( ! locate_template( $templates, true, false ) ) {
+        return false;
+    }
 }