Changeset 47122 for trunk/src/wp-admin/includes/class-wp-users-list-table.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/class-wp-users-list-table.php (modified) (10 diffs)

trunk/src/wp-admin/includes/class-wp-users-list-table.php

@@ -138 +138 @@
         $args = apply_filters( 'users_list_table_query_args', $args );
 
-        // Query the user IDs for this page
+        // Query the user IDs for this page.
         $wp_user_search = new WP_User_Query( $args );
 
@@ -167 +167 @@
      * Filtersing of the user table.
      *
-     * @since  3.1.0
+     * @since 3.1.0
      *
      * @global string $role
@@ -258 +258 @@
      * Retrieve an associative array of bulk actions available on this table.
      *
-     * @since  3.1.0
+     * @since 3.1.0
      *
      * @return string[] Array of bulk action labels keyed by their action.
@@ -331 +331 @@
      * the role change drop-down.
      *
-     * @since  3.1.0
+     * @since 3.1.0
      *
      * @return string The bulk action required.
@@ -347 +347 @@
      * Get a list of columns for the list table.
      *
-     * @since  3.1.0
+     * @since 3.1.0
      *
      * @return string[] Array of column titles keyed by their column name.
@@ -390 +390 @@
      */
     public function display_rows() {
-        // Query the post counts for this page
+        // Query the post counts for this page.
         if ( ! $this->is_site_users ) {
             $post_counts = count_many_users_posts( array_keys( $this->items ) );
@@ -429 +429 @@
         $user_roles = $this->get_role_list( $user_object );
 
-        // Set up the hover actions for this user
+        // Set up the hover actions for this user.
         $actions     = array();
         $checkbox    = '';
@@ -440 +440 @@
         }
 
-        // Check if the user for this row is editable
+        // Check if the user for this row is editable.
         if ( current_user_can( 'list_users' ) ) {
-            // Set up the user editing link
+            // Set up the user editing link.
             $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user_object->ID ) ) );
 
@@ -486 +486 @@
             $role_classes = esc_attr( implode( ' ', array_keys( $user_roles ) ) );
 
-            // Set up the checkbox ( because the user is editable, otherwise it's empty )
+            // Set up the checkbox (because the user is editable, otherwise it's empty).
             $checkbox = sprintf(
                 '<label class="screen-reader-text" for="user_%1$s">%2$s</label>' .
@@ -515 +515 @@
             }
             if ( 'posts' === $column_name ) {
-                $classes .= ' num'; // Special case for that column
+                $classes .= ' num'; // Special case for that column.
             }