Changeset 59783

Timestamp:

02/07/2025 06:52:54 PM (4 hours ago)

Author:

desrosj

Message:

General: Introduce polyfills for new array related functions in PHP 8.4.

PHP 8.4 introduced four new functions to provide a common way to more easily perform common operations on arrays.

• array_find(): ​https://www.php.net/manual/en/function.array-find.php
• array_find_key(): ​https://www.php.net/manual/en/function.array-find-key.php
• array_all(): ​https://www.php.net/manual/en/function.array-all.php
• array_any(): ​https://www.php.net/manual/en/function.array-any.php

These functions are now polyfilled making them available on all supported versions of PHP (currently 7.2+).

Props Soean, swissspidy, TobiasBg, ayeshrajans, mukesh27, joemcgill.
Fixes #62558.

Location:

trunk

Files:

• src/wp-includes/compat.php (modified) (1 diff)
• tests/phpunit/tests/compat/arrayAll.php (added)
• tests/phpunit/tests/compat/arrayAny.php (added)
• tests/phpunit/tests/compat/arrayFind.php (added)
• tests/phpunit/tests/compat/arrayFindKey.php (added)

trunk/src/wp-includes/compat.php

@@ -550 +550 @@
 }
 
+if ( ! function_exists( 'array_find' ) ) {
+    /**
+     * Polyfill for `array_find()` function added in PHP 8.4.
+     *
+     * Searches an array for the first element that passes a given callback.
+     *
+     * @since 6.8.0
+     *
+     * @param array    $array    The array to search.
+     * @param callable $callback The callback to run for each element.
+     * @return mixed|null The first element in the array that passes the `$callback`, otherwise null.
+     */
+    function array_find( array $array, callable $callback ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
+        foreach ( $array as $key => $value ) {
+            if ( $callback( $value, $key ) ) {
+                return $value;
+            }
+        }
+
+        return null;
+    }
+}
+
+if ( ! function_exists( 'array_find_key' ) ) {
+    /**
+     * Polyfill for `array_find_key()` function added in PHP 8.4.
+     *
+     * Searches an array for the first key that passes a given callback.
+     *
+     * @since 6.8.0
+     *
+     * @param array    $array    The array to search.
+     * @param callable $callback The callback to run for each element.
+     * @return int|string|null The first key in the array that passes the `$callback`, otherwise null.
+     */
+    function array_find_key( array $array, callable $callback ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
+        foreach ( $array as $key => $value ) {
+            if ( $callback( $value, $key ) ) {
+                return $key;
+            }
+        }
+
+        return null;
+    }
+}
+
+if ( ! function_exists( 'array_any' ) ) {
+    /**
+     * Polyfill for `array_any()` function added in PHP 8.4.
+     *
+     * Checks if any element of an array passes a given callback.
+     *
+     * @since 6.8.0
+     *
+     * @param array    $array    The array to check.
+     * @param callable $callback The callback to run for each element.
+     * @return bool True if any element in the array passes the `$callback`, otherwise false.
+     */
+    function array_any( array $array, callable $callback ): bool { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
+        foreach ( $array as $key => $value ) {
+            if ( $callback( $value, $key ) ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}
+
+if ( ! function_exists( 'array_all' ) ) {
+    /**
+     * Polyfill for `array_all()` function added in PHP 8.4.
+     *
+     * Checks if all elements of an array pass a given callback.
+     *
+     * @since 6.8.0
+     *
+     * @param array    $array    The array to check.
+     * @param callable $callback The callback to run for each element.
+     * @return bool True if all elements in the array pass the `$callback`, otherwise false.
+     */
+    function array_all( array $array, callable $callback ): bool { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
+        foreach ( $array as $key => $value ) {
+            if ( ! $callback( $value, $key ) ) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}
+
 // IMAGETYPE_AVIF constant is only defined in PHP 8.x or later.
 if ( ! defined( 'IMAGETYPE_AVIF' ) ) {