Changeset 55732 for trunk/src/wp-includes/class-wp-application-passwords.php

Timestamp:

05/08/2023 10:35:38 PM (21 months ago)

Author:

johnbillion

Message:

Docs: A host of corrections and improvements to inline documentation.

See #57840

File:

• trunk/src/wp-includes/class-wp-application-passwords.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-application-passwords.php

@@ -69 +69 @@
      *     @type string $app_id A UUID provided by the application to uniquely identify it.
      * }
-     * @return array|WP_Error The first key in the array is the new password, the second is its detailed information.
-     *                        A WP_Error instance is returned on error.
+     * @return array|WP_Error {
+     *     Application password details, or a WP_Error instance if an error occurs.
+     *
+     *     @type string $0 The unhashed generated application password.
+     *     @type array  $1 {
+     *         The details about the created password.
+     *
+     *         @type string $uuid      The unique identifier for the application password.
+     *         @type string $app_id    A UUID provided by the application to uniquely identify it.
+     *         @type string $name      The name of the application password.
+     *         @type string $password  A one-way hash of the password.
+     *         @type int    $created   Unix timestamp of when the password was created.
+     *         @type null   $last_used Null.
+     *         @type null   $last_ip   Null.
+     *     }
+     * }
      */
     public static function create_new_application_password( $user_id, $args = array() ) {