Changeset 27342

Timestamp:

03/01/2014 02:59:53 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/class-wp-users-list-table.php.

Props leewillis77.
Fixes #26203.

File:

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

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

@@ -218 +218 @@
                 endif;
 
+                /**
+                 * Fires just before the closing div containing the buik role-change controls
+                 * in the Users list table.
+                 *
+                 * @since 3.5.0
+                 */
                 do_action( 'restrict_manage_users' );
                 echo '</div>';
@@ -364 +370 @@
                         if ( is_multisite() && get_current_user_id() != $user_object->ID && current_user_can( 'remove_user', $user_object->ID ) )
                                 $actions['remove'] = "<a class='submitdelete' href='" . wp_nonce_url( $url."action=remove&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Remove' ) . "</a>";
+
+                        /**
+                         * Filter user row actions for a single row in the Users list table.
+                         *
+                         * @since 2.8.0
+                         *
+                         * @param array   $actions     Array of row actions actions.
+                         * @param WP_User $user_object WP_User object for the currently-listed user.
+                         */
                         $actions = apply_filters( 'user_row_actions', $actions, $user_object );
                         $edit .= $this->row_actions( $actions );
@@ -420 +435 @@
                                 default:
                                         $r .= "<td $attributes>";
+
+                                        /**
+                                         * Filter display output of custom columns in the Users list table.
+                                         *
+                                         * @since 2.8.0
+                                         *
+                                         * @param string $output Custom column output. Default empty.
+                                         * @param string $column_name Column name.
+                                         * @param int    $user_id     ID of the currently-listed user.
+                                         */
                                         $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
                                         $r .= "</td>";