Changeset 44169

Timestamp:

12/14/2018 05:51:31 AM (6 years ago)

Author:

pento

Message:

I18N: Add JavaScript translation support.

Adds the wp_set_script_translations() function which registers translations for a JavaScript file. This function takes a handle, domain and optionally a path and ensures JavaScript translation files are loaded if they exist.

Merges [43825,43828,43859,43898] from the 5.0 branch to trunk.

Props herregroen, atimmer, omarreiss, nerrad, swissspidy, ocean90, georgestephanis.
Fixes #45103, #45256.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-dependency.php (modified) (2 diffs)
• src/wp-includes/class.wp-scripts.php (modified) (3 diffs)
• src/wp-includes/functions.wp-scripts.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (1 diff)
• tests/phpunit/data/languages/admin-en_US-script-handle.json (copied) (copied from branches/5.0/tests/phpunit/data/languages/admin-en_US-script-handle.json)
• tests/phpunit/data/languages/en_US-813e104eb47e13dd4cc5af844c618754.json (copied) (copied from branches/5.0/tests/phpunit/data/languages/en_US-813e104eb47e13dd4cc5af844c618754.json)
• tests/phpunit/data/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json (copied) (copied from branches/5.0/tests/phpunit/data/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json)
• tests/phpunit/data/languages/themes/internationalized-theme-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json (copied) (copied from branches/5.0/tests/phpunit/data/languages/themes/internationalized-theme-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-dependency.php

@@ -69 +69 @@
 
     /**
+     * Translation textdomain set for this dependency.
+     *
+     * @since 5.0.0
+     * @var string
+     */
+    public $textdomain;
+
+    /**
+     * Translation path set for this dependency.
+     *
+     * @since 5.0.0
+     * @var string
+     */
+    public $translations_path;
+
+    /**
      * Setup dependencies.
      *
@@ -97 +113 @@
     }
 
+    public function set_translations( $domain, $path = null ) {
+        if ( ! is_string( $domain ) ) {
+            return false;
+        }
+        $this->textdomain        = $domain;
+        $this->translations_path = $path;
+        return true;
+    }
 }

trunk/src/wp-includes/class.wp-scripts.php

@@ -331 +331 @@
         }
 
+        $translations = $this->print_translations( $handle, false );
+        if ( $translations ) {
+            $translations = sprintf( "<script type='text/javascript'>\n%s\n</script>\n", $translations );
+        }
+
         if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
             $src = $this->base_url . $src;
@@ -346 +351 @@
         }
 
-        $tag = "{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}";
+        $tag = "{$translations}{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}";
 
         /**
@@ -489 +494 @@
 
         return parent::set_group( $handle, $recursion, $grp );
+    }
+
+    /**
+     * Sets a translation textdomain.
+     *
+     * @since 5.0.0
+     *
+     * @param string $handle Name of the script to register a translation domain to.
+     * @param string $domain The textdomain.
+     * @param string $path   Optional. The full file path to the directory containing translation files.
+     *
+     * @return bool True if the textdomain was registered, false if not.
+     */
+    public function set_translations( $handle, $domain, $path = null ) {
+        if ( ! isset( $this->registered[ $handle ] ) ) {
+            return false;
+        }
+
+        /** @var \_WP_Dependency $obj */
+        $obj = $this->registered[ $handle ];
+
+        if ( ! in_array( 'wp-i18n', $obj->deps, true ) ) {
+            $obj->deps[] = 'wp-i18n';
+        }
+        return $obj->set_translations( $domain, $path );
+    }
+
+    /**
+     * Prints translations set for a specific handle.
+     *
+     * @since 5.0.0
+     *
+     * @param string $handle Name of the script to add the inline script to. Must be lowercase.
+     * @param bool   $echo   Optional. Whether to echo the script instead of just returning it.
+     *                       Default true.
+     * @return string|false Script on success, false otherwise.
+     */
+    public function print_translations( $handle, $echo = true ) {
+        if ( ! isset( $this->registered[ $handle ] ) || empty( $this->registered[ $handle ]->textdomain ) ) {
+            return false;
+        }
+
+        $domain = $this->registered[ $handle ]->textdomain;
+        $path   = $this->registered[ $handle ]->translations_path;
+
+        $json_translations = load_script_textdomain( $handle, $domain, $path );
+
+        if ( ! $json_translations ) {
+            // Register empty locale data object to ensure the domain still exists.
+            $json_translations = '{ "locale_data": { "messages": { "": {} } } }';
+        }
+
+        $output = '(function( translations ){' .
+                      'wp.i18n.setLocaleData( translations.locale_data, "' . $domain . '" );' .
+                  '})(' . $json_translations . ');';
+
+        if ( $echo ) {
+            printf( "<script type='text/javascript'>\n%s\n</script>\n", $output );
+        }
+
+        return $output;
     }
 

trunk/src/wp-includes/functions.wp-scripts.php

@@ -199 +199 @@
 
     return $wp_scripts->localize( $handle, $object_name, $l10n );
+}
+
+/**
+ * Sets translated strings for a script.
+ *
+ * Works only if the script has already been added.
+ *
+ * @see WP_Scripts::set_translations()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 5.0.0
+ *
+ * @param string $handle Script handle the textdomain will be attached to.
+ * @param string $domain The textdomain.
+ * @param string $path   Optional. The full file path to the directory containing translation files.
+ *
+ * @return bool True if the textdomain was successfully localized, false otherwise.
+ */
+function wp_set_script_translations( $handle, $domain, $path = null ) {
+    global $wp_scripts;
+    if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
+        _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
+        return false;
+    }
+
+    return $wp_scripts->set_translations( $handle, $domain, $path );
 }
 

