Changeset 46662 for trunk/src/wp-admin/includes/upgrade.php

Timestamp:

11/05/2019 09:28:51 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Docs on docs. Further improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (1 diff)

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

@@ -36 +36 @@
      * @param string $user_password Optional. User's chosen password. Default empty (random password).
      * @param string $language      Optional. Language chosen. Default empty.
-     * @return array Array keys 'url', 'user_id', 'password', and 'password_message'.
+     * @return array {
+     *     Data for the newly installed site.
+     *
+     *     @type string $url              The URL of the site.
+     *     @type int    $user_id          The ID of the site owner.
+     *     @type string $password         The password of the site owner, if their user account didn't already exist.
+     *     @type string $password_message The explanatory message regarding the password.
+     * }
      */
     function wp_install( $blog_title, $user_name, $user_email, $public, $deprecated = '', $user_password = '', $language = '' ) {