WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

map_deep()

map_deep( mixed $value, callable $callback ): mixed

In this article

Back to top

Maps a function to all non-iterable elements of an array or an object.

Description

This is similar to array_walk_recursive() but acts upon objects too.

Parameters

$valuemixedrequired
The array, object, or scalar.
$callbackcallablerequired
The function to map onto $value.

Return

mixed The value with the callback applied to all non-arrays and non-objects inside it.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
map_deep()wp-includes/formatting.php

Maps a function to all non-iterable elements of an array or an object.

Used byDescription
wp_slash_strings_only()wp-includes/deprecated.php

Adds slashes to only string values in an array of values.

wp_kses_post_deep()wp-includes/kses.php

Navigates through an array, object, or scalar, and sanitizes content for allowed HTML tags for post content.

map_deep()wp-includes/formatting.php

Maps a function to all non-iterable elements of an array or an object.

urldecode_deep()wp-includes/formatting.php

Navigates through an array, object, or scalar, and decodes URL-encoded values

stripslashes_deep()wp-includes/formatting.php

Navigates through an array, object, or scalar, and removes slashes from the values.

urlencode_deep()wp-includes/formatting.php

Navigates through an array, object, or scalar, and encodes the values to be used in a URL.

rawurlencode_deep()wp-includes/formatting.php

Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.

Show 2 moreShow less

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    WordProof
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    You can use map_deep to easily sanitize user input.

    $values = array( 'a', '<b>Test</b>', '<>c' );

$values = map_deep( $values, 'sanitize_text_field' );

// Output: array(
//    "a",
//    "Test",
//    "c",
// )

    This works the same for multidimensional arrays.

    $values = array(
  'option_1' => 'value of this option',
  'option_2' => '<b>value of this option</b>'
);

$values = map_deep( $values, 'sanitize_text_field' );
  
// Output: array(
//   "option_1" => "value of this option",
//   "option_2" => "value of this option",
// )

You must log in before being able to contribute a note or feedback.