Changeset 41208

Timestamp:

08/02/2017 08:03:29 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve the documentation for the update_option_new_admin_email() function and the new_admin_email_content filter.

See #41017

File:

• trunk/src/wp-admin/includes/ms.php (modified) (3 diffs)

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

@@ -267 +267 @@
 
 /**
- * Sends an email when a site administrator email address is changed.
- *
- * @since 3.0.0
- *
- * @param string $old_value The old email address. Not currently used.
- * @param string $value     The new email address.
+ * Send a confirmation request email when a change of site admin email address is attempted.
+ *
+ * The new site admin address will not become active until confirmed.
+ *
+ * @since 3.0.0
+ *
+ * @param string $old_value The old site admin email address.
+ * @param string $value     The proposed new site admin email address.
  */
 function update_option_new_admin_email( $old_value, $value ) {
@@ -306 +308 @@
 
     /**
-     * Filters the email text sent when the site admin email is changed.
+     * Filters the text of the email sent when a change of site admin email address is attempted.
      *
      * The following strings have a special meaning and will get replaced dynamically:
      * ###USERNAME###  The current user's username.
      * ###ADMIN_URL### The link to click on to confirm the email change.
-     * ###EMAIL###     The new email.
+     * ###EMAIL###     The proposed new site admin email address.
      * ###SITENAME###  The name of the site.
      * ###SITEURL###   The URL to the site.
@@ -318 +320 @@
      *
      * @param string $email_text      Text in the email.
-     * @param string $new_admin_email New admin email that the current administration email was changed to.
+     * @param array  $new_admin_email {
+     *     Data relating to the new site admin email address.
+     *
+     *     @type string $hash     The secure hash used in the confirmation link URL.
+     *     @type string $newemail The proposed new site admin email address.
+     * }
      */
     $content = apply_filters( 'new_admin_email_content', $email_text, $new_admin_email );