wp_pre_insert_user_data
Filters user data before the record is created or updated.
It only includes data in the users table, not any user metadata.
Usage
add_filter( 'wp_pre_insert_user_data', 'wp_kama_pre_insert_user_data_filter', 10, 4 ); /** * Function for `wp_pre_insert_user_data` filter-hook. * * @param array $data Values and keys for the user. * @param bool $update Whether the user is being updated rather than created. * @param int|null $user_id ID of the user to be updated, or NULL if the user is being created. * @param array $userdata The raw array of data passed to wp_insert_user(). * * @return array */ function wp_kama_pre_insert_user_data_filter( $data, $update, $user_id, $userdata ){ // filter... return $data; }
- $data(array)
Values and keys for the user.
-
user_login(string)
The user's login. Only included if $update == false -
user_pass(string)
The user's password. -
user_email(string)
The user's email. -
user_url(string)
The user's url. -
user_nicename(string)
The user's nice name. Defaults to a URL-safe version of user's login -
display_name(string)
The user's display name. - user_registered(string)
MySQL timestamp describing the moment when the user registered.
Default: current UTC timestamp
-
- $update(true|false)
- Whether the user is being updated rather than created.
- $user_id(int|null)
- ID of the user to be updated, or NULL if the user is being created.
- $userdata(array)
- The raw array of data passed to wp_insert_user().
Changelog
Since 4.9.0 | Introduced. |
Since 5.8.0 | The $userdata parameter was added. |
Where the hook is called
wp_pre_insert_user_data
wp-includes/user.php 2398
$data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? $user_id : null ), $userdata );