WP_Scripts::set_translations

Advertisement

Summery Summery

Sets a translation textdomain.

Syntax Syntax

WP_Scripts::set_translations( string $handle, string $domain = 'default', string $path = null )

Parameters Parameters

$handle

(Required) Name of the script to register a translation domain to.

$domain

(Optional) Text domain. Default 'default'.

Default value: 'default'

$path

(Optional) The full file path to the directory containing translation files.

Default value: null

Return Return

(bool) True if the text domain was registered, false if not.

Source Source

File: wp-includes/class.wp-scripts.php

	public function set_translations( $handle, $domain = 'default', $path = null ) {
		if ( ! isset( $this->registered[ $handle ] ) ) {
			return false;
		}

		/** @var \_WP_Dependency $obj */
		$obj = $this->registered[ $handle ];

		if ( ! in_array( 'wp-i18n', $obj->deps, true ) ) {
			$obj->deps[] = 'wp-i18n';
		}

		return $obj->set_translations( $domain, $path );
	}

Advertisement

Changelog Changelog

Changelog
Version Description
5.1.0 The $domain parameter was made optional.
5.0.0 Introduced.

Advertisement

Leave a Reply