Changeset 53285

Timestamp:

04/26/2022 03:06:32 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/comment-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 $class parameter to $css_class in comment_class() and get_comment_class().
• Renames the $echo parameter to $display in comment_class().

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

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

File:

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

trunk/src/wp-includes/comment-template.php

@@ -424 +424 @@
  * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
  *
- * @param string|string[] $class    Optional. One or more classes to add to the class list.
- *                                  Default empty.
- * @param int|WP_Comment  $comment  Comment ID or WP_Comment object. Default current comment.
- * @param int|WP_Post     $post_id  Post ID or WP_Post object. Default current post.
- * @param bool            $echo     Optional. Whether to echo or return the output.
- *                                  Default true.
- * @return void|string Void if `$echo` argument is true, comment classes if `$echo` is false.
- */
-function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
+ * @param string|string[] $css_class Optional. One or more classes to add to the class list.
+ *                                   Default empty.
+ * @param int|WP_Comment  $comment   Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post     $post_id   Post ID or WP_Post object. Default current post.
+ * @param bool            $display   Optional. Whether to print or return the output.
+ *                                   Default true.
+ * @return void|string Void if `$display` argument is true, comment classes if `$display` is false.
+ */
+function comment_class( $css_class = '', $comment = null, $post_id = null, $display = true ) {
     // Separates classes with a single space, collates classes for comment DIV.
-    $class = 'class="' . implode( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
-
-    if ( $echo ) {
-        echo $class;
+    $css_class = 'class="' . implode( ' ', get_comment_class( $css_class, $comment, $post_id ) ) . '"';
+
+    if ( $display ) {
+        echo $css_class;
     } else {
-        return $class;
+        return $css_class;
     }
 }
@@ -453 +453 @@
  * @global int $comment_thread_alt
  *
- * @param string|string[] $class      Optional. One or more classes to add to the class list. Default empty.
+ * @param string|string[] $css_class  Optional. One or more classes to add to the class list. Default empty.
  * @param int|WP_Comment  $comment_id Comment ID or WP_Comment object. Default current comment.
  * @param int|WP_Post     $post_id    Post ID or WP_Post object. Default current post.
  * @return string[] An array of classes.
  */
-function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
+function get_comment_class( $css_class = '', $comment_id = null, $post_id = null ) {
     global $comment_alt, $comment_depth, $comment_thread_alt;
 
@@ -517 +517 @@
     $classes[] = "depth-$comment_depth";
 
-    if ( ! empty( $class ) ) {
-        if ( ! is_array( $class ) ) {
-            $class = preg_split( '#\s+#', $class );
+    if ( ! empty( $css_class ) ) {
+        if ( ! is_array( $css_class ) ) {
+            $css_class = preg_split( '#\s+#', $css_class );
         }
-        $classes = array_merge( $classes, $class );
+        $classes = array_merge( $classes, $css_class );
     }
 
@@ -532 +532 @@
      *
      * @param string[]    $classes    An array of comment classes.
-     * @param string[]    $class      An array of additional classes added to the list.
+     * @param string[]    $css_class  An array of additional classes added to the list.
      * @param string      $comment_id The comment ID as a numeric string.
      * @param WP_Comment  $comment    The comment object.
      * @param int|WP_Post $post_id    The post ID or WP_Post object.
      */
-    return apply_filters( 'comment_class', $classes, $class, $comment->comment_ID, $comment, $post_id );
+    return apply_filters( 'comment_class', $classes, $css_class, $comment->comment_ID, $comment, $post_id );
 }