Changeset 10102

Timestamp:

07/27/2020 09:23:24 PM (3 years ago)

Author:

ryelle

Message:

Plugin Directory: Check if script translations are loaded

This checks if the block plugin is using wp_set_script_translations to load translations into the page for use with wp.i18n. This is a warning-level check, since translations are not required for the plugin or block directories.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• cli/class-block-plugin-checker.php (modified) (1 diff)
• shortcodes/class-block-validator.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php

@@ -802 +802 @@
 
     /**
+     * Check that the plugin uses `wp_set_script_translations`.
+     */
+    function check_for_translation_function() {
+        $functions = wp_list_pluck( $this->php_function_calls, 0 );
+        if ( ! in_array( 'wp_set_script_translations', $functions ) ) {
+            $this->record_result(
+                __FUNCTION__,
+                'warning',
+                __( 'No translations are loaded for the scripts.', 'wporg-plugins' ),
+                $call
+            );
+        }
+    }
+
+    /**
      * Does it make PHP function calls that shouldn't be in a block plugin?
      */

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php

@@ -318 +318 @@
             case 'check_php_function_calls':
                 return __( 'Block plugins should contain minimal PHP with no UI outside the editor. JavaScript should be used instead of PHP where possible.', 'wporg-plugins' );
+            case 'check_for_translation_function':
+                return sprintf(
+                    // translators: %s is the link to the internationalization docs.
+                    __( 'Block plugins should use <code>wp_set_script_translations</code> to load translations for each script file. <a href="%s">Learn more about internationalization.</a>', 'wporg-plugins' ),
+                    'https://developer.wordpress.org/block-editor/developers/internationalization/'
+                );
             // This is a special case, since multiple values may be collapsed.
             case 'check_block_json_is_valid':