trunk/src/wp-includes/l10n.php

@@ -892 +892 @@
     }
     return load_theme_textdomain( $domain, $path );
+}
+
+/**
+ * Load the script translated strings.
+ *
+ * @see WP_Scripts::set_translations()
+ * @link https://core.trac.wordpress.org/ticket/45103
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 5.0.0
+ *
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The textdomain.
+ * @param string $path   Optional. The full file path to the directory containing translation files.
+ *
+ * @return false|string False if the script textdomain could not be loaded, the translated strings
+ *                      in JSON encoding otherwise.
+ */
+function load_script_textdomain( $handle, $domain, $path = null ) {
+    global $wp_scripts;
+
+    $path   = untrailingslashit( $path );
+    $locale = is_admin() ? get_locale() : get_user_locale();
+
+    // If a path was given and the handle file exists simply return it.
+    $file_base       = $domain === 'default' ? $locale : $domain . '-' . $locale;
+    $handle_filename = $file_base . '-' . $handle . '.json';
+    if ( $path && file_exists( $path . '/' . $handle_filename ) ) {
+        return file_get_contents( $path . '/' . $handle_filename );
+    }
+
+    $obj = $wp_scripts->registered[ $handle ];
+
+    /** This filter is documented in wp-includes/class.wp-scripts.php */
+    $src = esc_url( apply_filters( 'script_loader_src', $obj->src, $handle ) );
+
+    $relative       = false;
+    $languages_path = WP_LANG_DIR;
+
+    $src_url     = wp_parse_url( $src );
+    $content_url = wp_parse_url( content_url() );
+    $site_url    = wp_parse_url( site_url() );
+
+    // If the host is the same or it's a relative URL.
+    if (
+        strpos( $src_url['path'], $content_url['path'] ) === 0 &&
+        ( ! isset( $src_url['host'] ) || $src_url['host'] !== $content_url['host'] )
+    ) {
+        // Make the src relative the specific plugin or theme.
+        $relative = trim( substr( $src, strlen( $content_url['path'] ) ), '/' );
+        $relative = explode( '/', $relative );
+
+        $languages_path = WP_LANG_DIR . '/' . $relative[0];
+
+        $relative = array_slice( $relative, 2 );
+        $relative = implode( '/', $relative );
+    } elseif ( ! isset( $src_url['host'] ) || $src_url['host'] !== $site_url['host'] ) {
+        if ( ! isset( $site_url['path'] ) ) {
+            $relative = trim( $src_url['path'], '/' );
+        } elseif ( ( strpos( $src_url['path'], $site_url['path'] ) === 0 ) ) {
+            // Make the src relative to the WP root.
+            $relative = substr( $src, strlen( $site_url['path'] ) );
+            $relative = trim( $relative, '/' );
+        }
+    }
+
+    // If the source is not from WP.
+    if ( false === $relative ) {
+        return false;
+    }
+
+    // Translations are always based on the unminified filename.
+    if ( substr( $relative, -7 ) === '.min.js' ) {
+        $relative = substr( $relative, 0, -7 ) . '.js';
+    }
+
+    $md5_filename = $file_base . '-' . md5( $relative ) . '.json';
+    if ( $path && file_exists( $path . '/' . $md5_filename ) ) {
+        return file_get_contents( $path . '/' . $md5_filename );
+    }
+    if ( file_exists( $languages_path . '/' . $md5_filename ) ) {
+        return file_get_contents( $languages_path . '/' . $md5_filename );
+    }
+
+    return false;
 }
 

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -770 +770 @@
         $expected .= "<script type='text/javascript' src='/wp-includes/js/script3.js?ver={$ver}'></script>\n";
         $expected .= "<script type='text/javascript' src='/wp-includes/js/script4.js?ver={$ver}'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'test-example', '/wp-includes/js/script.js', array(), null );
