unserialize
unserialize takes a single serialized variable and converts it back into a PHP value.
Warning:
Do not pass untrusted user input to unserialize regardless of the options value of allowed_classes. Unserialization can result in code being loaded and executed due to object instantiation and autoloading, and a malicious user may be able to exploit this. Use a safe, standard data interchange format such as JSON (via json_decode and json_encode) if you need to pass serialized data to the user.
If you need to unserialize externally-stored serialized data, consider using hash_hmac for data validation. Make sure data is not modified by anyone but you.
Parameters
- data
-
The serialized string.
If the variable being unserialized is an object, after successfully reconstructing the object PHP will automatically attempt to call the __unserialize() or __wakeup() methods (if one exists).
Note:
unserialize_callback_func directiveIt's possible to set a callback-function which will be called, if an undefined class should be instantiated during unserializing. (to prevent getting an incomplete object "__PHP_Incomplete_Class".) Use your php.ini, ini_set or .htaccess to define unserialize_callback_func. Everytime an undefined class should be instantiated, it'll be called. To disable this feature just empty this setting.
- options
-
Any options to be provided to unserialize, as an associative array.
Valid options
Name Type Description allowed_classes mixed Either an array of class names which should be accepted, false to accept no classes, or true to accept all classes. If this option is defined and unserialize encounters an object of a class that isn't to be accepted, then the object will be instantiated as __PHP_Incomplete_Class instead.
Omitting this option is the same as defining it as true: PHP will attempt to instantiate objects of any class.
Return Values
The converted value is returned, and can be a bool, int, float, string, array or object.
In case the passed string is not unserializeable, false is returned and E_NOTICE is issued.
Exceptions and Errors
Objects may throw Throwables in their unserialization handlers.
Notes
Warning:
false is returned both in the case of an error and if unserializing the serialized false value. It is possible to catch this special case by comparing data with serialize(false) or by catching the issued E_NOTICE.
Changelog
| Version | Description |
| 7.1.0 | The allowed_classes element of options) is now strictly typed, i.e. if anything other than an array or a bool is given, unserialize returns false and issues an E_WARNING. |