signup_user_meta │ filter-hook │ WP 4.8.0

Filters the metadata for a user signup.

The metadata will be serialized prior to storing it in the database.

Usage

add_filter( 'signup_user_meta', 'wp_kama_signup_user_meta_filter', 10, 4 );

/**
 * Function for `signup_user_meta` filter-hook.
 * 
 * @param array  $meta       Signup meta data.
 * @param string $user       The user's requested login name.
 * @param string $user_email The user's email address.
 * @param string $key        The user's activation key.
 *
 * @return array
 */
function wp_kama_signup_user_meta_filter( $meta, $user, $user_email, $key ){

	// filter...
	return $meta;
}

$meta(array)

Signup meta data.
Default: empty array

$user(string)

The user's requested login name.

$user_email(string)

The user's email address.

$key(string)

The user's activation key.

Changelog

Where the hook is called

$meta = apply_filters( 'signup_user_meta', $meta, $user, $user_email, $key );

Where the hook is used in WordPress