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.
Built from https://develop.svn.wordpress.org/trunk@55013


git-svn-id: http://core.svn.wordpress.org/trunk@54546 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2022-12-22 11:08:19 +00:00
parent f25373720c
commit bf344bb3bf
2 changed files with 11 additions and 11 deletions

View File

@ -690,13 +690,13 @@ function get_attachment_template() {
*
* @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.
* Default empty array.
* @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 ) {
if ( ! $template_name ) {
@ -715,7 +715,7 @@ function locate_template( $template_names, $load = false, $require_once = true,
}
if ( $load && '' !== $located ) {
load_template( $located, $require_once, $args );
load_template( $located, $load_once, $args );
}
return $located;
@ -744,11 +744,11 @@ function locate_template( $template_names, $load = false, $require_once = true,
* @global int $user_ID
*
* @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;
if ( is_array( $wp_query->query_vars ) ) {
@ -774,12 +774,12 @@ function load_template( $_template_file, $require_once = true, $args = array() )
* @since 6.1.0
*
* @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 );
do_action( 'wp_before_load_template', $_template_file, $load_once, $args );
if ( $require_once ) {
if ( $load_once ) {
require_once $_template_file;
} else {
require $_template_file;
@ -791,8 +791,8 @@ function load_template( $_template_file, $require_once = true, $args = array() )
* @since 6.1.0
*
* @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 );
}

View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.2-alpha-55012';
$wp_version = '6.2-alpha-55013';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.