sanitize_user │ filter-hook │ WP 2.0.1

Filters a sanitized username string.

Usage

add_filter( 'sanitize_user', 'wp_kama_sanitize_user_filter', 10, 3 );

/**
 * Function for `sanitize_user` filter-hook.
 * 
 * @param string $username     Sanitized username.
 * @param string $raw_username The username prior to sanitization.
 * @param bool   $strict       Whether to limit the sanitization to specific characters.
 *
 * @return string
 */
function wp_kama_sanitize_user_filter( $username, $raw_username, $strict ){

	// filter...
	return $username;
}

$username(string)

Sanitized username.

$raw_username(string)

The username prior to sanitization.

$strict(true|false)

Whether to limit the sanitization to specific characters.

Changelog

Where the hook is called

return apply_filters( 'sanitize_user', $username, $raw_username, $strict );

Where the hook is used in WordPress

add_filter( 'sanitize_user', 'strtolower' );