Changeset 13936

Timestamp:

06/24/2024 02:05:55 AM (6 months ago)

Author:

imath

Message:

i18n: bring back custom locations for translation files

Prior to WordPress 4.6, it was possible to completely override the translation file with a custom one from one of the 'buddypress_locale_locations' filterable list items.

With WordPress 6.5 latest improvements about l10n, we are now able to bring these back. Making it easier for users to customize every BuddyPress strings should help them build match their community needs (e.g.: using sport/school/working/any other wording).

3 functions has been introduced:

• bp_get_custom_translation_file() is looking for a file name into 'buddypress_locale_locations' filterable list items.
• bp_load_custom_translation_file() is the 'load_translation_file' filter callback for regular translation files.
• bp_load_custom_script_translation_file() is the 'load_script_translation_file' filter callback for JavaScript translation files.

The bp_core_load_buddypress_textdomain() function has been deprecated as it was pretty useless since WordPress 4.6.

Props espellcaste

Fixes #9187
Closes ​https://github.com/buddypress/buddypress/pull/316

Location:

trunk/src/bp-core

Files:

• bp-core-functions.php (modified) (1 diff)
• deprecated/14.0.php (modified) (1 diff)

trunk/src/bp-core/bp-core-functions.php

@@ -2485 +2485 @@
 
 /**
- * Load the buddypress translation file for current language.
- *
- * @since 1.0.2
- *
- * @see load_textdomain() for a description of return values.
- *
- * @return bool
- */
-function bp_core_load_buddypress_textdomain() {
-    $domain = 'buddypress';
-
-    /**
-     * Filters the locale to be loaded for the language files.
-     *
-     * @since 1.0.2
-     *
-     * @param string $value Current locale for the install.
-     */
-    $mofile_custom = sprintf( '%s-%s.mo', $domain, apply_filters( 'buddypress_locale', get_locale() ) );
-
-    /**
-     * Filters the locations to load language files from.
-     *
-     * @since 2.2.0
-     *
-     * @param array $value Array of directories to check for language files in.
-     */
-    $locations = apply_filters( 'buddypress_locale_locations', array(
-        trailingslashit( WP_LANG_DIR . '/' . $domain  ),
-        trailingslashit( WP_LANG_DIR ),
-    ) );
-
-    // Try custom locations in WP_LANG_DIR.
-    foreach ( $locations as $location ) {
-        if ( load_textdomain( 'buddypress', $location . $mofile_custom ) ) {
-            return true;
-        }
-    }
-
-    // Default to WP and glotpress.
-    return load_plugin_textdomain( $domain );
-}
-add_action( 'bp_core_loaded', 'bp_core_load_buddypress_textdomain' );
+ * Looks for the requested file name into a list of custom language locations.
+ *
+ * @since 14.0.0
+ *
+ * @param string $file_name The file name.
+ * @return string A file path or an empty string if no files were found into custom language locations.
+ */
+function bp_get_custom_translation_file( $file_name = '' ) {
+    $file_path = '';
+
+    if ( $file_name ) {
+        /**
+         * Filters the locations to load language files from.
+         *
+         * Custom translation files can be put in:
+         * 1. `/wp-content/languages/plugins/buddypress`
+         * 2. `/wp-content/languages/buddypress`
+         * 3. `/wp-content/languages`
+         *
+         * @since 2.2.0
+         * @since 14.0.0 Adds a new location.
+         *
+         * @param array $value Array of directories to check for language files in.
+         */
+        $locations = apply_filters( 'buddypress_locale_locations',
+            array(
+                trailingslashit( WP_LANG_DIR . '/plugins/buddypress'  ),
+                trailingslashit( WP_LANG_DIR . '/buddypress'  ),
+                trailingslashit( WP_LANG_DIR ),
+            )
+        );
+
+        // Try custom locations in WP_LANG_DIR.
+        foreach ( $locations as $location ) {
+            $custom_file = $location . $file_name;
+
+            // Use the first found.
+            if ( file_exists( $custom_file ) ) {
+                $file_path = $custom_file;
+                break;
+            }
+        }
+    }
+
+    return $file_path;
+}
+
+/**
+ * Override translation file for current language.
+ *
+ * @since 14.0.0
+ *
+ * @param  string $file   Absolut path to the translation file to use.
+ * @param  string $domain The text domain to check against `buddypress`.
+ * @param  string $locale The current locale for the WordPress site.
+ * @return string Absolut path to the translation file to use.
+ */
+function bp_load_custom_translation_file( $file, $domain, $locale = '' ) {
+    $bp_domain = 'buddypress';
+
+    if ( $domain !== $bp_domain ) {
+        return $file;
+    }
+
+    if ( ! $locale ) {
+        $locale = determine_locale();
+    }
+
+    $mofile_custom = bp_get_custom_translation_file(
+        /**
+         * Filters the locale to be loaded for the language files.
+         *
+         * @since 1.0.2
+         *
+         * @param string $locale Current locale.
+         */
+        sprintf( '%s-%s.mo', $domain, apply_filters( 'buddypress_locale', $locale ) )
+    );
+
+    if ( $mofile_custom ) {
+        $file = $mofile_custom;
+    }
+
+    // Returns the translation file to use.
+    return $file;
+}
+add_filter( 'load_translation_file', 'bp_load_custom_translation_file', 10, 3 );
+
+/**
+ * Override script translation file for current language.
+ *
+ * @since 14.0.0
+ *
+ * @param string|false $file   Path to the translation file to load. False if there isn't one.
+ * @param string       $handle Name of the script to register a translation domain to.
+ * @param string       $domain The text domain.
+ * @return string Path to the translation file to load.
+ */
+function bp_load_custom_script_translation_file( $file, $handle, $domain ) {
+    $bp_domain = 'buddypress';
+
+    if ( $domain !== $bp_domain ) {
+        return $file;
+    }
+
+    $file_name   = wp_basename( $file );
+    $custom_file = bp_get_custom_translation_file( $file_name );
+
+    if ( $custom_file ) {
+        $file = $custom_file;
+    }
+
+    // Returns the translation file to use.
+    return $file;
+}
+add_filter( 'load_script_translation_file', 'bp_load_custom_script_translation_file', 10, 3 );
 
 /**

trunk/src/bp-core/deprecated/14.0.php

@@ -85 +85 @@
     );
 }
+
+/**
+ * Load the buddypress translation file for current language.
+ *
+ * @since 1.0.2
+ * @deprecated 14.0.0
+ *
+ * @return bool
+ */
+function bp_core_load_buddypress_textdomain() {
+    _deprecated_function( __FUNCTION__, '14.0.0' );
+
+    return false;
+}