site_option_welcome_user_email

The WordPress Core site option welcome user email hook.

Description

add_filter( 'site_option_welcome_user_email', (string) $welcome_user_msg_filter ); 

Parameters (1)

0. $welcome_user_msg_filter (string) => 'welcome_user_msg_filter'

The welcome user msg filter.

Usage

To run the hook, copy the example below.

$welcome_user_msg_filter = apply_filters( 'site_option_welcome_user_email', $welcome_user_msg_filter ); 
                         
if ( !empty( $welcome_user_msg_filter ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the site_option_welcome_user_email callback 
function filter_site_option_welcome_user_email( $welcome_user_msg_filter ) { 
    // make filter magic happen here... 
    return $welcome_user_msg_filter; 
}; 
         
// add the filter 
add_filter( 'site_option_welcome_user_email', 'filter_site_option_welcome_user_email', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'site_option_welcome_user_email', 'filter_site_option_welcome_user_email', 10, 1 );