Changeset 56803

Timestamp:

10/09/2023 11:21:30 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Update parameter names in the WP_Block_List class.

This makes the parameter names consistent with the ArrayAccess interface.

Reference: ​PHP Manual: The ArrayAccess interface.

Follow-up to [48159].

Props rahmohn.
See #58976.

File:

• trunk/src/wp-includes/class-wp-block-list.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-block-list.php

@@ -64 +64 @@
 
         /**
-         * Returns true if a block exists by the specified block index, or false
+         * Returns true if a block exists by the specified block offset, or false
          * otherwise.
          *
@@ -71 +71 @@
          * @link https://www.php.net/manual/en/arrayaccess.offsetexists.php
          *
-         * @param string $index Index of block to check.
+         * @param string $offset Offset of block to check for.
          * @return bool Whether block exists.
          */
         #[ReturnTypeWillChange]
-        public function offsetExists( $index ) {
-                return isset( $this->blocks[ $index ] );
-        }
-
-        /**
-         * Returns the value by the specified block index.
+        public function offsetExists( $offset ) {
+                return isset( $this->blocks[ $offset ] );
+        }
+
+        /**
+         * Returns the value by the specified block offset.
          *
          * @since 5.5.0
@@ -86 +86 @@
          * @link https://www.php.net/manual/en/arrayaccess.offsetget.php
          *
-         * @param string $index Index of block value to retrieve.
+         * @param string $offset Offset of block value to retrieve.
          * @return mixed|null Block value if exists, or null.
          */
         #[ReturnTypeWillChange]
-        public function offsetGet( $index ) {
-                $block = $this->blocks[ $index ];
+        public function offsetGet( $offset ) {
+                $block = $this->blocks[ $offset ];
 
                 if ( isset( $block ) && is_array( $block ) ) {
                         $block                  = new WP_Block( $block, $this->available_context, $this->registry );
-                        $this->blocks[ $index ] = $block;
+                        $this->blocks[ $offset ] = $block;
                 }
 
@@ -102 +102 @@
 
         /**
-         * Assign a block value by the specified block index.
+         * Assign a block value by the specified block offset.
          *
          * @since 5.5.0
@@ -108 +108 @@
          * @link https://www.php.net/manual/en/arrayaccess.offsetset.php
          *
-         * @param string $index Index of block value to set.
+         * @param string $offset Offset of block value to set.
          * @param mixed  $value Block value.
          */
         #[ReturnTypeWillChange]
-        public function offsetSet( $index, $value ) {
-                if ( is_null( $index ) ) {
+        public function offsetSet( $offset, $value ) {
+                if ( is_null( $offset ) ) {
                         $this->blocks[] = $value;
                 } else {
-                        $this->blocks[ $index ] = $value;
+                        $this->blocks[ $offset ] = $value;
                 }
         }
@@ -127 +127 @@
          * @link https://www.php.net/manual/en/arrayaccess.offsetunset.php
          *
-         * @param string $index Index of block value to unset.
-         */
-        #[ReturnTypeWillChange]
-        public function offsetUnset( $index ) {
-                unset( $this->blocks[ $index ] );
+         * @param string $offset Offset of block value to unset.
+         */
+        #[ReturnTypeWillChange]
+        public function offsetUnset( $offset ) {
+                unset( $this->blocks[ $offset ] );
         }