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

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

Contents

Description

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

Top ↑

Parameters

$value mixed Required
The array, object, or scalar.
$callback callable Required
The function to map onto $value.

Top ↑

Return

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

Top ↑

Source

File: wp-includes/formatting.php. View all references 

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 on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
map_deep() wp-includes/formatting.php

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

Top ↑

Used By

Used By
Used By Description
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 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by WordProof —

    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.