signup_user_init
Filters the default user variables used on the user sign-up form.
Usage
add_filter( 'signup_user_init', 'wp_kama_signup_user_init_filter' );
/**
* Function for `signup_user_init` filter-hook.
*
* @param array $signup_user_defaults An array of default user variables.
*
* @return array
*/
function wp_kama_signup_user_init_filter( $signup_user_defaults ){
// filter...
return $signup_user_defaults;
}
- $signup_user_defaults(array)
An array of default user variables.
-
user_name(string)
The user username. -
user_email(string)
The user email address. - errors(WP_Error)
A WP_Error object with possible errors relevant to the sign-up user.
-
Changelog
| Since 3.0.0 | Introduced. |
Where the hook is called
signup_user_init
wp-signup.php 591
$filtered_results = apply_filters( 'signup_user_init', $signup_user_defaults );