unload_textdomain( string $domain, bool $reloadable = false ): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$domainstring

Text domain. Unique identifier for retrieving translated strings.

$reloadablebooloptional

Whether the text domain can be loaded just-in-time again.Default: false

Return value

bool

Whether textdomain was unloaded.

Performance profile

How much work a call to unload_textdomain() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

16–35

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 42.

Plugin surface

2 hooks

Third-party callbacks on 'override_unload_textdomain', 'unload_textdomain' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost unload_textdomain() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while unload_textdomain() runs, in this order:

1. 1
   apply_filters( override_unload_textdomain )filterline 894 (+15 into the body)

   Filters whether to override the text domain unloading.

2. 2
   do_action( unload_textdomain )actionline 913 (+34 into the body)

   Fires before the text domain is unloaded.

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Translation_Controller::get_instance()::unload_textdomain()
• WP_Translation_Controller::get_instance()Utility method to retrieve the main instance of the class.

Used by · 3

• WP_Locale_Switcher::load_translations()Load translations for a given locale.
• load_default_textdomain()Loads default translated strings based on locale.
• wp_timezone_choice()Gives a nicely-formatted list of timezone strings.

Source code

View on Trac ↗View on GitHub ↗

879function unload_textdomain( $domain, $reloadable = false ) {880	global $l10n, $l10n_unloaded;881 882	$l10n_unloaded = (array) $l10n_unloaded;883 884	/**885	 * Filters whether to override the text domain unloading.886	 *887	 * @since 3.0.0888	 * @since 6.1.0 Added the `$reloadable` parameter.889	 *890	 * @param bool   $override   Whether to override the text domain unloading. Default false.891	 * @param string $domain     Text domain. Unique identifier for retrieving translated strings.892	 * @param bool   $reloadable Whether the text domain can be loaded just-in-time again.893	 */894	$plugin_override = apply_filters( 'override_unload_textdomain', false, $domain, $reloadable );895 896	if ( $plugin_override ) {897		if ( ! $reloadable ) {898			$l10n_unloaded[ $domain ] = true;899		}900 901		return true;902	}903 904	/**905	 * Fires before the text domain is unloaded.906	 *907	 * @since 3.0.0908	 * @since 6.1.0 Added the `$reloadable` parameter.909	 *910	 * @param string $domain     Text domain. Unique identifier for retrieving translated strings.911	 * @param bool   $reloadable Whether the text domain can be loaded just-in-time again.912	 */913	do_action( 'unload_textdomain', $domain, $reloadable );914 915	// Since multiple locales are supported, reloadable text domains don't actually need to be unloaded.916	if ( ! $reloadable ) {917		WP_Translation_Controller::get_instance()->unload_textdomain( $domain );918	}919 920	if ( isset( $l10n[ $domain ] ) ) {921		if ( $l10n[ $domain ] instanceof NOOP_Translations ) {922			unset( $l10n[ $domain ] );923 924			return false;925		}926 927		unset( $l10n[ $domain ] );928 929		if ( ! $reloadable ) {930			$l10n_unloaded[ $domain ] = true;931		}932 933		return true;934	}935 936	return false;937}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/l10n.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.