Changeset 33664

Timestamp:

08/20/2015 06:26:00 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Mark the $notify parameter in the DocBlock for wp_new_user_notification() as optional, and provide additional context on the difference between the accepted values.

See [33620] and [33023] for background.

See #32246.

File:

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

trunk/src/wp-includes/pluggable.php

@@ -1692 +1692 @@
  *
  * @param int    $user_id User ID.
- * @param string $notify  Whether admin and user should be notified ('both') or
- *                        only the admin ('admin' or empty).
+ * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin' or an empty
+ *                        string (admin only), or 'both' (admin and user). The empty string value was kept
+ *                        for backward-compatibility purposes with the renamed parameter. Default empty.
  */
 function wp_new_user_notification( $user_id, $notify = '' ) {