Section styles: support i18n for variations declared in theme.json or theme style variations

[oandregal]

What?

This PR adds support for internationalizing the block style variations labels defined from a theme.json or a theme style variation (e.g.: styles/ember.json).

Why?

We want to enable internationalization of the block style variations defined from a theme.json or a theme style variation.

How?

Allow title to be provided when registering block style variations from theme.json or theme style variations (e.g.: styles/ember.json):

• Update theme.json schema to allow title as a valid property
• Update theme-i18n.json schema to signal title as a translatable property

Testing Instructions

In the theme.json of the theme, paste the following contents under styles.blocks.variations:

"myvariation": {
    "title": "My Variation",
    "blockTypes": ["core/group"],
    "color": {
        "background": "var(--wp--preset--color--base-2)"
    }
}

Without the title	With the title

Note that the title was already permitted, so it didn't require any style registration/generation changes. This PR adds it as part of the schema used by editors for linting and makes it translatable.

Related work

Enabling the styles.blocks.variations.*.title property to be translatable requires:

• updating the wp-cli/i18n-command that processes WordPress & the ecosystem (plugins, themes) to extract the strings theme.json: find title string within styles.blocks.variations wp-cli/i18n-command#405
• update the theme-i18n.json in WordPress core as well (to be done as part of backporting this PR)

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: oandregal <oandregal@git.wordpress.org>
Co-authored-by: aaronrobertshaw <aaronrobertshaw@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core GitHub repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/theme-i18n.json

[github-actions]

Flaky tests detected in 5ad228d.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9501765632
📝 Reported issues:

• [Flaky Test] Redirection after template creation #60678 in /test/e2e/specs/site-editor/site-editor-url-navigation.spec.js

[oandregal]

@aaronrobertshaw I haven't found any docs for this, so I haven't update them. It'd be useful to incorporate examples (in the devnote of the feature, theme.json docs, etc.) that include the title to raise awareness among users.

[oandregal]

I'd like to hold on merging until I have the tests passing in the related PR for the i18n-command at wp-cli/i18n-command#405

[aaronrobertshaw]

LGTM 👍

This tests as advertised. I also like that it helps make it clearer that the keys should be lowercase slugs even if we can't enforce that 100% due to BC.

I haven't found any docs for this, so I haven't update them

There's a dev note comment and draft post for it.

When updating the dev note and writing the docs, it will be worth mentioning that the title will only be used from the first source the style gets registered from. That is, if the variation is defined within the main theme.json and redefined in a theme style variation, the title set in the main theme.json is what will be used. It is not overridden.

Updating the handbook documentation is still in progress but bug fixes have taken priority during this 6.6 beta period. I'll hopefully return to it and the dev note next week.

[oandregal]

The related work at wp-cli/i18n-command#405 is working fine when executing manually. There're some issues with the behat tests that shouldn't block this PR from landing (actually, after backporting this to core the tests there should be fixed).

[ellatrix]

I just cherry-picked this PR to the wp/6.6-beta-3 branch to get it included in the next release: 0f53d7b