Changeset 46596 for trunk/src/wp-includes/pluggable.php

Timestamp:

10/26/2019 09:07:10 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Switch more docs over to typed array notation, plus some fixes.

See #48303, #41756

File:

• trunk/src/wp-includes/pluggable.php (modified) (8 diffs)

trunk/src/wp-includes/pluggable.php

@@ -636 +636 @@
              * @since 2.7.0
              *
-             * @param array $cookie_elements An array of data for the authentication cookie.
+             * @param string[] $cookie_elements An array of data for the authentication cookie.
              */
             do_action( 'auth_cookie_expired', $cookie_elements );
@@ -649 +649 @@
              * @since 2.7.0
              *
-             * @param array $cookie_elements An array of data for the authentication cookie.
+             * @param string[] $cookie_elements An array of data for the authentication cookie.
              */
             do_action( 'auth_cookie_bad_username', $cookie_elements );
@@ -669 +669 @@
              * @since 2.7.0
              *
-             * @param array $cookie_elements An array of data for the authentication cookie.
+             * @param string[] $cookie_elements An array of data for the authentication cookie.
              */
             do_action( 'auth_cookie_bad_hash', $cookie_elements );
@@ -691 +691 @@
          * @since 2.7.0
          *
-         * @param array   $cookie_elements An array of data for the authentication cookie.
-         * @param WP_User $user            User object.
+         * @param string[] $cookie_elements An array of data for the authentication cookie.
+         * @param WP_User  $user            User object.
          */
         do_action( 'auth_cookie_valid', $cookie_elements, $user );
@@ -759 +759 @@
      * @param string $cookie Authentication cookie.
      * @param string $scheme Optional. The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.
-     * @return array|false Authentication cookie components.
+     * @return string[]|false Authentication cookie components.
      */
     function wp_parse_auth_cookie( $cookie = '', $scheme = '' ) {
@@ -1443 +1443 @@
          * @since 2.3.0
          *
-         * @param array       $hosts An array of allowed hosts.
-         * @param bool|string $host  The parsed host; empty if not isset.
+         * @param string[] $hosts An array of allowed host names.
+         * @param string   $host  The host name of the redirect destination; empty string if not set.
          */
         $allowed_hosts = (array) apply_filters( 'allowed_redirect_hosts', array( $wpp['host'] ), isset( $lp['host'] ) ? $lp['host'] : '' );
@@ -1493 +1493 @@
          * @since 3.7.0
          *
-         * @param array $emails     An array of email addresses to receive a comment notification.
-         * @param int   $comment_id The comment ID.
+         * @param string[] $emails     An array of email addresses to receive a comment notification.
+         * @param int      $comment_id The comment ID.
          */
         $emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
@@ -1805 +1805 @@
          * @since 3.7.0
          *
-         * @param array $emails     List of email addresses to notify for comment moderation.
-         * @param int   $comment_id Comment ID.
+         * @param string[] $emails     List of email addresses to notify for comment moderation.
+         * @param int      $comment_id Comment ID.
          */
         $emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );