Changeset 49143

Timestamp:

10/14/2020 02:08:54 AM (4 years ago)

Author:

SergeyBiryukov

Message:

General: Move wp_array_get() from a separate file to wp-includes/functions.php, for consistency.

Add missing @since tag, adjust the DocBlock per the documentation standards.

Follow-up to [49135].

Props isabel_brison, ocean90.
Fixes #51461.

Location:

trunk/src

Files:

• wp-includes/array.php (deleted)
• wp-includes/functions.php (modified) (1 diff)
• wp-settings.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -4528 +4528 @@
 
 /**
+ * Accesses an array in depth based on a path of keys.
+ *
+ * It is the PHP equivalent of JavaScript's lodash.get, and mirroring it may help other components
+ * retain some symmetry between client and server implementations.
+ *
+ * @since 5.6.0
+ *
+ * @param array $array   An array from which we want to retrieve some information.
+ * @param array $path    An array of keys describing the path with which to retrieve information.
+ * @param array $default The return value if the path is not set on the array,
+ *                       or if the types of array and path are not arrays.
+ * @return array An array matching the path specified.
+ */
+function wp_array_get( $array, $path, $default = array() ) {
+    // Confirm input values are expected type to avoid notice warnings.
+    if ( ! is_array( $array ) || ! is_array( $path ) ) {
+        return $default;
+    }
+
+    $path_length = count( $path );
+
+    for ( $i = 0; $i < $path_length; ++$i ) {
+        if ( ! isset( $array[ $path[ $i ] ] ) ) {
+            return $default;
+        }
+        $array = $array[ $path[ $i ] ];
+    }
+
+    return $array;
+}
+
+/**
  * Filters a list of objects, based on a set of key => value arguments.
  *

trunk/src/wp-settings.php

@@ -180 +180 @@
 require ABSPATH . WPINC . '/general-template.php';
 require ABSPATH . WPINC . '/link-template.php';
-require ABSPATH . WPINC . '/array.php';
 require ABSPATH . WPINC . '/author-template.php';
 require ABSPATH . WPINC . '/post.php';