sanitize_user_object() │ WP 2.3.0

Deprecated from version 3.3.0. It is no longer supported and can be removed in future releases. It is recommended to replace this function with the same one.

Sanitize every user field.

If the context is 'raw', then the user object or array will get minimal sanitization of the int fields.

No Hooks.

Return

Object|Array. The now sanitized user object or array (will be the same type as $user).

Usage

sanitize_user_object( $user, $context );
$user(object|array) (required)
The user object or array.
$context(string)
How to sanitize user fields.
Default: 'display'

Changelog

Since 2.3.0 Introduced.
Deprecated since 3.3.0

sanitize_user_object() code WP 6.7.1

wp-includes/deprecated.php 
function sanitize_user_object($user, $context = 'display') {
	_deprecated_function( __FUNCTION__, '3.3.0' );

	if ( is_object($user) ) {
		if ( !isset($user->ID) )
			$user->ID = 0;
		if ( ! ( $user instanceof WP_User ) ) {
			$vars = get_object_vars($user);
			foreach ( array_keys($vars) as $field ) {
				if ( is_string($user->$field) || is_numeric($user->$field) )
					$user->$field = sanitize_user_field($field, $user->$field, $user->ID, $context);
			}
		}
		$user->filter = $context;
	} else {
		if ( !isset($user['ID']) )
			$user['ID'] = 0;
		foreach ( array_keys($user) as $field )
			$user[$field] = sanitize_user_field($field, $user[$field], $user['ID'], $context);
		$user['filter'] = $context;
	}

	return $user;
}