Broken loop in WP_Theme_JSON_Resolver

[schlessera]

The loop in WP_Theme_JSON_Resolver to extract translatable paths is broken, as it contains an immediate and unconditional return. This causes the loop to immediately exit again after the first iteration, thus never actually looping.

gutenberg/lib/class-wp-theme-json-resolver-gutenberg.php

Lines 129 to 137 in f76d127

	foreach ( $partial_child as $key => $context ) {
	return array(
	array(
	'path' => $current_path,
	'key' => $key,
	'context' => $context,
	),
	);
	}

This means that the extraction only works where there's only a single item in the array of translatable strings per section (i.e. the 'name' field).

The suggested code would be:

	foreach ( $partial_child as $key => $context ) { 
		$result[] = array(
			'path'    => $current_path, 
			'key'     => $key, 
			'context' => $context, 
		);
	);
	return $result;
 }

[swissspidy]

cc @gziolo @nosolosw

[gziolo]

Yes, good catch. It’s an obvious bug from #28246 that I didn’t catch only because we had only one field used for all translatable paths 😅
We need a test that uses a custom schema and requires several fields to be translated, a good example would be in the i18n schema for block.json:

gutenberg/packages/blocks/src/api/i18n-block.json

Lines 10 to 16 in d361e91

	"variations": [
	{
	"title": "block variation title",
	"description": "block variation description",
	"keywords": [ "block variation keyword" ]
	}
	]

At some point, we could also unify the logic that applies translations based on i18n schemas.
I recently proposed https://github.com/WordPress/wordpress-develop/blob/92a8fda178379f7366054f26580ae756da0dcbda/src/wp-includes/blocks.php#L219-L247 that could work for both, but it doesn’t cover the case with * that theme.json has.

[gziolo]

It was also backported to WordPress core: WordPress/wordpress-develop@3f83b50.