云策 WordPress 开发者社区

函数文档

_nx_noop()

查看官方原文 ↗
💡 云策文档标注

概述

_nx_noop() 函数用于在 POT 文件中注册带有上下文信息的复数可翻译字符串，但不进行实际翻译。它适用于需要根据数量动态处理复数形式的场景，例如在后期结合 translate_nooped_plural() 函数使用。

关键要点

  • 注册复数字符串：将单数和复数形式及上下文信息存储在数组中，供后续翻译使用。
  • 参数说明：接受 $singular（单数形式）、$plural（复数形式）、$context（上下文）和可选的 $domain（文本域）。
  • 返回值：返回一个包含翻译信息的数组，包括原始字符串和上下文。
  • 使用场景：常用于需要根据动态数量（如文章或评论数量）显示不同复数形式的国际化字符串。

代码示例

$messages = array(
    'people'  => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
    'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
);
$message = $messages[ $type ];
printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );

注意事项

  • 此函数本身不执行翻译，仅注册字符串；实际翻译需配合 translate_nooped_plural() 函数。
  • 确保提供正确的上下文参数以消除歧义，特别是在类似短语有不同含义时。
  • 从 WordPress 2.8.0 版本开始引入，兼容性良好。
📄 原文内容

Registers plural strings with gettext context in POT file, but does not translate them.

Description

Used when you want to keep structures with translatable plural strings and use them later when the number is known.

Example of a generic phrase which is disambiguated via the context parameter:

$messages = array(
     'people'  => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
     'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
);
...
$message = $messages[ $type ];
printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );

Parameters

$singularstringrequired
Singular form to be localized.
$pluralstringrequired
Plural form to be localized.
$contextstringrequired
Context information for the translators.
$domainstringoptional
Text domain. Unique identifier for retrieving translated strings.

Default:null

Return

array Array of translation information for the strings.

  • 0 string
    Singular form to be localized. No longer used.
  • 1 string
    Plural form to be localized. No longer used.
  • 2 string
    Context information for the translators. No longer used.
  • singular string
    Singular form to be localized.
  • plural string
    Plural form to be localized.
  • context string
    Context information for the translators.
  • domain string|null
    Text domain.

Source

function _nx_noop( $singular, $plural, $context, $domain = null ) {
	return array(
		0          => $singular,
		1          => $plural,
		2          => $context,
		'singular' => $singular,
		'plural'   => $plural,
		'context'  => $context,
		'domain'   => $domain,
	);
}

View all references View on Trac View on GitHub

Used by Description
WP_MS_Sites_List_Table::get_views()wp-admin/includes/class-wp-ms-sites-list-table.php

Gets links to filter sites by status.
WP_Comments_List_Table::get_views()wp-admin/includes/class-wp-comments-list-table.php

Changelog

Version Description
2.8.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Codex


    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

    $labels = array(
	'draft' => array( _nx_noop( '%s Draft', '%s Drafts', 'post' ), _nx_noop( '%s Draft', '%s Drafts', 'page' ) ),
	'publish' => array( _nx_noop( '%s Published', '%s Published', 'post' ), _nx_noop( '%s Published', '%s Published', 'page' ) ),
);
if ( $post_type == 'page' ) {
	$labels = $labels[ $post_status ][1];
} else {
	$labels = $labels[ $post_status ][0];
}
$usable_text = sprintf( translate_nooped_plural( $labels, $count, $domain ), $count );