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

In this article

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.

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'
  ]
]

Parameters

$i18n_partialarrayrequired
A tree that follows the format of i18n-theme.json.
$current_patharrayoptional
Keeps track of the path as we walk down the given tree.

Default:array()

Return

array A linear array containing the paths to translate.

Source


/**
 * 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();
}

/**
 * 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.
 *
 * @since 5.8.0
 *

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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