_logger = LoggerFramework::get_instance(); foreach ( FoundationCore::get_instance()->get_registered_plugins() as $plugin ) { $plugin_data = CoreHelpers::get_plugin_data( $plugin['plugin_file'] ); if ( isset( $plugin_data['TextDomain'] ) ) { $this->_text_domains[] = $plugin_data['TextDomain']; if ( $this->is_en_locale() ) { continue; } /** * Disables downloading translations. * * @filter `gk/foundation/translations/disable-download` * * @since 1.2.6 * * @param bool $disable_translations Whether to download translations. Default: false. */ $disable_download = apply_filters( 'gk/foundation/translations/disable-download', false ); if ( $this->can_install_languages() && ! $disable_download ) { // This will automatically try to install translations for all plugins when: // 1) The language is available in T15S and is not installed locally // 2) T15S has updated translations // Minimal to no performance impact if the 2 conditions are not met. $this->install_and_load_translations( $plugin_data['TextDomain'], get_user_locale() ); } else { // If translations can't be installed due to permissions but were previously installed, // remap the location of the .mo file as it is stored in a folder suffixed with the blog ID. add_filter( 'load_textdomain_mofile', function ( $mo_file, $text_domain ) use ( $plugin_data ) { /** * Specifies the location of the .mo file. * * @filter `gk/foundation/translations//mo-file` * * @since 1.2.6 * * @param string $remapped_mo_file */ $remapped_mo_file = apply_filters( "gk/foundation/translations/{$plugin_data['TextDomain']}/mo-file", self::get_translation_file_name( $plugin_data['TextDomain'], get_user_locale() ) ); if ( $plugin_data['TextDomain'] === $text_domain && file_exists( $remapped_mo_file ) ) { return $remapped_mo_file; } return $mo_file; }, 10, 2 ); $this->load_backend_translations( $plugin_data['TextDomain'], get_user_locale() ); } } } if ( empty( $this->_text_domains ) ) { return; } add_action( 'gk/foundation/plugin-deactivated', [ $this, 'on_plugin_deactivation' ] ); /** * Fires when the class has finished initializing. * * @action `gk/foundation/translations/initialized` * * @since 1.0.0 * * @param Framework $instance */ do_action( 'gk/foundation/translations/initialized', $this ); } /** * Checks of user has permissions to install languages. * * @since 1.0.0 * * @return bool */ public function can_install_languages() { if ( CoreHelpers::is_cli() ) { return true; } /** * Sets permission to install languages. * * @filter `gk/foundation/translations/permissions/can-install-languages` * * @since 1.0.0 * * @param bool $can_install_languages Default: `install_languages` capability. */ return apply_filters( 'gk/foundation/translations/permissions/can-install-languages', current_user_can( 'install_languages' ) ); } /** * Downloads and installs translations from TranslationsPress. * * @since 1.0.0 * @since 1.2.6 Method renamed from `install` to `install_and_load_translations`. * * @param string $text_domain Text domain. * @param string $language Language to install. * * @return void */ public function install_and_load_translations( $text_domain, $language ) { $current_user = wp_get_current_user(); if ( ! $this->can_install_languages() ) { $this->_logger->error( sprintf( 'User "%s" does not have permissions to install languages.', $current_user->user_login ) ); } try { // phpcs:disable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase $T15s_updater = $this->get_T15s_updater( $text_domain ); $T15s_updater->install( $language ); $translations = $T15s_updater->get_installed_translations( true ); if ( isset( $translations[ $language ] ) ) { $this->load_backend_translations( $text_domain, $language ); } // phpcs:enable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase } catch ( Exception $e ) { $this->_logger->error( $e->getMessage() ); } } /** * Loads and sets frontend and backend translations. * * @since 1.0.0 * * @param string $text_domain Text domain. * @param string $language (optional) Language to load. Default is site locale. * * @return void */ public function load_all_translations( $text_domain, $language = '' ) { $this->load_backend_translations( $text_domain, $language ); $this->load_frontend_translations( $text_domain, $language ); } /** * Loads and sets backend translations. * * @since 1.0.0 * * @param string $text_domain Text domain. * @param string $language (optional) Language to load. Default is site locale. * * @return void */ public function load_backend_translations( $text_domain, $language = '' ) { if ( ! $language ) { $language = get_user_locale(); } $mo_file = $this->get_translation_file_name( $text_domain, $language ); if ( ! $mo_file ) { $this->_logger->notice( sprintf( '"%s" .mo translation file not found for "%s".', $text_domain, $language ) ); return; } load_textdomain( $text_domain, $mo_file ); } /** * Loads and sets frontend translations. * * @since 1.0.0 * * @param string $text_domain Text domain. * @param string $language (optional) Language to load. Default is site locale. * @param string $frontend_text_domain (optional) Frontend text domain if different from the backend text domain (e.g., plugin uses 'foo', but JS uses 'bar' for the same translations). * * @return void */ public function load_frontend_translations( $text_domain, $language = '', $frontend_text_domain = '' ) { if ( ! $language ) { $language = get_user_locale(); } if ( $this->is_en_locale( $language ) ) { return; } $json_translations = $this->get_translation_file_name( $text_domain, $language, 'json' ); if ( ! file_exists( $json_translations ) ) { $this->_logger->notice( sprintf( 'No %s.json translations file found for "%s" text domain.', $text_domain ?: $frontend_text_domain, $language ) ); return; } $json_translations = file_get_contents( $json_translations ); // Optionally override text domain if UI expects a different one. $text_domain = $frontend_text_domain ?: $text_domain; add_filter( 'gk/foundation/inline-scripts', function ( $scripts ) use ( $text_domain, $json_translations ) { $js = << $js, 'dependencies' => [ 'wp-i18n' ], ]; return $scripts; } ); } /** * Returns the translation filename for a given language. * * @param string $text_domain Text domain. * @param string $language Translation language (e.g. 'en_EN'). * @param string $extension (optional) File extension. Default is 'mo'. * * @return string|null */ public static function get_translation_file_name( $text_domain, $language, $extension = 'mo' ) { return sprintf( '%s/%s-%s.%s', self::get_path_to_translations_folder(), $text_domain, $language, $extension ); } /** * Returns path to folder where translations are stored, suffixed by the blog ID. * * @since 1.2.6 * * @return string */ public static function get_path_to_translations_folder() { return sprintf( '%s/%s', untrailingslashit( self::WP_LANG_DIR ), get_current_blog_id() ); } /** * Deletes translations when the plugin is deactivated. * * @since 1.0.0 * * @param string $plugin_file Plugin file. * * @return void */ public function on_plugin_deactivation( $plugin_file ) { if ( ! function_exists( 'get_plugin_data' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } $plugin_data = get_plugin_data( $plugin_file ); if ( $this->is_en_locale() || ! $this->can_install_languages() ) { return; } $files = glob( sprintf( '%s/%s-*', self::get_path_to_translations_folder(), $plugin_data['TextDomain'] ) ); if ( empty( $files ) ) { return; } array_walk( $files, 'wp_delete_file' ); global $wp_filesystem; if ( ! $wp_filesystem ) { require_once ABSPATH . '/wp-admin/includes/admin.php'; } if ( ! WP_Filesystem() ) { return; } if ( ! $wp_filesystem->rmdir( self::get_path_to_translations_folder() ) ) { $this->_logger->error( sprintf( 'Failed to delete translations folder for site ID "%d"', get_current_blog_id() ) ); } } /** * Checks whether the current locale is set to English language. * * @since 1.0.0 * * @param string $locale (optional) Locale to check. Default is site locale. * * @return bool */ public function is_en_locale( $locale = '' ) { if ( ! $locale ) { $locale = get_user_locale(); } // en_EN = en_US; en_GB and en_CA can have their own "translations" due to differences in spelling. return in_array( $locale, [ 'en_EN', 'en_US' ], true ); } }