Changeset 26503 for trunk/src/wp-admin/includes/user.php

Timestamp:

12/01/2013 05:53:18 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/user.php.

Props aaronholbrook for the initial patch.
Fixes #26099.

File:

• trunk/src/wp-admin/includes/user.php (modified) (7 diffs)

trunk/src/wp-admin/includes/user.php

@@ -110 +110 @@
 
     /* 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 ) );
 
@@ -150 +159 @@
     }
 
-    // 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 ) );
 
@@ -185 +202 @@
 
     $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;
@@ -218 +243 @@
     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 );
 }
@@ -245 +278 @@
         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 ) {
@@ -258 +297 @@
         }
 
+        /**
+         * 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 );
@@ -302 +349 @@
     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;