Filter hook 'wpmu_welcome_user_notification'

in WP Core File wp-includes/ms-functions.php at line 1897

View Source

wpmu_welcome_user_notification

Filter Hook
Description
Filters whether to bypass the welcome email after user activation. Returning false disables the welcome email.

Hook Information

File Location wp-includes/ms-functions.php View on GitHub
Hook Type Filter
Line Number 1897

Hook Parameters

Type Name Description
int $user_id User ID.
string $password User password.
array $meta Signup meta data. Default empty array.

Usage Examples

Basic Usage
<?php
// Hook into wpmu_welcome_user_notification
add_filter('wpmu_welcome_user_notification', 'my_custom_filter', 10, 3);

function my_custom_filter($user_id, $password, $meta) {
    // Your custom filtering logic here
    return $user_id;
}

Source Code Context

wp-includes/ms-functions.php:1897 - How this hook is used in WordPress core
<?php
1892  	 *
1893  	 * @param int    $user_id  User ID.
1894  	 * @param string $password User password.
1895  	 * @param array  $meta     Signup meta data. Default empty array.
1896  	 */
1897  	if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) ) {
1898  		return false;
1899  	}
1900  
1901  	$welcome_email = get_site_option( 'welcome_user_email' );
1902  

PHP Documentation

<?php
/**
	 * Filters whether to bypass the welcome email after user activation.
	 *
	 * Returning false disables the welcome email.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param int    $user_id  User ID.
	 * @param string $password User password.
	 * @param array  $meta     Signup meta data. Default empty array.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 3
  • File: wp-includes/ms-functions.php
Related Hooks

Related hooks will be displayed here in future updates.