Changeset 55013 for trunk/src/wp-includes/template.php

Timestamp:

12/22/2022 11:06:10 AM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/template.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $require_once parameter to $load_once in:

• locate_template()
• load_template()

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

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

trunk/src/wp-includes/template.php

@@ -691 +691 @@
  * @param string|array $template_names Template file(s) to search for, in order.
  * @param bool         $load           If true the template file will be loaded if it is found.
- * @param bool         $require_once   Whether to require_once or require. Has no effect if `$load` is false.
+ * @param bool         $load_once      Whether to require_once or require. Has no effect if `$load` is false.
  *                                     Default true.
  * @param array        $args           Optional. Additional arguments passed to the template.
@@ -697 +697 @@
  * @return string The template filename if one is located.
  */
-function locate_template( $template_names, $load = false, $require_once = true, $args = array() ) {
+function locate_template( $template_names, $load = false, $load_once = true, $args = array() ) {
     $located = '';
     foreach ( (array) $template_names as $template_name ) {
@@ -716 +716 @@
 
     if ( $load && '' !== $located ) {
-        load_template( $located, $require_once, $args );
+        load_template( $located, $load_once, $args );
     }
 
@@ -745 +745 @@
  *
  * @param string $_template_file Path to template file.
- * @param bool   $require_once   Whether to require_once or require. Default true.
+ * @param bool   $load_once      Whether to require_once or require. Default true.
  * @param array  $args           Optional. Additional arguments passed to the template.
  *                               Default empty array.
  */
-function load_template( $_template_file, $require_once = true, $args = array() ) {
+function load_template( $_template_file, $load_once = true, $args = array() ) {
     global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
 
@@ -775 +775 @@
      *
      * @param string $_template_file The full path to the template file.
-     * @param bool   $require_once   Whether to require_once or require.
+     * @param bool   $load_once      Whether to require_once or require.
      * @param array  $args           Additional arguments passed to the template.
      */
-    do_action( 'wp_before_load_template', $_template_file, $require_once, $args );
-
-    if ( $require_once ) {
+    do_action( 'wp_before_load_template', $_template_file, $load_once, $args );
+
+    if ( $load_once ) {
         require_once $_template_file;
     } else {
@@ -792 +792 @@
      *
      * @param string $_template_file The full path to the template file.
-     * @param bool   $require_once   Whether to require_once or require.
+     * @param bool   $load_once      Whether to require_once or require.
      * @param array  $args           Additional arguments passed to the template.
      */
-    do_action( 'wp_after_load_template', $_template_file, $require_once, $args );
-}
+    do_action( 'wp_after_load_template', $_template_file, $load_once, $args );
+}