<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26503] trunk/src/wp-admin/includes: Inline documentation for hooks in wp-admin/includes/user.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26503">26503</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-12-01 17:53:18 +0000 (Sun, 01 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-admin/includes/user.php.
Props aaronholbrook for the initial patch.
Fixes <a href="http://core.trac.wordpress.org/ticket/26099">#26099</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmsphp">trunk/src/wp-admin/includes/ms.php</a></li>
<li><a href="#trunksrcwpadminincludesuserphp">trunk/src/wp-admin/includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/ms.php (26502 => 26503)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/ms.php 2013-12-01 17:31:49 UTC (rev 26502)
+++ trunk/src/wp-admin/includes/ms.php 2013-12-01 17:53:18 UTC (rev 26503)
</span><span class="lines">@@ -204,13 +204,7 @@
</span><span class="cx">
</span><span class="cx"> clean_user_cache( $user );
</span><span class="cx">
</span><del>- /**
- * 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.
- */
</del><ins>+ /** This action is documented in wp-admin/includes/user.php */
</ins><span class="cx"> do_action( 'deleted_user', $id );
</span><span class="cx">
</span><span class="cx"> return true;
</span></span></pre></div>
<a id="trunksrcwpadminincludesuserphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/user.php (26502 => 26503)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/user.php 2013-12-01 17:31:49 UTC (rev 26502)
+++ trunk/src/wp-admin/includes/user.php 2013-12-01 17:53:18 UTC (rev 26503)
</span><span class="lines">@@ -109,6 +109,15 @@
</span><span class="cx"> $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ) );
</span><span class="cx">
</span><span class="cx"> /* checking the password has been typed twice */
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
</span><span class="cx">
</span><span class="cx"> if ( $update ) {
</span><span class="lines">@@ -149,7 +158,15 @@
</span><span class="cx"> $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Allow plugins to return their own errors.
</del><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
</span><span class="cx">
</span><span class="cx"> if ( $errors->get_error_codes() )
</span><span class="lines">@@ -184,8 +201,16 @@
</span><span class="cx"> global $wp_roles;
</span><span class="cx">
</span><span class="cx"> $all_roles = $wp_roles->roles;
</span><del>- $editable_roles = apply_filters('editable_roles', $all_roles);
</del><span class="cx">
</span><ins>+ /**
+ * 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 );
+
</ins><span class="cx"> return $editable_roles;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -217,7 +242,15 @@
</span><span class="cx"> function get_users_drafts( $user_id ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx"> $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);
</span><del>- $query = apply_filters('get_users_drafts', $query);
</del><ins>+
+ /**
+ * 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 );
</ins><span class="cx"> return $wpdb->get_results( $query );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -244,8 +277,14 @@
</span><span class="cx"> if ( !$user->exists() )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- // allow for transaction statement
- do_action('delete_user', $id);
</del><ins>+ /**
+ * Fires immediately before a user is deleted from the database.
+ *
+ * @since 2.0.0
+ *
+ * @param int $id User ID.
+ */
+ do_action( 'delete_user', $id );
</ins><span class="cx">
</span><span class="cx"> if ( 'novalue' === $reassign || null === $reassign ) {
</span><span class="cx"> $post_types_to_delete = array();
</span><span class="lines">@@ -257,6 +296,14 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> $post_types_to_delete = apply_filters( 'post_types_to_delete_with_user', $post_types_to_delete, $id );
</span><span class="cx"> $post_types_to_delete = implode( "', '", $post_types_to_delete );
</span><span class="cx"> $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 ) );
</span><span class="lines">@@ -301,8 +348,14 @@
</span><span class="cx">
</span><span class="cx"> clean_user_cache( $user );
</span><span class="cx">
</span><del>- // allow for commit transaction
- do_action('deleted_user', $id);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> return true;
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>