Changeset 56662 for trunk/src/wp-includes/functions.php

Timestamp:

09/22/2023 06:12:12 PM (15 months ago)

Author:

joedolson

Message:

Code Modernization: Rename reserved keyword used as variable.

Change the $echo parameter added to wp_update_php_annnotation() to $display to avoid using reserved PHP keywords as parameters. Follow up to [56570].

Props kebbet, mukesh27.
See #57791.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -8319 +8319 @@
  * @since 5.1.0
  * @since 5.2.0 Added the `$before` and `$after` parameters.
- * @since 6.4.0 Added the `$echo` parameter.
- *
- * @param string $before Markup to output before the annotation. Default `<p class="description">`.
- * @param string $after  Markup to output after the annotation. Default `</p>`.
- * @param bool   $echo   Markup should echo if true. Default `true`.
+ * @since 6.4.0 Added the `$display` parameter.
+ *
+ * @param string $before  Markup to output before the annotation. Default `<p class="description">`.
+ * @param string $after   Markup to output after the annotation. Default `</p>`.
+ * @param bool   $display Whether to echo or return the markup. Default `true` for echo.
  *
  * @return string|void
  */
-function wp_update_php_annotation( $before = '<p class="description">', $after = '</p>', $echo = true ) {
+function wp_update_php_annotation( $before = '<p class="description">', $after = '</p>', $display = true ) {
     $annotation = wp_get_update_php_annotation();
 
     if ( $annotation ) {
-        if ( $echo ) {
+        if ( $display ) {
             echo $before . $annotation . $after;
         } else {