_wp_json_sanity_check( mixed $value, int $depth ): mixed

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$valuemixed

Variable (usually an array or object) to encode as JSON.

$depthint

Maximum depth to walk through $value. Must be greater than 0.

Return value

mixed

The sanitized data that shall be encoded to JSON.

Performance profile

How much work a call to _wp_json_sanity_check() 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

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 95.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_json_sanity_check() can have, taken from its control-flow graph on PHP 8.5.

Uses · 4

• _wp_json_convert_string()Converts a string to UTF-8, so that it can be safely encoded to JSON.
• _wp_json_sanity_check()Performs confidence checks on data that shall be encoded to JSON.
• Exception::__construct()Create a new exception
• stdClass::__construct()

Used by · 2

• _wp_json_sanity_check()Performs confidence checks on data that shall be encoded to JSON.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.

Source code

View on Trac ↗View on GitHub ↗

4475function _wp_json_sanity_check( $value, $depth ) {4476	if ( $depth < 0 ) {4477		throw new Exception( 'Reached depth limit' );4478	}4479 4480	if ( is_array( $value ) ) {4481		$output = array();4482		foreach ( $value as $id => $el ) {4483			// Don't forget to sanitize the ID!4484			if ( is_string( $id ) ) {4485				$clean_id = _wp_json_convert_string( $id );4486			} else {4487				$clean_id = $id;4488			}4489 4490			// Check the element type, so that we're only recursing if we really have to.4491			if ( is_array( $el ) || is_object( $el ) ) {4492				$output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );4493			} elseif ( is_string( $el ) ) {4494				$output[ $clean_id ] = _wp_json_convert_string( $el );4495			} else {4496				$output[ $clean_id ] = $el;4497			}4498		}4499	} elseif ( is_object( $value ) ) {4500		$output = new stdClass();4501		foreach ( $value as $id => $el ) {4502			if ( is_string( $id ) ) {4503				$clean_id = _wp_json_convert_string( $id );4504			} else {4505				$clean_id = $id;4506			}4507 4508			if ( is_array( $el ) || is_object( $el ) ) {4509				$output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );4510			} elseif ( is_string( $el ) ) {4511				$output->$clean_id = _wp_json_convert_string( $el );4512			} else {4513				$output->$clean_id = $el;4514			}4515		}4516	} elseif ( is_string( $value ) ) {4517		return _wp_json_convert_string( $value );4518	} else {4519		return $value;4520	}4521 4522	return $output;4523}

Changelog

Introduced in 4.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.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.