W3cubDocs

/WordPress

sanitize_user_object( object|array $user, string $context = 'display' )

This function has been deprecated.

Sanitize every user field.

Description

If the context is ‘raw’, then the user object or array will get minimal santization of the int fields.

Parameters

$user

(object|array) (Required) The user object or array.

$context

(string) (Optional) How to sanitize user fields.

Default value: 'display'

Return

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

Source

File: 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;
}

Uses

Uses Description
wp-includes/functions.php: _deprecated_function()

Mark a function as deprecated and inform when it has been used.
wp-includes/user.php: sanitize_user_field()

Sanitize user field based on context.

Changelog

Version Description
3.3.0 This function has been deprecated.
2.3.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/sanitize_user_object