Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

WP_Theme_JSON_Resolver::extract_paths_to_translate( array $i18n_partial, array $current_path = array() ): array

Converts a tree as in i18n-theme.json into a linear array containing metadata to translate a theme.json file.


Description

For example, given this input:

{
  "settings": {
    "*": {
      "typography": {
        "fontSizes": [ { "name": "Font size name" } ],
        "fontStyles": [ { "name": "Font size name" } ]
      }
    }
  }
}

will return this output:

[
  0 => [
    'path'    => [ 'settings', '*', 'typography', 'fontSizes' ],
    'key'     => 'name',
    'context' => 'Font size name'
  ],
  1 => [
    'path'    => [ 'settings', '*', 'typography', 'fontStyles' ],
    'key'     => 'name',
    'context' => 'Font style name'
  ]
]

Top ↑

Parameters

$i18n_partial array Required
A tree that follows the format of i18n-theme.json.
$current_path array Optional
Keeps track of the path as we walk down the given tree.

Default: array()


Top ↑

Return

array A linear array containing the paths to translate.


Top ↑

Source

File: wp-includes/class-wp-theme-json-resolver.php. View all references

		if ( is_array( $decoded_file ) ) {
			static::$theme_json_file_cache[ $file_path ] = $decoded_file;
			return static::$theme_json_file_cache[ $file_path ];
		}
	}

	return array();
}

/**
 * Returns a data structure used in theme.json translation.
 *
 * @since 5.8.0
 * @deprecated 5.9.0
 *
 * @return array An array of theme.json fields that are translatable and the keys that are translatable.
 */
public static function get_fields_to_translate() {
	_deprecated_function( __METHOD__, '5.9.0' );
	return array();

Top ↑

Changelog

Changelog
Version Description
5.8.0 Introduced.

Top ↑

User Contributed Notes

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