Skip to content

Commit 17fb931

Browse files
Code Modernization: Fix "JsonSerializable_Object::jsonSerialize() should be compatible with JsonSerializable::jsonSerialize(): mixed" error on PHP 8.1.
This relates to the [https://wiki.php.net/rfc/internal_method_return_types Return types for internal methods RFC] in PHP 8.1 and in particular, the change made in [php/php-src#7051 PHP PR #7051], which adds a `mixed` return type to the `JsonSerializable::jsonSerialize()` interface method. WordPress only contains one (test) class which implements the `JsonSerializable` interface and this commit fixes the issue for that class. As of PHP 8.1, the `jsonSerialize()` method in classes which implement the `JsonSerializable` interface are expected to have a return type declared. The return type should be `mixed` or a more specific type. This complies with the Liskov principle of covariance, which allows the return type of a child overloaded method to be more specific than that of the parent. The problem with this is that: 1. The `mixed` return type was only introduced in PHP 8.0. 2. Return types in general were only introduced in PHP 7.0. WordPress still has a minimum PHP version of 5.6, so adding the return type is not feasible for the time being. The solution chosen for now is to add an attribute to silence the deprecation warning. While attributes are a PHP 8.0+ feature, due to the choice of the `#[]` syntax, in PHP < 8.0, attributes will just be ignored and treated as comments, so there is no drawback to using the attribute. Props jrf. See #53635. git-svn-id: https://develop.svn.wordpress.org/trunk@51517 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 108d4d1 commit 17fb931

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

tests/phpunit/includes/class-jsonserializable-object.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ public function __construct( $data ) {
1515
$this->data = $data;
1616
}
1717

18+
#[ReturnTypeWillChange]
1819
public function jsonSerialize() {
1920
return $this->data;
2021
}

0 commit comments

Comments
 (0)