Zend: Deprecate __sleep() #19682

Girgias · 2025-09-03T11:45:34Z

RFC: https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_the_sleep_and_wakeup_magic_methods

Split from #19435 as __sleep() has an extremely easy migration path.

Zend/zend_compile.c

nielsdos

Looks trivial

nielsdos · 2025-09-03T20:58:54Z

Zend/zend_compile.c

 	}

+	if (ce->__serialize == NULL && zend_hash_exists(&ce->function_table, ZSTR_KNOWN(ZEND_STR_SLEEP))) {
+		zend_error(E_DEPRECATED, "The __sleep() serialization hook has been deprecated."


Is this called a hook? I thought it was just a magic method. Hook may be confusing wrt property hooks.
Although docs say on one particular page:

Beyond the above advice, note that you can also hook into the serialization and unserialization events on an object using the __sleep() and __wakeup() methods.

I guess using magic method is less ambiguous. But I did use "hook" because it hooks into the serialization process.

bukka · 2025-09-03T21:36:37Z

Deprecating __sleep and keeping __wakeup seems kind of wierd and not what was voted on. I think this should be re-considered. But will leave it to RM to decide it.

DanielEScherzer

Deprecating __sleep and keeping __wakeup seems kind of wierd and not what was voted on. I think this should be re-considered. But will leave it to RM to decide it.

So I'm a little torn. On the one hand, if the plan is still to deprecate __wakeup and it is just the implementation that is being split up, then it would be fine and I would just want to make sure that the implementation is also done in 8.5 since those two methods go together.

If the __wakeup part is not ready yet, then it might be worth delaying the __sleep part so that they are merged together (same PHP version). We have precedent (from yours truly) for implementing deprecations after the version they targeted (8.4 deprecations for output handlers were done in 8.5).

On the other hand, if __wakeup is not planned, then this is clearly something that was not voted on - the vote for deprecation was 18-9, so if even one of those 18 would have objected to deprecating __sleep without also deprecating __wakeup then the proposal would have failed. I can see an argument that keeping __wakeup allows deserialization of objects serialized with the old method, while deprecating __sleep means that there wouldn't be new objects serialized with the old method, but still, I would expect that at least someone would have objected.

So, I guess the question is, are you planning to also deprecate __wakeup in this release?

DanielEScherzer · 2025-09-03T21:44:01Z

Zend/zend_compile.c

+	if (ce->__serialize == NULL && zend_hash_exists(&ce->function_table, ZSTR_KNOWN(ZEND_STR_SLEEP))) {
+		zend_error(E_DEPRECATED, "The __sleep() serialization magic method has been deprecated."
+			" Implement __serialize() instead (or in addition, if support for old PHP versions is necessary)");
+	}


can you add a test for what happens if the deprecation is turned into an exception?

Girgias · 2025-09-03T22:04:18Z

There has not been a counter RFC for "undeprecating" __sleep() or __wakeup() so as far as I am concerned both should still be deprecated. I am willing to make a concession to postpone the __wakeup() deprecation to a future version so that Symfony doesn't need to deal with for Symfony 7 as this is a non issue for Symfony 8 as it uses __serialize() and __unserialize().

Considering the analysis from @theodorejb (and the results I have from Damien) shows that the main project being impacted is SF and, from what I understand, the problem is with __wakeup(); I don't see why __sleep() should be postponed. But if it needs to be an all or nothing, then what was voted on was to deprecate both of them, not none of them.

DanielEScherzer · 2025-09-08T17:31:49Z

There has not been a counter RFC for "undeprecating" __sleep() or __wakeup() so as far as I am concerned both should still be deprecated. I am willing to make a concession to postpone the __wakeup() deprecation to a future version so that Symfony doesn't need to deal with for Symfony 7 as this is a non issue for Symfony 8 as it uses __serialize() and __unserialize().

Considering the analysis from @theodorejb (and the results I have from Damien) shows that the main project being impacted is SF and, from what I understand, the problem is with __wakeup(); I don't see why __sleep() should be postponed. But if it needs to be an all or nothing, then what was voted on was to deprecate both of them, not none of them.

Please see https://news-web.php.net/php.internals/128659 for the RMs' position, __sleep() and __wakeup() should both be deprecated before RC1

Girgias · 2025-09-08T20:39:56Z

Please see https://news-web.php.net/php.internals/128659 for the RMs' position, __sleep() and __wakeup() should both be deprecated before RC1

I would like to merge this and then rebase the other PR on top of it with the new wording. Can I do so?

ext/standard/tests/serialize/sleep_deprecation_promoted_exception.phpt

DanielEScherzer · 2025-09-08T21:30:37Z

ext/standard/tests/serialize/sleep_deprecation_promoted_exception.phpt

+
+?>
+--EXPECTF--
+Deprecated: The __sleep() serialization magic method has been deprecated. Implement __serialize() instead (or in addition, if support for old PHP versions is necessary) in %s on line %d


there isn't an error about an uncaught exception, so is this actually testing the promotion from deprecation to exception?

I don't understand why the deprecation is not being promoted, maybe @arnaud-lb or @nielsdos know why.

I suspect that the class definition is being “hoisted” since it is unconditionally defined. Try wrapping the class into an if (random_int(1, 1)) or defining it via eval().

Right... early binding...

RFC: https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_the_sleep_and_wakeup_magic_methods

DanielEScherzer

RM approval with the understanding that #19435 will be updated and merged shortly thereafter, i.e. both __sleep() and __wakeup() will get deprecated and the patches are just split up to simplify things

This reverts commit f18e992.

Girgias requested review from a team and TimWolla September 3, 2025 11:45

TimWolla approved these changes Sep 3, 2025

View reviewed changes

Zend/zend_compile.c Outdated Show resolved Hide resolved

github-actions bot added Category: Engine Extension: dom Extension: pdo_mysql Extension: phar Extension: session Extension: standard labels Sep 3, 2025

Girgias force-pushed the 8.5-dep-just-sleep branch from adadb0d to a4e917e Compare September 3, 2025 19:32

Girgias marked this pull request as ready for review September 3, 2025 20:56

Girgias requested review from bukka, kamil-tekiela, SakiTakamachi and nielsdos as code owners September 3, 2025 20:56

nielsdos approved these changes Sep 3, 2025

View reviewed changes

DanielEScherzer requested changes Sep 3, 2025

View reviewed changes

Girgias force-pushed the 8.5-dep-just-sleep branch from cd1facc to d9a0b65 Compare September 8, 2025 20:59

DanielEScherzer reviewed Sep 8, 2025

View reviewed changes

Zend: Deprecate __sleep()

c240b29

RFC: https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_the_sleep_and_wakeup_magic_methods

Girgias force-pushed the 8.5-dep-just-sleep branch from d76578f to c240b29 Compare September 9, 2025 09:08

Girgias requested a review from DanielEScherzer September 9, 2025 09:27

TimWolla approved these changes Sep 9, 2025

View reviewed changes

DanielEScherzer approved these changes Sep 9, 2025

View reviewed changes

Girgias merged commit f18e992 into php:master Sep 10, 2025
9 checks passed

Girgias deleted the 8.5-dep-just-sleep branch September 10, 2025 07:54

ddevsr mentioned this pull request Sep 10, 2025

Add rector to migrate __sleep() to __serialize() rectorphp/rector-src#7212

Merged

DanielEScherzer mentioned this pull request Sep 9, 2025

[Tracking] Pending PHP 8.5 deprecations #19468

Closed

17 tasks

nicolas-grekas added a commit to nicolas-grekas/php-src that referenced this pull request Sep 25, 2025

Revert "Zend: Deprecate __sleep() (php#19682)"

76068e7

This reverts commit f18e992.

nicolas-grekas mentioned this pull request Sep 25, 2025

Revert deprecation of __sleep and __wakeup #19966

Open

nicolas-grekas added a commit to nicolas-grekas/php-src that referenced this pull request Sep 25, 2025

Revert "Zend: Deprecate __sleep() (php#19682)"

30913e3

This reverts commit f18e992.

nicolas-grekas added a commit to nicolas-grekas/php-src that referenced this pull request Sep 25, 2025

Revert "Zend: Deprecate __sleep() (php#19682)"

6f3c8f2

This reverts commit f18e992.

nicolas-grekas added a commit to nicolas-grekas/php-src that referenced this pull request Sep 26, 2025

Revert "Zend: Deprecate __sleep() (php#19682)"

8c39511

This reverts commit f18e992.

nicolas-grekas added a commit to nicolas-grekas/php-src that referenced this pull request Sep 30, 2025

Revert "Zend: Deprecate __sleep() (php#19682)"

9e94aaa

This reverts commit f18e992.

Zend: Deprecate __sleep() #19682

Zend: Deprecate __sleep() #19682

Uh oh!

Conversation

Girgias commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

nielsdos left a comment

Choose a reason for hiding this comment

Uh oh!

nielsdos Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Girgias Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

bukka commented Sep 3, 2025

Uh oh!

DanielEScherzer left a comment

Choose a reason for hiding this comment

Uh oh!

DanielEScherzer Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Girgias commented Sep 3, 2025

Uh oh!

DanielEScherzer commented Sep 8, 2025

Uh oh!

Girgias commented Sep 8, 2025

Uh oh!

Uh oh!

DanielEScherzer Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

Girgias Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

TimWolla Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

Girgias Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

DanielEScherzer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Girgias commented Sep 3, 2025 •

edited

Loading