Changeset 54351

Timestamp:

09/28/2022 10:17:38 PM (2 years ago)

Author:

SergeyBiryukov

Message:

I18N: Use correct default value for JavaScript translations path.

The $path parameter of some script translation functions had a default value of null, even though the parameter is documented as a string.

This commit corrects the default value for $path in:

• WP_Dependency::set_translations()
• WP_Scripts::set_translations()
• wp_set_script_translations()

Additionally, this commit removes an is_string() check for $path in load_script_textdomain(). Now that the default value for $path in that function has also been corrected to an empty string instead of null, that check is no longer necessary, as it would hide an error which should be fixed (at the source of the problem) instead.

Follow-up to [54349].

Props jrf, johnjamesjacoby.
See #55967, #55656.

Location:

trunk/src/wp-includes

Files:

• class-wp-dependency.php (modified) (1 diff)
• class-wp-scripts.php (modified) (2 diffs)
• functions.wp-scripts.php (modified) (1 diff)
• l10n.php (modified) (1 diff)

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

@@ -127 +127 @@
      * @return bool False if $domain is not a string, true otherwise.
      */
-    public function set_translations( $domain, $path = null ) {
+    public function set_translations( $domain, $path = '' ) {
         if ( ! is_string( $domain ) ) {
             return false;

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

@@ -574 +574 @@
      * @return bool True if the text domain was registered, false if not.
      */
-    public function set_translations( $handle, $domain = 'default', $path = null ) {
+    public function set_translations( $handle, $domain = 'default', $path = '' ) {
         if ( ! isset( $this->registered[ $handle ] ) ) {
             return false;
@@ -606 +606 @@
 
         $domain = $this->registered[ $handle ]->textdomain;
-        $path   = $this->registered[ $handle ]->translations_path;
+        $path   = '';
+
+        if ( isset( $this->registered[ $handle ]->translations_path ) ) {
+            $path = $this->registered[ $handle ]->translations_path;
+        }
 
         $json_translations = load_script_textdomain( $handle, $domain, $path );

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

@@ -238 +238 @@
  * @return bool True if the text domain was successfully localized, false otherwise.
  */
-function wp_set_script_translations( $handle, $domain = 'default', $path = null ) {
+function wp_set_script_translations( $handle, $domain = 'default', $path = '' ) {
     global $wp_scripts;
 

trunk/src/wp-includes/l10n.php

@@ -1066 +1066 @@
     }
 
-    if ( is_string( $path ) ) {
-        $path = untrailingslashit( $path );
-    }
-
+    $path   = untrailingslashit( $path );
     $locale = determine_locale();