apply_filters( ‘wp_pre_insert_user_data’, array $data, bool $update, int|null $user_id, array $userdata )

In this article

Filters user data before the record is created or updated.

Description

It only includes data in the users table, not any user metadata.

Parameters

$dataarray
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. Defaults to the current UTC timestamp.
$updatebool
Whether the user is being updated rather than created.
$user_idint|null
ID of the user to be updated, or NULL if the user is being created.
$userdataarray
The raw array of data passed to wp_insert_user() .
More Arguments from wp_insert_user( … $userdata )An array, object, or WP_User object of user data arguments.
  • ID int
    User ID. If supplied, the user will be updated.
  • user_pass string
    The plain-text user password for new users.
    Hashed password for existing users.
  • user_login string
    The user’s login username.
  • user_nicename string
    The URL-friendly user name.
  • user_url string
    The user URL.
  • user_email string
    The user email address.
  • display_name string
    The user’s display name.
    Default is the user’s username.
  • nickname string
    The user’s nickname.
    Default is the user’s username.
  • first_name string
    The user’s first name. For new users, will be used to build the first part of the user’s display name if $display_name is not specified.
  • last_name string
    The user’s last name. For new users, will be used to build the second part of the user’s display name if $display_name is not specified.
  • description string
    The user’s biographical description.
  • rich_editing string
    Whether to enable the rich-editor for the user.
    Accepts 'true' or 'false' as a string literal, not boolean. Default 'true'.
  • syntax_highlighting string
    Whether to enable the rich code editor for the user.
    Accepts 'true' or 'false' as a string literal, not boolean. Default 'true'.
  • comment_shortcuts string
    Whether to enable comment moderation keyboard shortcuts for the user. Accepts 'true' or 'false' as a string literal, not boolean. Default 'false'.
  • admin_color string
    Admin color scheme for the user. Default 'fresh'.
  • use_ssl bool
    Whether the user should always access the admin over https. Default false.
  • user_registered string
    Date the user registered in UTC. Format is ‘Y-m-d H:i:s’.
  • user_activation_key string
    Password reset key. Default empty.
  • spam bool
    Multisite only. Whether the user is marked as spam.
    Default false.
  • show_admin_bar_front string
    Whether to display the Admin Bar for the user on the site’s front end. Accepts 'true' or 'false' as a string literal, not boolean. Default 'true'.
  • role string
    User’s role.
  • locale string
    User’s locale. Default empty.
  • meta_input array
    Array of custom user meta values keyed by meta key.
    Default empty.

Source

$data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? $user_id : null ), $userdata );

Changelog

VersionDescription
5.8.0The $userdata parameter was added.
4.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.