map_deep( mixed $value, callable $callback ): mixed
- Since
- 4.4.0
- Source
wp-includes/formatting.php:5140
Description
This is similar to array_walk_recursive() but acts upon objects too.
Compatibility
- WordPress
- since 4.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$valuemixed- The array, object, or scalar.
$callbackcallable- The function to map onto $value.
Return value
mixed- The value with the callback applied to all non-arrays and non-objects inside it.
Performance profile
How much work a call to map_deep() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Scales with input
- Instructions
- 7–14
- Plugin surface
- None
- Called by
- 7
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 39.
Nothing here hands control to plugin code.
7 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost map_deep() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_array($value) | 7–8 | none |
!is_array($value) && !is_object($value) | 11 | call_user_func() |
!is_array($value) && is_object($value) | 13–14 | get_object_vars() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 7–14 executed per call, 6 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- map_deep()Maps a function to all non-iterable elements of an array or an object.
Used by · 7
- map_deep()Maps a function to all non-iterable elements of an array or an object.
- rawurlencode_deep()Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.
- stripslashes_deep()Navigates through an array, object, or scalar, and removes slashes from the values.
- urldecode_deep()Navigates through an array, object, or scalar, and decodes URL-encoded values
- urlencode_deep()Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
- wp_kses_post_deep()Navigates through an array, object, or scalar, and sanitizes content for allowed HTML tags for post content.
- wp_slash_strings_only()Adds slashes to only string values in an array of values.
Source code
function map_deep( $value, $callback ) { if ( is_array( $value ) ) { foreach ( $value as $index => $item ) { $value[ $index ] = map_deep( $item, $callback ); } } elseif ( is_object( $value ) ) { $object_vars = get_object_vars( $value ); foreach ( $object_vars as $property_name => $property_value ) { $value->$property_name = map_deep( $property_value, $callback ); } } else { $value = call_user_func( $callback, $value ); } return $value;}Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/formatting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.