Changeset 13311

Timestamp:

08/09/2022 06:23:32 PM (2 years ago)

Author:

imath

Message:

Avoid PHP 8.1 ArrayAccess Return Type deprecation notices

The BP_Core_BP_Nav_BackCompat is implementing the ArrayAccess class to provide backward compatibility to BuddyPress plugins directly modifying the buddypress()->bp_nav global since BuddyPress 2.3.

PHP 8.1 added a deprecation notice if a class declaration has an incompatible return type (or if the return type lacks: which is the case for BP_Core_BP_Nav_BackCompat) with the parent it extends.

As BuddyPress supports PHP back to version 5.6, we need to use the #ReturnTypeWillChange attribute to maintain compatibility with this version and avoid the deprecation notice in PHP 8.x.

Fixes #8726

Location:

trunk/src/bp-core

Files:

• bp-core-avatars.php (modified) (1 diff)
• classes/class-bp-core-bp-nav-backcompat.php (modified) (5 diffs)

trunk/src/bp-core/bp-core-avatars.php

@@ -457 +457 @@
     // Use an alias to leave the param unchanged.
     $avatar_classes = $params['class'];
-    if ( ! is_array( $avatar_classes ) ) {
+    if ( is_null( $avatar_classes ) ) {
+        $avatar_classes = array();
+    } elseif ( ! is_array( $avatar_classes ) ) {
         $avatar_classes = explode( ' ', $avatar_classes );
     }

trunk/src/bp-core/classes/class-bp-core-bp-nav-backcompat.php

@@ -61 +61 @@
      * @param array $value  Nav item.
      */
+    #[ReturnTypeWillChange]
     public function offsetSet( $offset, $value ) {
         _doing_it_wrong(
@@ -95 +96 @@
      * @return BP_Core_BP_Nav_BackCompat
      */
+    #[ReturnTypeWillChange]
     public function offsetGet( $offset ) {
         _doing_it_wrong(
@@ -102 +104 @@
         );
 
-//      if ( ! isset( $this->backcompat_nav[ $offset ] ) ) {
-            $nav = $this->get_nav( $offset );
-            if ( $nav && isset( $nav[ $offset ] ) ) {
-                $this->backcompat_nav[ $offset ] = new self( $nav[ $offset ] );
-            }
-//      }
+        $nav = $this->get_nav( $offset );
+        if ( $nav && isset( $nav[ $offset ] ) ) {
+            $this->backcompat_nav[ $offset ] = new self( $nav[ $offset ] );
+        }
 
         return $this->backcompat_nav[ $offset ];
@@ -120 +120 @@
      * @return bool
      */
+    #[ReturnTypeWillChange]
     public function offsetExists( $offset ) {
         _doing_it_wrong(
@@ -146 +147 @@
      * @param mixed $offset Array offset.
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset( $offset ) {
         _doing_it_wrong(