insert_user_meta │ filter-hook │ WP 4.4.0

Filters a user's meta values and keys immediately after the user is created or updated and before any user meta is inserted or updated.

Does not include contact methods. These are added using wp_get_user_contact_methods($user).

For custom meta fields, see the insert_custom_user_meta filter.

Usage

add_filter( 'insert_user_meta', 'wp_kama_insert_user_meta_filter', 10, 4 );

/**
 * Function for `insert_user_meta` filter-hook.
 * 
 * @param array   $meta     Default meta values and keys for the user.
 * @param WP_User $user     User object.
 * @param bool    $update   Whether the user is being updated rather than created.
 * @param array   $userdata The raw array of data passed to wp_insert_user().
 *
 * @return array
 */
function wp_kama_insert_user_meta_filter( $meta, $user, $update, $userdata ){

	// filter...
	return $meta;
}

$meta(array)

Default meta values and keys for the user.

• nickname(string)
  The user's nickname.
  Default: user's username

• first_name(string)
  The user's first name.

• last_name(string)
  The user's last name.

• description(string)
  The user's description.

• rich_editing(string)
  Whether to enable the rich-editor for the user.
  Default: 'true'

• syntax_highlighting(string)
  Whether to enable the rich code editor for the user.
  Default: 'true'

• comment_shortcuts(string)
  Whether to enable keyboard shortcuts for the user.
  Default: 'false'

• admin_color(string)
  The color scheme for a user's admin screen.
  Default: 'fresh'

• use_ssl(int|true|false)
  Whether to force SSL on the user's admin area. 0|false if SSL is not forced.

• show_admin_bar_front(string)
  Whether to show the admin bar on the front end for the user.
  Default: 'true'

• locale(string)
  User's locale.
  Default: ''

$user(WP_User)

User object.

$update(true|false)

Whether the user is being updated rather than created.

$userdata(array)

The raw array of data passed to wp_insert_user().

Changelog

Where the hook is called

$meta = apply_filters( 'insert_user_meta', $meta, $user, $update, $userdata );

Where the hook is used in WordPress