Changeset 49981 for trunk/src/wp-includes/blocks.php

Timestamp:

01/19/2021 11:04:03 AM (4 years ago)

Author:

gziolo

Message:

Blocks: Add i18n support to register_block_type_from_metadata

Related Gutenberg issue: ​https://github.com/WordPress/gutenberg/issues/23636.
Related WP-CLI PR: ​https://github.com/wp-cli/i18n-command/pull/210.
Related documentation proposal: ​https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/block-api/block-metadata.md#internationalization-not-implemented

Adds programatic i18n support to register_block_type_from_metadata function for block settings registered from block.json file that provides textdomain field.

Props swissspidy, ocean90.
Fixes #52301.

File:

• trunk/src/wp-includes/blocks.php (modified) (2 diffs)

trunk/src/wp-includes/blocks.php

@@ -135 +135 @@
         $script_asset['version']
     );
-    return $result ? $script_handle : false;
+    if ( ! $result ) {
+        return false;
+    }
+
+    if ( ! empty( $metadata['textdomain'] ) ) {
+        wp_set_script_translations( $script_handle, $metadata['textdomain'] );
+    }
+
+    return $script_handle;
 }
 
@@ -230 +238 @@
     foreach ( $property_mappings as $key => $mapped_key ) {
         if ( isset( $metadata[ $key ] ) ) {
-            $settings[ $mapped_key ] = $metadata[ $key ];
+            $value = $metadata[ $key ];
+            if ( empty( $metadata['textdomain'] ) ) {
+                $settings[ $mapped_key ] = $value;
+                continue;
+            }
+            $textdomain = $metadata['textdomain'];
+            switch ( $key ) {
+                case 'title':
+                case 'description':
+                    // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralContext,WordPress.WP.I18n.NonSingularStringLiteralDomain
+                    $settings[ $mapped_key ] = translate_with_gettext_context( $value, sprintf( 'block %s', $key ), $textdomain );
+                    break;
+                case 'keywords':
+                    $settings[ $mapped_key ] = array();
+                    if ( ! is_array( $value ) ) {
+                        continue 2;
+                    }
+
+                    foreach ( $value as $keyword ) {
+                        // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain
+                        $settings[ $mapped_key ][] = translate_with_gettext_context( $keyword, 'block keyword', $textdomain );
+                    }
+
+                    break;
+                case 'styles':
+                    $settings[ $mapped_key ] = array();
+                    if ( ! is_array( $value ) ) {
+                        continue 2;
+                    }
+
+                    foreach ( $value as $style ) {
+                        if ( ! empty( $style['label'] ) ) {
+                            // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain
+                            $style['label'] = translate_with_gettext_context( $style['label'], 'block style label', $textdomain );
+                        }
+                        $settings[ $mapped_key ][] = $style;
+                    }
+
+                    break;
+                default:
+                    $settings[ $mapped_key ] = $value;
+            }
         }
     }