Changeset 53283 for trunk/src/wp-includes/class.wp-scripts.php

Timestamp:

04/26/2022 02:54:37 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/class.wp-scripts.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 $echo parameter to $display in WP_Scripts class methods.

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].

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

File:

• trunk/src/wp-includes/class.wp-scripts.php (modified) (7 diffs)

trunk/src/wp-includes/class.wp-scripts.php

@@ -191 +191 @@
      *
      * @since 2.1.0
-     * @since 2.8.0 Added the `$echo` parameter.
+     * @since 2.8.0 Added the `$display` parameter.
      * @deprecated 3.3.0
      *
      * @see print_extra_script()
      *
-     * @param string $handle The script's registered handle.
-     * @param bool   $echo   Optional. Whether to echo the extra script
-     *                       instead of just returning it. Default true.
-     * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
+     * @param string $handle  The script's registered handle.
+     * @param bool   $display Optional. Whether to print the extra script
+     *                        instead of just returning it. Default true.
+     * @return bool|string|void Void if no data exists, extra scripts if `$display` is true,
      *                          true otherwise.
      */
-    public function print_scripts_l10n( $handle, $echo = true ) {
+    public function print_scripts_l10n( $handle, $display = true ) {
         _deprecated_function( __FUNCTION__, '3.3.0', 'WP_Scripts::print_extra_script()' );
-        return $this->print_extra_script( $handle, $echo );
+        return $this->print_extra_script( $handle, $display );
     }
 
@@ -212 +212 @@
      * @since 3.3.0
      *
-     * @param string $handle The script's registered handle.
-     * @param bool   $echo   Optional. Whether to echo the extra script
-     *                       instead of just returning it. Default true.
-     * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
+     * @param string $handle  The script's registered handle.
+     * @param bool   $display Optional. Whether to print the extra script
+     *                        instead of just returning it. Default true.
+     * @return bool|string|void Void if no data exists, extra scripts if `$display` is true,
      *                          true otherwise.
      */
-    public function print_extra_script( $handle, $echo = true ) {
+    public function print_extra_script( $handle, $display = true ) {
         $output = $this->get_data( $handle, 'data' );
         if ( ! $output ) {
@@ -224 +224 @@
         }
 
-        if ( ! $echo ) {
+        if ( ! $display ) {
             return $output;
         }
@@ -445 +445 @@
      * @param string $position Optional. Whether to add the inline script
      *                         before the handle or after. Default 'after'.
-     * @param bool   $echo     Optional. Whether to echo the script
+     * @param bool   $display  Optional. Whether to print the script
      *                         instead of just returning it. Default true.
      * @return string|false Script on success, false otherwise.
      */
-    public function print_inline_script( $handle, $position = 'after', $echo = true ) {
+    public function print_inline_script( $handle, $position = 'after', $display = true ) {
         $output = $this->get_data( $handle, $position );
 
@@ -458 +458 @@
         $output = trim( implode( "\n", $output ), "\n" );
 
-        if ( $echo ) {
+        if ( $display ) {
             printf( "<script%s id='%s-js-%s'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), esc_attr( $position ), $output );
         }
@@ -583 +583 @@
      * @since 5.0.0
      *
-     * @param string $handle Name of the script to add the inline script to.
-     *                       Must be lowercase.
-     * @param bool   $echo   Optional. Whether to echo the script
-     *                       instead of just returning it. Default true.
+     * @param string $handle  Name of the script to add the inline script to.
+     *                        Must be lowercase.
+     * @param bool   $display Optional. Whether to print the script
+     *                        instead of just returning it. Default true.
      * @return string|false Script on success, false otherwise.
      */
-    public function print_translations( $handle, $echo = true ) {
+    public function print_translations( $handle, $display = true ) {
         if ( ! isset( $this->registered[ $handle ] ) || empty( $this->registered[ $handle ]->textdomain ) ) {
             return false;
@@ -611 +611 @@
 JS;
 
-        if ( $echo ) {
+        if ( $display ) {
             printf( "<script%s id='%s-js-translations'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $output );
         }