wp_set_script_translations( string $handle, string $domain = 'default', string $path = '' ): bool

Description

Parameters

$handlestring

Script handle the textdomain will be attached to.

$domainstringoptional

Text domain. Default 'default'.Default: 'default'

$pathstringoptional

The full file path to the directory containing translation files.Default: ''

Return

bool

True if the text domain was successfully localized, false otherwise.

Uses · 1

• _wp_scripts_maybe_doing_it_wrong()Helper function to output a _doing_it_wrong message when applicable.

Used by · 1

• register_block_script_handle()Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.

Source

View on Trac ↗View on GitHub ↗

342function wp_set_script_translations( $handle, $domain = 'default', $path = '' ) {343	global $wp_scripts;344 345	if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {346		_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );347		return false;348	}349 350	return $wp_scripts->set_translations( $handle, $domain, $path );351}

History

Introduced in 5.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 7.0.4 tag, from src/wp-includes/functions.wp-scripts.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.