Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WP_Theme_JSON_Resolver: update translate terminology #28944

Merged
merged 4 commits into from
Feb 11, 2021
Merged

WP_Theme_JSON_Resolver: update translate terminology #28944

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8746d5f
Rename translate_presets to translate
oandregal Feb 9, 2021
eb5e9b6
Clarify terminology
oandregal Feb 9, 2021
02ce8ff
Clarify terminology
oandregal Feb 9, 2021
ce74abd
Clarify theme_json_i18_file_structure_to_preset_paths to extract_path…
oandregal Feb 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 22 additions & 21 deletions lib/class-wp-theme-json-resolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,8 @@ private static function get_from_file( $file_path ) {
}

/**
* Processes a tree from i18n-theme.json into a linear array
* containing the a translatable path from theme.json and an array
* of properties that are translatable.
* Converts a tree as in i18n-theme.json into a linear array
* containing metadata to translate a theme.json file.
*
* For example, given this input:
*
Expand Down Expand Up @@ -111,14 +110,14 @@ private static function get_from_file( $file_path ) {
* ]
* ]
*
* @param array $file_structure_partial A part of a theme.json i18n tree.
* @param array $current_path An array with a path on the theme.json i18n tree.
* @param array $i18n_partial A tree that follows the format of i18n-theme.json.
* @param array $current_path Keeps track of the path as we walk down the given tree.
*
* @return array An array of arrays each one containing a translatable path and an array of properties that are translatable.
* @return array A linear array containing the paths to translate.
*/
private static function theme_json_i18_file_structure_to_preset_paths( $file_structure_partial, $current_path = array() ) {
private static function extract_paths_to_translate( $i18n_partial, $current_path = array() ) {
$result = array();
foreach ( $file_structure_partial as $property => $partial_child ) {
foreach ( $i18n_partial as $property => $partial_child ) {
if ( is_numeric( $property ) ) {
foreach ( $partial_child as $key => $context ) {
return array(
Expand All @@ -132,7 +131,7 @@ private static function theme_json_i18_file_structure_to_preset_paths( $file_str
}
$result = array_merge(
$result,
self::theme_json_i18_file_structure_to_preset_paths( $partial_child, array_merge( $current_path, array( $property ) ) )
self::extract_paths_to_translate( $partial_child, array_merge( $current_path, array( $property ) ) )
);
}
return $result;
Expand All @@ -147,30 +146,32 @@ public static function get_presets_to_translate() {
static $theme_json_i18n = null;
if ( null === $theme_json_i18n ) {
$file_structure = self::get_from_file( __DIR__ . '/experimental-i18n-theme.json' );
$theme_json_i18n = self::theme_json_i18_file_structure_to_preset_paths( $file_structure );
$theme_json_i18n = self::extract_paths_to_translate( $file_structure );
}
return $theme_json_i18n;
}

/**
* Translates a theme.json structure.
* 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.
*
* @param array $theme_json_structure A theme.json structure that is going to be translatable.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
* Default 'default'.
* @param array $theme_json The theme.json to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
* Default 'default'.
*/
private static function translate_presets( &$theme_json_structure, $domain = 'default' ) {
if ( ! isset( $theme_json_structure['settings'] ) ) {
private static function translate( &$theme_json, $domain = 'default' ) {
if ( ! isset( $theme_json['settings'] ) ) {
return;
}

$preset_to_translate = self::get_presets_to_translate();
foreach ( $theme_json_structure['settings'] as &$settings ) {
$presets = self::get_presets_to_translate();
foreach ( $theme_json['settings'] as &$settings ) {
if ( empty( $settings ) ) {
continue;
}

foreach ( $preset_to_translate as $preset ) {
foreach ( $presets as $preset ) {
$path = array_slice( $preset['path'], 2 );
$key = $preset['key'];
$context = $preset['context'];
Expand Down Expand Up @@ -207,7 +208,7 @@ public static function get_core_data() {

$all_blocks = WP_Theme_JSON::ALL_BLOCKS_NAME;
$config = self::get_from_file( __DIR__ . '/experimental-default-theme.json' );
self::translate_presets( $config );
self::translate( $config );

// Start i18n logic to remove when JSON i18 strings are extracted.
$default_colors_i18n = array(
Expand Down Expand Up @@ -287,7 +288,7 @@ public static function get_core_data() {
public static function get_theme_data( $theme_support_data = array() ) {
if ( null === self::$theme ) {
$theme_json_data = self::get_from_file( locate_template( 'experimental-theme.json' ) );
self::translate_presets( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
self::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
self::$theme = new WP_Theme_JSON( $theme_json_data );
}

Expand Down