云策 WordPress 开发者社区

函数文档

get_available_languages()

查看官方原文 ↗
💡 云策文档标注

概述

get_available_languages() 函数用于基于指定目录中的 *.mo 和 *.l10n.php 文件获取所有可用语言代码。默认目录为 WP_LANG_DIR，返回语言代码数组或空数组。

关键要点

  • 函数扫描指定目录中的 *.mo 和 *.l10n.php 文件，提取语言代码（通过去除文件扩展名）。
  • 参数 $dir 可选，默认为 WP_LANG_DIR；若为 null，则使用默认目录。
  • 返回 string[] 类型数组，包含语言代码，若无语言文件则返回空数组。
  • 内部使用 WP_Textdomain_Registry::get_language_files_from_path() 获取文件列表，并过滤掉特定前缀文件（如 continents-cities、ms-、admin-）。
  • 结果可通过 'get_available_languages' 过滤器进行自定义修改。

代码示例

function get_available_languages( $dir = null ) {
    global $wp_textdomain_registry;

    $languages = array();

    $path       = is_null( $dir ) ? WP_LANG_DIR : $dir;
    $lang_files = $wp_textdomain_registry->get_language_files_from_path( $path );

    if ( $lang_files ) {
        foreach ( $lang_files as $lang_file ) {
            $lang_file = basename( $lang_file, '.mo' );
            $lang_file = basename( $lang_file, '.l10n.php' );

            if ( ! str_starts_with( $lang_file, 'continents-cities' ) && ! str_starts_with( $lang_file, 'ms-' ) &&
                ! str_starts_with( $lang_file, 'admin-' ) ) {
                $languages[] = $lang_file;
            }
        }
    }

    return apply_filters( 'get_available_languages', array_unique( $languages ), $dir );
}

注意事项

  • 函数在 WordPress 3.0.0 中引入，4.7.0 版本添加了过滤器，6.5.0 版本改进了缓存机制并支持 *.l10n.php 文件。
  • 语言代码基于文件名生成，需确保文件命名符合规范。
  • 过滤器 'get_available_languages' 允许开发者修改返回的语言列表。
📄 原文内容

Gets all available languages based on the presence of *.mo and *.l10n.php files in a given directory.

Description

The default directory is WP_LANG_DIR.

Parameters

$dirstringoptional
A directory to search for language files.
Default WP_LANG_DIR.

Default:null

Return

string[] An array of language codes or an empty array if no languages are present.
Language codes are formed by stripping the file extension from the language file names.

Source

function get_available_languages( $dir = null ) {
	global $wp_textdomain_registry;

	$languages = array();

	$path       = is_null( $dir ) ? WP_LANG_DIR : $dir;
	$lang_files = $wp_textdomain_registry->get_language_files_from_path( $path );

	if ( $lang_files ) {
		foreach ( $lang_files as $lang_file ) {
			$lang_file = basename( $lang_file, '.mo' );
			$lang_file = basename( $lang_file, '.l10n.php' );

			if ( ! str_starts_with( $lang_file, 'continents-cities' ) && ! str_starts_with( $lang_file, 'ms-' ) &&
				! str_starts_with( $lang_file, 'admin-' ) ) {
				$languages[] = $lang_file;
			}
		}
	}

	/**
	 * Filters the list of available language codes.
	 *
	 * @since 4.7.0
	 *
	 * @param string[] $languages An array of available language codes.
	 * @param string   $dir       The directory where the language files were found.
	 */
	return apply_filters( 'get_available_languages', array_unique( $languages ), $dir );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_available_languages’, string[] $languages, string $dir )

Filters the list of available language codes.

Uses Description
WP_Textdomain_Registry::get_language_files_from_path()wp-includes/class-wp-textdomain-registry.php

Retrieves translation files from the specified path.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Used by Description
WP_REST_Plugins_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Uploads a plugin and optionally activates it.
WP_REST_Users_Controller::get_item_schema()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Retrieves the user’s schema, conforming to JSON Schema.
WP_Locale_Switcher::__construct()wp-includes/class-wp-locale-switcher.php

Constructor.
signup_get_available_languages()wp-signup.php

Retrieves languages available during the site/user sign-up process.
wp_install_language_form()wp-admin/includes/translation-install.php

Output the select form for the language selection on the installation screen.
wp_download_language_pack()wp-admin/includes/translation-install.php

Download a language pack.
login_footer()wp-login.php

Outputs the footer for the login page.
edit_user()wp-admin/includes/user.php

Edit user settings based on contents of $_POST
sanitize_option()wp-includes/formatting.php

Sanitizes various option values based on the nature of the option.
wp_update_plugins()wp-includes/update.php

Checks for available updates to plugins based on the latest versions hosted on WordPress.org.
wp_update_themes()wp-includes/update.php

Checks for available updates to themes based on the latest versions hosted on WordPress.org.
register_new_user()wp-includes/user.php

Handles registering a new user.

Show 7 moreShow less

Changelog

Version Description
6.5.0 The initial file list is now cached and also takes into account *.l10n.php files.
4.7.0 The results are now filterable with the ‘get_available_languages’ filter.
3.0.0 Introduced.