Changeset 44725

Timestamp:

02/06/2019 06:36:49 PM (6 years ago)

Author:

desrosj

Message:

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

Because the names of the get_header(), get_footer(), get_sidebar(), and get_template_part() functions indicate that a value is returned, some plugins and themes already have echo get_template_part() in their codebase. Adding a return value to these functions using the approach in [44678] will cause the two unintended side effects of unexpected content being sent to the browser, and accidental path disclosure.

Reverts [44678].

Props davidbinda.
See #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 ) {
@@ -41 +39 @@
     $templates[] = 'header.php';
 
-    return locate_template( $templates, true );
+    locate_template( $templates, true );
 }
 
@@ -54 +52 @@
  *
  * @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 ) {
@@ -78 +74 @@
     $templates[] = 'footer.php';
 
-    return locate_template( $templates, true );
+    locate_template( $templates, true );
 }
 
@@ -91 +87 @@
  *
  * @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 ) {
@@ -115 +109 @@
     $templates[] = 'sidebar.php';
 
-    return locate_template( $templates, true );
+    locate_template( $templates, true );
 }
 
@@ -135 +129 @@
  *
  * @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 ) {
@@ -163 +155 @@
     $templates[] = "{$slug}.php";
 
-    return locate_template( $templates, true, false );
+    locate_template( $templates, true, false );
 }