WP_Scripts::print_translations( string $handle, bool $display = true ): string|false

Parameters

$handlestring

Name of the script to add the inline script to. Must be lowercase.

$displaybooloptional

Whether to print the script instead of just returning it. Default true.Default: true

Return

string|false

Script on success, false otherwise.

Uses · 2

• load_script_textdomain()Loads the script translated strings.
• wp_print_inline_script_tag()Prints an inline script tag.

Used by · 1

• WP_Scripts::do_item()Processes a script dependency.

Source

View on Trac ↗View on GitHub ↗

716	public function print_translations( $handle, $display = true ) {717		if ( ! isset( $this->registered[ $handle ] ) || empty( $this->registered[ $handle ]->textdomain ) ) {718			return false;719		}720 721		$domain = $this->registered[ $handle ]->textdomain;722		$path   = '';723 724		if ( isset( $this->registered[ $handle ]->translations_path ) ) {725			$path = $this->registered[ $handle ]->translations_path;726		}727 728		$json_translations = load_script_textdomain( $handle, $domain, $path );729 730		if ( ! $json_translations ) {731			return false;732		}733 734		$output = <<<JS735( function( domain, translations ) {736	var localeData = translations.locale_data[ domain ] || translations.locale_data.messages;737	localeData[""].domain = domain;738	wp.i18n.setLocaleData( localeData, domain );739} )( "{$domain}", {$json_translations} );740JS;741 742		if ( $display ) {743			$source_url = rawurlencode( "{$handle}-js-translations" );744			$output    .= "\n//# sourceURL={$source_url}";745			wp_print_inline_script_tag( $output, array( 'id' => "{$handle}-js-translations" ) );746		}747 748		return $output;749	}

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 6.9.7 tag, from src/wp-includes/class-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.