Changeset 25470

Timestamp:

09/17/2013 08:32:07 AM (11 years ago)

Author:

SergeyBiryukov

Message:

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

props bftrick.
see #25229.

File:

• trunk/src/wp-admin/user-new.php (modified) (5 diffs)

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

@@ -112 +112 @@
         }
     } else {
-        // Adding a new user to this blog
+        // Adding a new user to this site
         $user_details = wpmu_validate_user_signup( $_REQUEST[ 'user_login' ], $_REQUEST[ 'email' ] );
         if ( is_wp_error( $user_details[ 'errors' ] ) && !empty( $user_details[ 'errors' ]->errors ) ) {
             $add_user_errors = $user_details[ 'errors' ];
         } else {
-            $new_user_login = apply_filters('pre_user_login', sanitize_user(wp_unslash($_REQUEST['user_login']), true));
+            /** 
+             * Filter the user_login, aka the username, before it is added to the site.
+             * 
+             * @since 3.0.0
+             * 
+             * @param string $_REQUEST['user_login'] The sanitized username. 
+             */ 
+            $new_user_login = apply_filters( 'pre_user_login', sanitize_user( wp_unslash( $_REQUEST['user_login'] ), true ) );
             if ( isset( $_POST[ 'noconfirmation' ] ) && is_super_admin() ) {
                 add_filter( 'wpmu_signup_user_notification', '__return_false' ); // Disable confirmation email
@@ -182 +189 @@
 wp_enqueue_script('user-profile');
 
+/** 
+ * Allows you to enable user auto-complete for non-super admins in multisite.
+ * 
+ * @since 3.4.0
+ * 
+ * @param bool True or false, based on if you enable auto-complete for non-super admins. Default is false.
+ */ 
 if ( is_multisite() && current_user_can( 'promote_users' ) && ! wp_is_large_network( 'users' )
     && ( is_super_admin() || apply_filters( 'autocomplete_users_for_site_admins', false ) )
@@ -267 +281 @@
     }
 ?>
+<?php
+/** 
+ * Fires inside the adduser form tag.
+ * 
+ * @since 3.0.0
+ */ 
+?>
 <form action="" method="post" name="adduser" id="adduser" class="validate"<?php do_action('user_new_form_tag');?>>
 <input name="action" type="hidden" value="adduser" />
@@ -300 +321 @@
 ?>
 <p><?php _e('Create a brand new user and add them to this site.'); ?></p>
+<?php
+//duplicate_hook
+?>
 <form action="" method="post" name="createuser" id="createuser" class="validate"<?php do_action('user_new_form_tag');?>>
 <input name="action" type="hidden" value="createuser" />
@@ -339 +363 @@
         <td><input name="url" type="text" id="url" class="code" value="<?php echo esc_attr($new_user_uri); ?>" /></td>
     </tr>
-<?php if ( apply_filters('show_password_fields', true) ) : ?>
+<?php 
+/** 
+ * Filter the display of the password fields.
+ * 
+ * @since 1.5.1
+ * 
+ * @param bool True or false, based on if you want to show the password fields. Default is true.
+ */ 
+if ( apply_filters( 'show_password_fields', true ) ) : ?>
     <tr class="form-field form-required">
         <th scope="row"><label for="pass1"><?php _e('Password'); ?> <span class="description"><?php /* translators: password input field */_e('(required)'); ?></span></label></th>