Changeset 49981

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.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (2 diffs)
• tests/phpunit/data/blocks/notice (added)
• tests/phpunit/data/blocks/notice/block.asset.php (added)
• tests/phpunit/data/blocks/notice/block.css (added)
• tests/phpunit/data/blocks/notice/block.js (added)
• tests/phpunit/data/blocks/notice/block.json (added)
• tests/phpunit/data/languages/plugins/notice-pl_PL.mo (added)
• tests/phpunit/data/languages/plugins/notice-pl_PL.po (added)
• tests/phpunit/tests/blocks/fixtures (deleted)
• tests/phpunit/tests/blocks/register.php (modified) (9 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;
+            }
         }
     }

trunk/tests/phpunit/tests/blocks/register.php

@@ -63 +63 @@
         $registry = WP_Block_Type_Registry::get_instance();
 
-        foreach ( array( 'core/test-static', 'core/test-dynamic', 'my-plugin/notice' ) as $block_name ) {
+        foreach ( array( 'core/test-static', 'core/test-dynamic', 'tests/notice' ) as $block_name ) {
             if ( $registry->is_registered( $block_name ) ) {
                 $registry->unregister( $block_name );
@@ -194 +194 @@
             'file'   => __FILE__,
             'name'   => 'unit-tests/test-block',
-            'script' => 'file:./fixtures/missing-asset.js',
+            'script' => 'file:./blocks/notice/missing-asset.js',
         );
         $result   = register_block_script_handle( $metadata, 'script' );
@@ -218 +218 @@
     function test_success_register_block_script_handle() {
         $metadata = array(
-            'file'   => __FILE__,
+            'file'   => DIR_TESTDATA . '/blocks/notice/block.json',
             'name'   => 'unit-tests/test-block',
-            'script' => 'file:./fixtures/block.js',
+            'script' => 'file:./block.js',
         );
         $result   = register_block_script_handle( $metadata, 'script' );
@@ -263 +263 @@
     function test_success_register_block_style_handle() {
         $metadata = array(
-            'file'  => __FILE__,
+            'file'  => DIR_TESTDATA . '/blocks/notice/block.json',
             'name'  => 'unit-tests/test-block',
-            'style' => 'file:./fixtures/block.css',
+            'style' => 'file:./block.css',
         );
         $result   = register_block_style_handle( $metadata, 'style' );
@@ -304 +304 @@
     function test_block_registers_with_metadata_fixture() {
         $result = register_block_type_from_metadata(
-            __DIR__ . '/fixtures'
+            DIR_TESTDATA . '/blocks/notice'
         );
 
         $this->assertInstanceOf( 'WP_Block_Type', $result );
         $this->assertSame( 2, $result->api_version );
-        $this->assertSame( 'my-plugin/notice', $result->name );
+        $this->assertSame( 'tests/notice', $result->name );
         $this->assertSame( 'Notice', $result->title );
         $this->assertSame( 'common', $result->category );
@@ -328 +328 @@
         $this->assertSame(
             array(
-                'my-plugin/message' => 'message',
+                'tests/message' => 'message',
             ),
             $result->provides_context
@@ -362 +362 @@
             $result->example
         );
-        $this->assertSame( 'my-plugin-notice-editor-script', $result->editor_script );
-        $this->assertSame( 'my-plugin-notice-script', $result->script );
-        $this->assertSame( 'my-plugin-notice-editor-style', $result->editor_style );
-        $this->assertSame( 'my-plugin-notice-style', $result->style );
+        $this->assertSame( 'tests-notice-editor-script', $result->editor_script );
+        $this->assertSame( 'tests-notice-script', $result->script );
+        $this->assertSame( 'tests-notice-editor-style', $result->editor_style );
+        $this->assertSame( 'tests-notice-style', $result->style );
+    }
+
+    /**
+     * @ticket 52301
+     */
+    function test_block_registers_with_metadata_i18n_support() {
+        function filter_set_locale_to_polish() {
+            return 'pl_PL';
+        }
+        add_filter( 'locale', 'filter_set_locale_to_polish' );
+        load_textdomain( 'notice', WP_LANG_DIR . '/plugins/notice-pl_PL.mo' );
+
+        $result = register_block_type_from_metadata(
+            DIR_TESTDATA . '/blocks/notice'
+        );
+
+        unload_textdomain( 'notice' );
+        remove_filter( 'locale', 'filter_set_locale_to_polish' );
+
+        $this->assertInstanceOf( 'WP_Block_Type', $result );
+        $this->assertSame( 'tests/notice', $result->name );
+        $this->assertSame( 'Powiadomienie', $result->title );
+        $this->assertSame( 'Wyświetla ostrzeżenie, błąd lub powiadomienie o sukcesie…', $result->description );
+        $this->assertSameSets( array( 'ostrzeżenie', 'wiadomość' ), $result->keywords );
+        $this->assertSame(
+            array(
+                array(
+                    'name'      => 'default',
+                    'label'     => 'Domyślny',
+                    'isDefault' => true,
+                ),
+                array(
+                    'name'  => 'other',
+                    'label' => 'Inny',
+                ),
+            ),
+            $result->styles
+        );
     }
 
@@ -434 +472 @@
         add_filter( 'block_type_metadata', $filter_metadata_registration, 10, 2 );
         $result = register_block_type_from_metadata(
-            __DIR__ . '/fixtures'
+            DIR_TESTDATA . '/blocks/notice'
         );
         remove_filter( 'block_type_metadata', $filter_metadata_registration );
@@ -452 +490 @@
         add_filter( 'block_type_metadata_settings', $filter_metadata_registration, 10, 2 );
         $result = register_block_type_from_metadata(
-            __DIR__ . '/fixtures'
+            DIR_TESTDATA . '/blocks/notice'
         );
         remove_filter( 'block_type_metadata_settings', $filter_metadata_registration );