Changeset 59127

Timestamp:

09/30/2024 03:28:26 PM (2 years ago)

Author:

swissspidy

Message:

I18N: Emit warnings if loading translations too early.

Some plugins and themes load translations too early, before the current user is known.
This happens either explicitly or through just-in-time translation loading.

If the current user (and thus their locale) is not known, WordPress might attempt to load translations in the wrong locale.

This change adds _doing_it_wrong messages to warn about such cases. It also helps avoiding accidentally trying to load translations twice (once just-in-time and once manually).

Projects triggering such a message are encourage to load translations no earlier than the after_setup_theme hook.

Props garrett-eclipse, Kau-Boy, swissspidy, johnbillion, alanfuller. rodelgc.
Fixes #44937.

File:

• trunk/src/wp-includes/l10n.php (modified) (4 diffs)

trunk/src/wp-includes/l10n.php

@@ -1000 +1000 @@
         }
 
+        if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
+                                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
+                                '<code>' . $domain . '</code>',
+                                '<code>after_setup_theme</code>'
+                        ),
+                        '6.7.0'
+                );
+        }
+
         /**
          * Filters a plugin's locale.
@@ -1052 +1065 @@
         }
 
+        if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
+                                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
+                                '<code>' . $domain . '</code>',
+                                '<code>after_setup_theme</code>'
+                        ),
+                        '6.7.0'
+                );
+        }
+
         /** This filter is documented in wp-includes/l10n.php */
         $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
@@ -1093 +1119 @@
         if ( ! is_string( $domain ) ) {
                 return false;
+        }
+
+        if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
+                                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
+                                '<code>' . $domain . '</code>',
+                                '<code>after_setup_theme</code>'
+                        ),
+                        '6.7.0'
+                );
         }
 
@@ -1382 +1421 @@
                 return false;
         }
+
+        if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: %s: The text domain. */
+                                __( 'Translation loading for the %s domain was triggered too early. This is usually an indicator for some code in the plugin or theme running too early.' ),
+                                '<code>' . $domain . '</code>'
+                        ),
+                        '6.7.0'
+                );
+        }
+
         // Themes with their language directory outside of WP_LANG_DIR have a different file name.
         $template_directory   = trailingslashit( get_template_directory() );