类文档

WP_Translations

💡 云策文档标注

概述

WP_Translations 是 WordPress 6.5.0 引入的类,用于处理翻译字符串,提供单数和复数翻译功能。它依赖于 WP_Translation_Controller 实例,并支持向后兼容的魔法获取器。

关键要点

  • WP_Translations 类用于管理翻译条目,包括单数和复数字符串的翻译。
  • 构造函数接收 WP_Translation_Controller 实例和可选的文本域参数。
  • __get 魔法方法提供对 'entries' 和 'headers' 属性的向后兼容访问。
  • make_entry 方法从原始字符串和翻译字符串构建 Translation_Entry 对象。
  • translate 方法翻译单数字符串,translate_plural 方法翻译复数字符串,均支持上下文和回退机制。

代码示例

public function __construct( WP_Translation_Controller $controller, string $textdomain = 'default' ) {
    $this->controller = $controller;
    $this->textdomain = $textdomain;
}
public function translate( $singular, $context = '' ) {
    if ( null === $singular ) {
        return null;
    }

    $translation = $this->controller->translate( $singular, (string) $context, $this->textdomain );
    if ( false !== $translation ) {
        return $translation;
    }

    // Fall back to the original.
    return $singular;
}

📄 原文内容

Class WP_Translations.

Methods

Name Description
WP_Translations::__construct Constructor.
WP_Translations::__get Magic getter for backward compatibility.
WP_Translations::make_entry Builds a Translation_Entry from original string and translation strings.
WP_Translations::translate Translates a singular string.
WP_Translations::translate_plural Translates a plural string.

Source

class WP_Translations {
	/**
	 * Text domain.
	 *
	 * @since 6.5.0
	 * @var string
	 */
	protected $textdomain = 'default';

	/**
	 * Translation controller instance.
	 *
	 * @since 6.5.0
	 * @var WP_Translation_Controller
	 */
	protected $controller;

	/**
	 * Constructor.
	 *
	 * @since 6.5.0
	 *
	 * @param WP_Translation_Controller $controller I18N controller.
	 * @param string                    $textdomain Optional. Text domain. Default 'default'.
	 */
	public function __construct( WP_Translation_Controller $controller, string $textdomain = 'default' ) {
		$this->controller = $controller;
		$this->textdomain = $textdomain;
	}

	/**
	 * Magic getter for backward compatibility.
	 *
	 * @since 6.5.0
	 *
	 * @param string $name Property name.
	 * @return mixed
	 */
	public function __get( string $name ) {
		if ( 'entries' === $name ) {
			$entries = $this->controller->get_entries( $this->textdomain );

			$result = array();

			foreach ( $entries as $original => $translations ) {
				$result[] = $this->make_entry( $original, $translations );
			}

			return $result;
		}

		if ( 'headers' === $name ) {
			return $this->controller->get_headers( $this->textdomain );
		}

		return null;
	}

	/**
	 * Builds a Translation_Entry from original string and translation strings.
	 *
	 * @see MO::make_entry()
	 *
	 * @since 6.5.0
	 *
	 * @param string $original     Original string to translate from MO file. Might contain
	 *                             0x04 as context separator or 0x00 as singular/plural separator.
	 * @param string $translations Translation strings from MO file.
	 * @return Translation_Entry Entry instance.
	 */
	private function make_entry( $original, $translations ): Translation_Entry {
		$entry = new Translation_Entry();

		// Look for context, separated by 4.
		$parts = explode( "4", $original );
		if ( isset( $parts[1] ) ) {
			$original       = $parts[1];
			$entry->context = $parts[0];
		}

		$entry->singular     = $original;
		$entry->translations = explode( "", $translations );
		$entry->is_plural    = count( $entry->translations ) > 1;

		return $entry;
	}

	/**
	 * Translates a plural string.
	 *
	 * @since 6.5.0
	 *
	 * @param string|null $singular Singular string.
	 * @param string|null $plural   Plural string.
	 * @param int|float   $count    Count. Should be an integer, but some plugins pass floats.
	 * @param string|null $context  Context.
	 * @return string|null Translation if it exists, or the unchanged singular string.
	 */
	public function translate_plural( $singular, $plural, $count = 1, $context = '' ) {
		if ( null === $singular || null === $plural ) {
			return $singular;
		}

		$translation = $this->controller->translate_plural( array( $singular, $plural ), (int) $count, (string) $context, $this->textdomain );
		if ( false !== $translation ) {
			return $translation;
		}

		// Fall back to the original with English grammar rules.
		return ( 1 === (int) $count ? $singular : $plural );
	}

	/**
	 * Translates a singular string.
	 *
	 * @since 6.5.0
	 *
	 * @param string|null $singular Singular string.
	 * @param string|null $context  Context.
	 * @return string|null Translation if it exists, or the unchanged singular string
	 */
	public function translate( $singular, $context = '' ) {
		if ( null === $singular ) {
			return null;
		}

		$translation = $this->controller->translate( $singular, (string) $context, $this->textdomain );
		if ( false !== $translation ) {
			return $translation;
		}

		// Fall back to the original.
		return $singular;
	}
}

Changelog

Version Description
6.5.0 Introduced.