Changeset 35252

Timestamp:

10/17/2015 11:25:21 PM (9 years ago)

Author:

johnbillion

Message:

Introduce map_deep(), a utility function that recursively maps a callable function to every item in an array or object. Works like array_walk_recursive() but works with objects too.

Updates rawurlencode_deep(), urlencode_deep(), and stripslashes_deep() to use map_deep(). Introduces urldecode_deep() for completeness.

Props wpmuguru, nbachiyski, boonebgorges, MikeHansenMe, chriscct7, realloc, johnbillion
Fixes #22300

Location:

trunk

Files:

• src/wp-includes/formatting.php (modified) (3 diffs)
• tests/phpunit/tests/formatting/MapDeep.php (added)
• tests/phpunit/tests/formatting/UrlencodeDeep.php (added)

trunk/src/wp-includes/formatting.php

@@ -2010 +2010 @@
 
 /**
- * Navigates through an array and removes slashes from the values.
- *
- * If an array is passed, the array_map() function causes a callback to pass the
- * value back to the function. The slashes from this value will removed.
+ * Navigates through an array, object, or scalar, and removes slashes from the values.
  *
  * @since 2.0.0
@@ -2021 +2018 @@
  */
 function stripslashes_deep( $value ) {
-    if ( is_array($value) ) {
-        $value = array_map('stripslashes_deep', $value);
-    } elseif ( is_object($value) ) {
-        $vars = get_object_vars( $value );
-        foreach ($vars as $key=>$data) {
-            $value->{$key} = stripslashes_deep( $data );
-        }
-    } elseif ( is_string( $value ) ) {
-        $value = stripslashes($value);
-    }
-
-    return $value;
-}
-
-/**
- * Navigates through an array and encodes the values to be used in a URL.
- *
+    return map_deep( $value, 'stripslashes_from_strings_only' );
+}
+
+/**
+ * Callback function for `stripslashes_deep()` which strips slashes from strings.
+ *
+ * @since 4.4.0
+ *
+ * @param mixed $value The array or string to be stripped.
+ * @return mixed $value The stripped value.
+ */
+function stripslashes_from_strings_only( $value ) {
+    return is_string( $value ) ? stripslashes( $value ) : $value;
+}
+
+/**
+ * Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
  *
  * @since 2.2.0
  *
- * @param array|string $value The array or string to be encoded.
- * @return array|string $value The encoded array (or string from the callback).
+ * @param mixed $value The array or string to be encoded.
+ * @return mixed $value The encoded value.
  */
 function urlencode_deep( $value ) {
-    return is_array( $value ) ? array_map( 'urlencode_deep', $value ) : urlencode( $value );
-}
-
-/**
- * Navigates through an array and raw encodes the values to be used in a URL.
+    return map_deep( $value, 'urlencode' );
+}
+
+/**
+ * Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.
  *
  * @since 3.4.0
  *
- * @param array|string $value The array or string to be encoded.
- * @return array|string $value The encoded array (or string from the callback).
+ * @param mixed $value The array or string to be encoded.
+ * @return mixed $value The encoded value.
  */
 function rawurlencode_deep( $value ) {
-    return is_array( $value ) ? array_map( 'rawurlencode_deep', $value ) : rawurlencode( $value );
+    return map_deep( $value, 'rawurlencode' );
+}
+
+/**
+ * Navigates through an array, object, or scalar, and decodes URL-encoded values
+ *
+ * @since 4.4.0
+ *
+ * @param mixed $value The array or string to be decoded.
+ * @return mixed $value The decoded value.
+ */
+function urldecode_deep( $value ) {
+    return map_deep( $value, 'urldecode' );
 }
 
@@ -3864 +3873 @@
 
 /**
+ * Maps a function to all non-iterable elements of an array or an object.
+ *
+ * This is similar to `array_walk_recursive()` but acts upon objects too.
+ *
+ * @since 4.4.0 
+ * 
+ * @param mixed    $value    The array, object, or scalar.
+ * @param callable $function The function to map onto $value.
+ * @return The value with the callback applied to all non-arrays and non-objects inside it.
+ */
+function map_deep( $value, $callback ) {
+    if ( is_array( $value ) || is_object( $value ) ) {
+        foreach ( $value as &$item ) {
+            $item = map_deep( $item, $callback );
+        }
+        return $value;
+    } else {
+        return call_user_func( $callback, $value );
+    }
+}
+
+/**
  * Parses a string into variables to be stored in an array.
  *