Changeset 26342

Timestamp:

11/23/2013 10:24:25 PM (11 years ago)

Author:

DrewAPicture

Message:

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

Props ShinichiN, kpdesign.
Fixes #25612.

File:

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

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

@@ -119 +119 @@
             'blogs'      => __( 'Sites' )
         );
+        /**
+         * Filter the columns displayed in the Network Admin Users list table.
+         *
+         * @since MU
+         *
+         * @param array $users_columns An array of user columns. Default 'cb', 'username',
+         *                             'name', 'email', 'registered', 'blogs'.
+         */
         $users_columns = apply_filters( 'wpmu_users_columns', $users_columns );
 
@@ -190 +198 @@
                                 }
 
+                                /**
+                                 * Filter the action links displayed under each user
+                                 * in the Network Admin Users list table.
+                                 *
+                                 * @since 3.2.0
+                                 *
+                                 * @param array   $actions An array of action links to be displayed.
+                                 *                         Default 'Edit', 'Delete'.
+                                 * @param WP_User $user    WP_User object.
+                                 */
                                 $actions = apply_filters( 'ms_user_row_actions', $actions, $user );
                                 echo $this->row_actions( $actions );
@@ -241 +259 @@
                                     $actions['view'] = '<a class="' . $class . '" href="' . esc_url( get_home_url( $val->userblog_id ) ) . '">' . __( 'View' ) . '</a>';
 
-                                    $actions = apply_filters('ms_user_list_site_actions', $actions, $val->userblog_id);
+                                    /**
+                                     * Filter the action links displayed next the sites a user belongs to
+                                     * in the Network Admin Users list table.
+                                     *
+                                     * @since 3.1.0
+                                     *
+                                     * @param array $actions     An array of action links to be displayed.
+                                     *                           Default 'Edit', 'View'.
+                                     * @param int   $userblog_id The site ID.
+                                     */
+                                    $actions = apply_filters( 'ms_user_list_site_actions', $actions, $val->userblog_id );
 
                                     $i=0;
@@ -260 +288 @@
                     default:
                         echo "<td $attributes>";
+                        /** This filter is documented in wp-admin/includes/class-wp-users-list-table.php */
                         echo apply_filters( 'manage_users_custom_column', '', $column_name, $user->ID );
                         echo "</td>";