This function has been deprecated.
sanitize_user_object( object|array $user, string $context = 'display' )
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
-
(Required) The User Object or Array
- $context
-
(Optional) default is 'display'. 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__, 'WP-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
| Version | Description |
|---|---|
| WP-3.3.0 | This function has been deprecated. |
| WP-2.3.0 | Introduced. This function has been deprecated. |