A WordPress-centric search engine for devs and theme authors



unload_textdomain ›

Since3.0.0
Deprecatedn/a
› unload_textdomain ( $domain, $reloadable = false )
Parameters: (2)
  • (string) $domain Text domain. Unique identifier for retrieving translated strings.
    Required: Yes
  • (bool) $reloadable Whether the text domain can be loaded just-in-time again.
    Required: No
    Default: false
Returns:
  • (bool) Whether textdomain was unloaded.
Defined at:
Codex:
Change Log:
  • 5.6.0

Unload translations for a text domain.



Related Functions: load_textdomain, load_theme_textdomain, load_script_textdomain, load_plugin_textdomain, load_default_textdomain

Source 

function unload_textdomain( $domain, $reloadable = false ) {
	global $l10n, $l10n_unloaded;

	$l10n_unloaded = (array) $l10n_unloaded;

	/**
	 * Filters whether to override the text domain unloading.
	 *
	 * @since 3.0.0
	 * @since 5.6.0 Added the `$reloadable` parameter.
	 *
	 * @param bool   $override   Whether to override the text domain unloading. Default false.
	 * @param string $domain     Text domain. Unique identifier for retrieving translated strings.
	 * @param bool   $reloadable Whether the text domain can be loaded just-in-time again.
	 */
	$plugin_override = apply_filters( 'override_unload_textdomain', false, $domain, $reloadable );

	if ( $plugin_override ) {
		if ( ! $reloadable ) {
			$l10n_unloaded[ $domain ] = true;
		}

		return true;
	}

	/**
	 * Fires before the text domain is unloaded.
	 *
	 * @since 3.0.0
	 * @since 5.6.0 Added the `$reloadable` parameter.
	 *
	 * @param string $domain     Text domain. Unique identifier for retrieving translated strings.
	 * @param bool   $reloadable Whether the text domain can be loaded just-in-time again.
	 */
	do_action( 'unload_textdomain', $domain, $reloadable );

	if ( isset( $l10n[ $domain ] ) ) {
		unset( $l10n[ $domain ] );

		if ( ! $reloadable ) {
			$l10n_unloaded[ $domain ] = true;
		}

		return true;
	}

	return false;
}