From ad2afcd0d9c3b3f9ba9d83124e7d411ab88c1329 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Thu, 20 Aug 2015 18:26:00 +0000
Subject: [PATCH] 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33664 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/pluggable.php | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php
index c4eb8cc566..57be023165 100644
--- a/src/wp-includes/pluggable.php
+++ b/src/wp-includes/pluggable.php
@@ -1691,8 +1691,9 @@ if ( !function_exists('wp_new_user_notification') ) :
  * @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
  *
  * @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 = '' ) {
 	global $wpdb;