Changeset 48962

Timestamp:

09/09/2020 03:46:30 PM (4 years ago)

Author:

desrosj

Message:

Docs: Improve the recovery_mode_email inline docs.

See #51267, #50768.

File:

• trunk/src/wp-includes/class-wp-recovery-mode-email-service.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-recovery-mode-email-service.php

@@ -207 +207 @@
          * @since 5.2.0
          *
-         * @param array  $email Used to build wp_mail().
+         * @param array  $email {
+         *     Used to build a call to wp_mail().
+         *
+         *     @type string|array $to      Array or comma-separated list of email addresses to send message.
+         *     @type string       $subject Email subject
+         *     @type string       $message Message contents
+         *     @type string|array $headers Optional. Additional headers.
+         * }
          * @param string $url   URL to enter recovery mode.
          */