Changeset 44678

Timestamp:

01/21/2019 09:59:44 PM (6 years ago)

Author:

pento

Message:

Themes: Return the value of locate_template() in functions that call it.

The get_header(), get_footer(), get_sidebar(), and get_template_part() functions all call locate_template() as their final action, which returns the name of the template being loaded. Returning this value helps handle problems with templates being loaded.

Props tferry.
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.1.0 Added the return value.
  *
  * @param string $name The name of the specialised header.
+ * @return string The template filename if one is located.
  */
 function get_header( $name = null ) {
@@ -39 +41 @@
     $templates[] = 'header.php';
 
-    locate_template( $templates, true );
+    return locate_template( $templates, true );
 }
 
@@ -52 +54 @@
  *
  * @since 1.5.0
+ * @since 5.1.0 Added the return value.
  *
  * @param string $name The name of the specialised footer.
+ * @return string The template filename if one is located.
  */
 function get_footer( $name = null ) {
@@ -74 +78 @@
     $templates[] = 'footer.php';
 
-    locate_template( $templates, true );
+    return locate_template( $templates, true );
 }
 
@@ -87 +91 @@
  *
  * @since 1.5.0
+ * @since 5.1.0 Added the return value.
  *
  * @param string $name The name of the specialised sidebar.
+ * @return string The template filename if one is located.
  */
 function get_sidebar( $name = null ) {
@@ -109 +115 @@
     $templates[] = 'sidebar.php';
 
-    locate_template( $templates, true );
+    return locate_template( $templates, true );
 }
 
@@ -129 +135 @@
  *
  * @since 3.0.0
+ * @since 5.1.0 Added the return value.
  *
  * @param string $slug The slug name for the generic template.
  * @param string $name The name of the specialised template.
+ * @return string The template filename if one is located.
  */
 function get_template_part( $slug, $name = null ) {
@@ -155 +163 @@
     $templates[] = "{$slug}.php";
 
-    locate_template( $templates, true, false );
+    return locate_template( $templates, true, false );
 }