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
This commit is contained in:
Drew Jaynes 2015-08-20 18:26:00 +00:00
parent 25004acaa6
commit ad2afcd0d9

View File

@ -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;