From c9077348ee32a146c8da15dcea514149f33e5a13 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Sun, 1 Dec 2013 17:54:10 +0000
Subject: [PATCH] Inline documentation for hooks in wp-admin/includes/user.php.

Props aaronholbrook for the initial patch.
Fixes #26099.

Built from https://develop.svn.wordpress.org/trunk@26503


git-svn-id: http://core.svn.wordpress.org/trunk@26397 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/includes/ms.php   |  8 +----
 wp-admin/includes/user.php | 67 ++++++++++++++++++++++++++++++++++----
 2 files changed, 61 insertions(+), 14 deletions(-)

diff --git a/wp-admin/includes/ms.php b/wp-admin/includes/ms.php
index facc29209a..e376a1ed13 100644
--- a/wp-admin/includes/ms.php
+++ b/wp-admin/includes/ms.php
@@ -204,13 +204,7 @@ function wpmu_delete_user( $id ) {
 
 	clean_user_cache( $user );
 
-	/**
-	 * Fires after the user is deleted from the network.
-	 *
-	 * @since 2.8.0
-	 *
-	 * @param int $id ID of the user that was deleted from the network.
-	 */
+	/** This action is documented in wp-admin/includes/user.php */
 	do_action( 'deleted_user', $id );
 
 	return true;
diff --git a/wp-admin/includes/user.php b/wp-admin/includes/user.php
index b61cb7ad35..85939fa9ab 100644
--- a/wp-admin/includes/user.php
+++ b/wp-admin/includes/user.php
@@ -109,6 +109,15 @@ function edit_user( $user_id = 0 ) {
 		$errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ) );
 
 	/* checking the password has been typed twice */
+	/**
+	 * Fires before the password and confirm password fields are checked for congruity.
+	 *
+	 * @since 1.5.1
+	 *
+	 * @param string $user_login The username.
+	 * @param string &$pass1     The password, passed by reference.
+	 * @param string &$pass2     The confirmed password, passed by reference.
+	 */
 	do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
 
 	if ( $update ) {
@@ -149,7 +158,15 @@ function edit_user( $user_id = 0 ) {
 		$errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
 	}
 
-	// Allow plugins to return their own errors.
+	/**
+	 * Fires before user profile update errors are returned.
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param array   &$errors An array of user profile update errors, passed by reference.
+	 * @param bool    $update  Whether this is a user update.
+	 * @param WP_User &$user   WP_User object, passed by reference.
+	 */
 	do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
 
 	if ( $errors->get_error_codes() )
@@ -184,7 +201,15 @@ function get_editable_roles() {
 	global $wp_roles;
 
 	$all_roles = $wp_roles->roles;
-	$editable_roles = apply_filters('editable_roles', $all_roles);
+
+	/**
+	 * Filter the list of editable roles.
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param array $all_roles List of roles.
+	 */
+	$editable_roles = apply_filters( 'editable_roles', $all_roles );
 
 	return $editable_roles;
 }
@@ -217,7 +242,15 @@ function get_user_to_edit( $user_id ) {
 function get_users_drafts( $user_id ) {
 	global $wpdb;
 	$query = $wpdb->prepare("SELECT ID, post_title FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'draft' AND post_author = %d ORDER BY post_modified DESC", $user_id);
-	$query = apply_filters('get_users_drafts', $query);
+
+	/**
+	 * Filter the user's drafts query string.
+	 *
+	 * @since 2.0.0
+	 *
+	 * @param string $query The user's drafts query string.
+	 */
+	$query = apply_filters( 'get_users_drafts', $query );
 	return $wpdb->get_results( $query );
 }
 
@@ -244,8 +277,14 @@ function wp_delete_user( $id, $reassign = 'novalue' ) {
 	if ( !$user->exists() )
 		return false;
 
-	// allow for transaction statement
-	do_action('delete_user', $id);
+	/**
+	 * Fires immediately before a user is deleted from the database.
+	 *
+	 * @since 2.0.0
+	 *
+	 * @param int $id User ID.
+	 */
+	do_action( 'delete_user', $id );
 
 	if ( 'novalue' === $reassign || null === $reassign ) {
 		$post_types_to_delete = array();
@@ -257,6 +296,14 @@ function wp_delete_user( $id, $reassign = 'novalue' ) {
 			}
 		}
 
+		/**
+		 * Filter the list of post types to delete with a user.
+		 *
+		 * @since 3.4.0
+		 *
+		 * @param array $post_types_to_delete Post types to delete.
+		 * @param int   $id                   User ID.
+		 */
 		$post_types_to_delete = apply_filters( 'post_types_to_delete_with_user', $post_types_to_delete, $id );
 		$post_types_to_delete = implode( "', '", $post_types_to_delete );
 		$post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d AND post_type IN ('$post_types_to_delete')", $id ) );
@@ -301,8 +348,14 @@ function wp_delete_user( $id, $reassign = 'novalue' ) {
 
 	clean_user_cache( $user );
 
-	// allow for commit transaction
-	do_action('deleted_user', $id);
+	/**
+	 * Fires immediately after a user is deleted from the database.
+	 *
+	 * @since 2.9.0
+	 *
+	 * @param int $id ID of the deleted user.
+	 */
+	do_action( 'deleted_user', $id );
 
 	return true;
 }