sanitize_user_object( object|array $user, string $context = ‘display’ ): object|array

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

$userobject|arrayrequired
The user object or array.
$contextstringoptional
How to sanitize user fields. Default 'display'.

Default:'display'

Return

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

Source

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

Changelog

VersionDescription
3.3.0This function has been deprecated.
2.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.