From 91fb5e641a41b77652862de671dd2d8538675e51 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Sat, 23 Nov 2013 22:24:25 +0000
Subject: [PATCH] Inline documentation for hooks in
 wp-admin/includes/class-wp-ms-users-list-table.php.

Props ShinichiN, kpdesign.
Fixes #25612.


git-svn-id: https://develop.svn.wordpress.org/trunk@26342 602fd350-edb4-49c9-b593-d223f7449a82
---
 .../includes/class-wp-ms-users-list-table.php | 31 ++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/src/wp-admin/includes/class-wp-ms-users-list-table.php b/src/wp-admin/includes/class-wp-ms-users-list-table.php
index bccb01028e..271fe5a093 100644
--- a/src/wp-admin/includes/class-wp-ms-users-list-table.php
+++ b/src/wp-admin/includes/class-wp-ms-users-list-table.php
@@ -118,6 +118,14 @@ class WP_MS_Users_List_Table extends WP_List_Table {
 			'registered' => _x( 'Registered', 'user' ),
 			'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 );
 
 		return $users_columns;
@@ -189,6 +197,16 @@ class WP_MS_Users_List_Table extends WP_List_Table {
 									$actions['delete'] = '<a href="' . $delete = esc_url( network_admin_url( add_query_arg( '_wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), wp_nonce_url( 'users.php', 'deleteuser' ) . '&amp;action=deleteuser&amp;id=' . $user->ID ) ) ) . '" class="delete">' . __( 'Delete' ) . '</a>';
 								}
 
+								/**
+								 * 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 );
 							?>
@@ -240,7 +258,17 @@ class WP_MS_Users_List_Table extends WP_List_Table {
 
 									$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;
 									$action_count = count( $actions );
@@ -259,6 +287,7 @@ class WP_MS_Users_List_Table extends WP_List_Table {
 
 					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>";
 					break;