+        wp_set_script_translations( 'test-example', 'default', DIR_TESTDATA . '/languages' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                'wp.i18n.setLocaleData( translations.locale_data, "default" );' .
+            '})(' . file_get_contents( DIR_TESTDATA . '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_for_plugin() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'plugin-example', '/wp-content/plugins/my-plugin/js/script.js', array(), null );
+        wp_set_script_translations( 'plugin-example', 'internationalized-plugin', DIR_TESTDATA . '/languages/plugins' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'wp.i18n.setLocaleData( translations.locale_data, "internationalized-plugin" );' .
+                     '})(' . file_get_contents( DIR_TESTDATA . '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-content/plugins/my-plugin/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_for_theme() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'theme-example', '/wp-content/themes/my-theme/js/script.js', array(), null );
+        wp_set_script_translations( 'theme-example', 'internationalized-theme', DIR_TESTDATA . '/languages/themes' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'wp.i18n.setLocaleData( translations.locale_data, "internationalized-theme" );' .
+                     '})(' . file_get_contents( DIR_TESTDATA . '/languages/themes/internationalized-theme-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-content/themes/my-theme/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_with_handle_file() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'script-handle', '/wp-admin/js/script.js', array(), null );
+        wp_set_script_translations( 'script-handle', 'admin', DIR_TESTDATA . '/languages/' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'wp.i18n.setLocaleData( translations.locale_data, "admin" );' .
+                     '})(' . file_get_contents( DIR_TESTDATA . '/languages/admin-en_US-script-handle.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-admin/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_i18n_dependency() {
+        global $wp_scripts;
+
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'test-example', '/wp-includes/js/script.js', array(), null );
+        wp_set_script_translations( 'test-example', 'default', DIR_TESTDATA . '/languages/' );
+
+        $script = $wp_scripts->registered['test-example'];
+
+        $this->assertContains( 'wp-i18n', $script->deps );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_when_translation_file_does_not_exist() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'test-example', '/wp-admin/js/script.js', array(), null );
+        wp_set_script_translations( 'test-example', 'admin', DIR_TESTDATA . '/languages/' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'translations.locale_data.messages[""].domain = "admin";' .
+                     'wp.i18n.setLocaleData( translations.locale_data.messages, "admin" );' .
+                     "})({ \"locale_data\": { \"messages\": { \"\": {} } } });\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-admin/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_after_register() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_register_script( 'test-example', '/wp-includes/js/script.js', array(), null );
+        wp_set_script_translations( 'test-example', 'default', DIR_TESTDATA . '/languages' );
+
+        wp_enqueue_script( 'test-example' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'wp.i18n.setLocaleData( translations.locale_data, "default" );' .
+                     '})(' . file_get_contents( DIR_TESTDATA . '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js'></script>\n";
+
+        $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 45103
+     */
+    public function test_wp_set_script_translations_dependency() {
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_register_script( 'test-dependency', '/wp-includes/js/script.js', array(), null );
+        wp_set_script_translations( 'test-dependency', 'default', DIR_TESTDATA . '/languages' );
+
+        wp_enqueue_script( 'test-example', '/wp-includes/js/script2.js', array( 'test-dependency' ), null );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+        $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+                     'wp.i18n.setLocaleData( translations.locale_data, "default" );' .
+                     '})(' . file_get_contents( DIR_TESTDATA . '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json' ) . ");\n</script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js'></script>\n";
+        $expected .= "<script type='text/javascript' src='/wp-includes/js/script2.js'></script>\n";
 
         $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );