Code Modernization: Address __sleep() and __wakeup() deprecations in PHP 8.5.

PHP 8.5 deprecates the `__sleep()` and `__wakeup()` magic methods in favor of `__serialize()` and `__unserialize()`:
> `Deprecated:  The __wakeup() serialization magic method has been deprecated. Implement __unserialize() instead (or in addition, if support for old PHP versions is necessary)`

For PHP < 7.4 compatibility, `__sleep()` and `__wakeup()` need to be kept for the time being.

This commit moves the logic of `__wakeup()` methods in core to `__unserialize()`, and turns the former into wrappers. WordPress core does not use `__sleep()` methods, so these are the only changes required.

Reference: [https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_the_sleep_and_wakeup_magic_methods PHP RFC: Deprecations for PHP 8.5: Deprecate the __sleep() and __wakeup() magic methods].

Follow-up to [56835], [60787], [60795].

Props TobiasBg, tusharbharti, swissspidy, dmsnell, SergeyBiryukov.
Fixes #63962. See #63061.

git-svn-id: https://develop.svn.wordpress.org/trunk@60796 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

src/wp-includes/class-wp-block-bindings-registry.php

@@ -257,11 +257,13 @@ public function is_registered( $source_name ) {
 	}
 
 	/**
-	 * Wakeup magic method.
+	 * Unserialize magic method.
 	 *
-	 * @since 6.5.0
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
 	 */
-	public function __wakeup() {
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
 		if ( ! $this->sources ) {
 			return;
 		}
@@ -275,6 +277,15 @@ public function __wakeup() {
 		}
 	}
 
+	/**
+	 * Wakeup magic method.
+	 *
+	 * @since 6.5.0
+	 */
+	public function __wakeup() {
+		$this->__unserialize( array() );
+	}
+
 	/**
 	 * Utility method to retrieve the main instance of the class.
 	 *

src/wp-includes/class-wp-block-bindings-source.php

@@ -98,12 +98,23 @@ public function get_value( array $source_args, $block_instance, string $attribut
 		return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
 	}
 
+	/**
+	 * Unserialize magic method.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
+	 */
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
+		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+	}
+
 	/**
 	 * Wakeup magic method.
 	 *
 	 * @since 6.5.0
 	 */
 	public function __wakeup() {
-		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+		$this->__unserialize( array() );
 	}
 }

src/wp-includes/class-wp-block-patterns-registry.php

@@ -245,7 +245,14 @@ public function is_registered( $pattern_name ) {
 		return isset( $this->registered_patterns[ $pattern_name ] );
 	}
 
-	public function __wakeup() {
+	/**
+	 * Unserialize magic method.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
+	 */
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
 		if ( ! $this->registered_patterns ) {
 			return;
 		}
@@ -260,6 +267,15 @@ public function __wakeup() {
 		$this->registered_patterns_outside_init = array();
 	}
 
+	/**
+	 * Wakeup magic method.
+	 *
+	 * @since 6.4.0
+	 */
+	public function __wakeup() {
+		$this->__unserialize( array() );
+	}
+
 	/**
 	 * Utility method to retrieve the main instance of the class.
 	 *

src/wp-includes/class-wp-block-type-registry.php

@@ -168,7 +168,14 @@ public function is_registered( $name ) {
 		return isset( $this->registered_block_types[ $name ] );
 	}
 
-	public function __wakeup() {
+	/**
+	 * Unserialize magic method.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
+	 */
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
 		if ( ! $this->registered_block_types ) {
 			return;
 		}
@@ -182,6 +189,15 @@ public function __wakeup() {
 		}
 	}
 
+	/**
+	 * Wakeup magic method.
+	 *
+	 * @since 6.4.0
+	 */
+	public function __wakeup() {
+		$this->__unserialize( array() );
+	}
+
 	/**
 	 * Utility method to retrieve the main instance of the class.
 	 *

src/wp-includes/class-wp-theme.php

@@ -783,8 +783,12 @@ public function parent() {
 	 * Perform reinitialization tasks.
 	 *
 	 * Prevents a callback from being injected during unserialization of an object.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
 	 */
-	public function __wakeup() {
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
 		if ( $this->parent && ! $this->parent instanceof self ) {
 			throw new UnexpectedValueException();
 		}
@@ -799,6 +803,15 @@ public function __wakeup() {
 		$this->headers_sanitized = array();
 	}
 
+	/**
+	 * Wakeup magic method.
+	 *
+	 * @since 6.4.0
+	 */
+	public function __wakeup() {
+		$this->__unserialize( array() );
+	}
+
 	/**
 	 * Adds theme data to cache.
 	 *

src/wp-includes/html-api/class-wp-html-open-elements.php

@@ -841,12 +841,23 @@ public function clear_to_table_row_context(): void {
 		}
 	}
 
+	/**
+	 * Unserialize magic method.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
+	 */
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
+		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+	}
+
 	/**
 	 * Wakeup magic method.
 	 *
 	 * @since 6.6.0
 	 */
 	public function __wakeup() {
-		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+		$this->__unserialize( array() );
 	}
 }

src/wp-includes/html-api/class-wp-html-token.php

@@ -115,12 +115,23 @@ public function __destruct() {
 		}
 	}
 
+	/**
+	 * Unserialize magic method.
+	 *
+	 * @since 6.9.0
+	 *
+	 * @param array $data Data to unserialize.
+	 */
+	public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
+		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+	}
+
 	/**
 	 * Wakeup magic method.
 	 *
 	 * @since 6.4.2
 	 */
 	public function __wakeup() {
-		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
+		$this->__unserialize( array() );
 	}
 }