Changeset 63496

Timestamp:

09/05/2026 09:52:14 AM (5 days ago)

Author:

wildworks

Message:

Docs: Align @param tag columns in users and multisite docblocks.

Aligns @param tag columns in docblocks across the users and multisite code per the PHP inline documentation standards.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/13314

Props mukesh27, wildworks.
See #65818.

Location:

trunk/src

Files:

• wp-admin/includes/user.php (modified) (2 diffs)
• wp-admin/user-edit.php (modified) (1 diff)
• wp-admin/user-new.php (modified) (2 diffs)
• wp-includes/class-wp-session-tokens.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (4 diffs)
• wp-includes/sitemaps/providers/class-wp-sitemaps-users.php (modified) (1 diff)
• wp-includes/user.php (modified) (2 diffs)

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

@@ -170 +170 @@
          *
          * @param string $user_login The username.
-         * @param string $pass1     The password (passed by reference).
-         * @param string $pass2     The confirmed password (passed by reference).
+         * @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 ) );
@@ -718 +718 @@
          *
          * @param string[] $bad_protocols Array of invalid protocols.
-         * @param string   $url The redirect URL to be validated.
+         * @param string   $url           The redirect URL to be validated.
          */
         $invalid_protocols = apply_filters( 'wp_authorize_application_redirect_url_invalid_protocols', $bad_protocols, $url );

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

@@ -932 +932 @@
                                          * @since 2.8.0
                                          *
-                                         * @param bool    $enable      Whether to display the capabilities. Default true.
+                                         * @param bool    $enable       Whether to display the capabilities. Default true.
                                          * @param WP_User $profile_user The current WP_User object.
                                          */

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

@@ -155 +155 @@
                          * @since 5.6.0
                          *
-                         * @param array $new_user_email {
+                         * @param array  $new_user_email {
                          *     Used to build wp_mail().
                          *
@@ -163 +163 @@
                          *     @type string $headers Headers.
                          * }
-                         * @param int    $user_id     The invited user's ID.
-                         * @param array  $role        Array containing role information for the invited user.
-                         * @param string $newuser_key The key of the invitation.
+                         * @param int    $user_id        The invited user's ID.
+                         * @param array  $role           Array containing role information for the invited user.
+                         * @param string $newuser_key    The key of the invitation.
                          *
                          */

trunk/src/wp-includes/class-wp-session-tokens.php

@@ -155 +155 @@
          * @since 4.0.0
          *
-         * @param string $token Session token to update.
+         * @param string $token   Session token to update.
          * @param array  $session Session information.
          */

trunk/src/wp-includes/ms-functions.php

@@ -1852 +1852 @@
          * @since 5.6.0
          *
-         * @param array $new_site_email {
+         * @param array   $new_site_email {
          *     Used to build wp_mail().
          *
@@ -1860 +1860 @@
          *     @type string $headers Headers.
          * }
-         * @param WP_Site $site         Site object of the new site.
-         * @param WP_User $user         User object of the administrator of the new site.
+         * @param WP_Site $site           Site object of the new site.
+         * @param WP_User $user           User object of the administrator of the new site.
          */
         $new_site_email = apply_filters( 'new_site_email', $new_site_email, $site, $user );
@@ -2941 +2941 @@
          * @since 4.9.0
          *
-         * @param array $email_change_email {
+         * @param array  $email_change_email {
          *     Used to build wp_mail().
          *
@@ -2954 +2954 @@
          *     @type string $headers Headers.
          * }
-         * @param string $old_email  The old network admin email address.
-         * @param string $new_email  The new network admin email address.
-         * @param int    $network_id ID of the network.
+         * @param string $old_email          The old network admin email address.
+         * @param string $new_email          The new network admin email address.
+         * @param int    $network_id         ID of the network.
          */
         $email_change_email = apply_filters( 'network_admin_email_change_email', $email_change_email, $old_email, $new_email, $network_id );

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php

@@ -47 +47 @@
                  *
                  * @param array[]|null $url_list The URL list. Default null.
-                 * @param int        $page_num Page of results.
+                 * @param int          $page_num Page of results.
                  */
                 $url_list = apply_filters(

trunk/src/wp-includes/user.php

@@ -2599 +2599 @@
          * @since 5.8.0 The `$userdata` parameter was added.
          *
-         * @param array $meta {
+         * @param array   $meta {
          *     Default meta values and keys for the user.
          *
@@ -3462 +3462 @@
          * @since 6.0.0
          *
-         * @param array $defaults {
+         * @param array   $defaults {
          *     The default notification email arguments. Used to build wp_mail().
          *