WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_json_file_decode()

wp_json_file_decode( string $filename, array $options = array() ): mixed

In this article

Back to top

Reads and decodes a JSON file.

Parameters

$filenamestringrequired
Path to the JSON file.
$optionsarrayoptional
Options to be used with json_decode().
  • associative bool
    Optional. When true, JSON objects will be returned as associative arrays.
    When false, JSON objects will be returned as objects. Default false.

Default:array()

Return

mixed Returns the value encoded in JSON in appropriate PHP type.
null is returned if the file is not found, or its content can’t be decoded.

Source

function wp_json_file_decode( $filename, $options = array() ) {	$result = null;	$filename = wp_normalize_path( realpath( $filename ) );	if ( ! $filename ) {	wp_trigger_error(	__FUNCTION__,	sprintf(	/* translators: %s: Path to the JSON file. */	__( "File %s doesn't exist!" ),	$filename	)	);	return $result;	}	$options = wp_parse_args( $options, array( 'associative' => false ) );	$decoded_file = json_decode( file_get_contents( $filename ), $options['associative'] );	if ( JSON_ERROR_NONE !== json_last_error() ) {	wp_trigger_error(	__FUNCTION__,	sprintf(	/* translators: 1: Path to the JSON file, 2: Error message. */	__( 'Error when decoding a JSON file at path %1$s: %2$s' ),	$filename,	json_last_error_msg()	)	);	return $result;	}	return $decoded_file; }

View all references View on Trac View on GitHub

UsesDescription
wp_trigger_error()wp-includes/functions.php

Generates a user-level error/warning/notice/deprecation message.

wp_normalize_path()wp-includes/functions.php

Normalizes a filesystem path.

wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

Show 1 moreShow less
Used byDescription
WP_Font_Collection::load_from_file()wp-includes/fonts/class-wp-font-collection.php

Loads the font collection data from a JSON file path.

get_block_metadata_i18n_schema()wp-includes/blocks.php

Gets i18n schema for block’s metadata read from block.json file.

WP_Theme_JSON_Resolver::read_json_file()wp-includes/class-wp-theme-json-resolver.php

Processes a file that adheres to the theme.json schema and returns an array with its contents, or a void array if none found.

WP_Theme_JSON_Resolver::translate()wp-includes/class-wp-theme-json-resolver.php

Given a theme.json structure modifies it in place to update certain values by its translated strings according to the language set by the user.

register_block_type_from_metadata()wp-includes/blocks.php

Registers a block type from the metadata stored in the block.json file.

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

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