<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34781] trunk/src/wp-includes/l10n.php: Docs: Improve a variety of inline docs in wp-includes/l10n.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34781">34781</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34781","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-02 20:44:18 +0000 (Fri, 02 Oct 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve a variety of inline docs in wp-includes/l10n.php.
* Corrects phrasing used in the descriptions for and filters in `_n()` and `_nx()`, particularly with regard to the use of 'singular' instead of 'single' or '1', and 'plural' instead of 'not 1'.
* Adds example usage to `_n()`, `_nx()`, `_nx_noop()`, and `translate_nooped_plural()`.
* Adds hash notation `@return` doc for `_n_noop()` and `_nx_noop()`.
* Adds missing default values for the optional `$domain` parameter in several places.
Props johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/34127">#34127</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2015-10-02 20:23:54 UTC (rev 34780)
+++ trunk/src/wp-includes/l10n.php 2015-10-02 20:44:18 UTC (rev 34781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,12 +80,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If there is no translation, or the text domain isn't loaded, the original text is returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * *Note:* Don't use {@see translate()} directly, use `{@see __()} or related functions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * *Note:* Don't use translate() directly, use __() or related functions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function translate( $text, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,11 +130,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If there is no translation, or the text domain isn't loaded the original
</span><span class="cx" style="display: block; padding: 0 10px"> * text is returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * *Note:* Don't use translate_with_gettext_context() directly, use _x() or related functions.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text on success, original text on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -177,6 +181,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text on success, original text on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_attr__( $text, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,6 +197,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_html__( $text, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,6 +211,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _e( $text, $domain = 'default' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo translate( $text, $domain );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -217,6 +224,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_attr_e( $text, $domain = 'default' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo esc_attr( translate( $text, $domain ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -229,6 +237,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_html_e( $text, $domain = 'default' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo esc_html( translate( $text, $domain ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,6 +257,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated context string without pipe.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _x( $text, $context, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -262,6 +272,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated context string without pipe.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _ex( $text, $context, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -276,6 +287,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_attr_x( $text, $context, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -290,6 +302,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Text to translate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Translated text.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function esc_html_x( $text, $context, $domain = 'default' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,67 +310,77 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve the plural or single form based on the supplied amount.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Translates and retrieves the singular or plural form based on the supplied number.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the text domain is not set in the $l10n list, then a comparison will be made
- * and either $plural or $single parameters returned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Used when you want to use the appropriate form of a string based on whether a
+ * number is singular or plural.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the text domain does exist, then the parameters $single, $plural, and $number
- * will first be passed to the text domain's ngettext method. Then it will be passed
- * to the 'ngettext' filter hook along with the same parameters. The expected
- * type will be a string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Example:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * $people = sprintf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Either $single or $plural translated text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
+ * @return string The translated singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _n( $single, $plural, $number, $domain = 'default' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $translations = get_translations_for_domain( $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> $translation = $translations->translate_plural( $single, $plural, $number );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter text with its translation when plural option is available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the singular or plural form of a string.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $translation Translated text.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve the plural or single form based on the supplied amount with gettext context.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Translates and retrieves the singular or plural form based on the supplied number, with gettext context.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This is a hybrid of _n() and _x(). It supports contexts and plurals.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This is a hybrid of _n() and _x(). It supports context and plurals.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Used when you want to use the appropriate form of a string with context based on whether a
+ * number is singular or plural.
+ *
+ * Example:
+ *
+ * $people = sprintf( _n( '%s person', '%s people', $count, 'context', 'text-domain' ), number_format_i18n( $count ) );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Either $single or $plural translated text with context.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 'default'.
+ * @return string The translated singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _nx($single, $plural, $number, $context, $domain = 'default') {
</span><span class="cx" style="display: block; padding: 0 10px"> $translations = get_translations_for_domain( $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> $translation = $translations->translate_plural( $single, $plural, $number, $context );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter text with its translation while plural option and context are available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the singular or plural form of a string with gettext context.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $translation Translated text.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context information for the translators.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -365,55 +388,102 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Register plural strings in POT file, but don't translate them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers plural strings in POT file, but don't translate them.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Used when you want to keep structures with translatable plural
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * strings and use them later.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * strings and use them later when the number is known.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * $messages = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'post' => _n_noop( '%s post', '%s posts' ),
- * 'page' => _n_noop( '%s pages', '%s pages' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> * );
</span><span class="cx" style="display: block; padding: 0 10px"> * ...
</span><span class="cx" style="display: block; padding: 0 10px"> * $message = $messages[ $type ];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $singular Single form to be i18ned.
- * @param string $plural Plural form to be i18ned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array array($singular, $plural)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @type null $context Context information for the translators.
+ * @type string $domain Text domain.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _n_noop( $singular, $plural, $domain = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 0 => $singular, 1 => $plural, 'singular' => $singular, 'plural' => $plural, 'context' => null, 'domain' => $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Register plural strings with context in POT file, but don't translate them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Register plural strings with gettext context in the POT file, but don't translate them.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Used when you want to keep structures with translatable plural
+ * strings and use them later when the number is known.
+ *
+ * Example:
+ *
+ * $messages = array(
+ * 'post' => _n_noop( '%s post', '%s posts', 'context', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'context', 'text-domain' ),
+ * );
+ * ...
+ * $message = $messages[ $type ];
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $singular
- * @param string $plural
- * @param string $context
- * @param string|null $domain
- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $2 Context information for the translators. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @type string $context Context information for the translators.
+ * @type string $domain Text domain.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _nx_noop( $singular, $plural, $context, $domain = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 0 => $singular, 1 => $plural, 2 => $context, 'singular' => $singular, 'plural' => $plural, 'context' => $context, 'domain' => $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Translate the result of _n_noop() or _nx_noop().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Translates and retrieves the singular or plural form of a string that's been registered
+ * with _n_noop() or _nx_noop().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Used when you want to use a translatable plural string once the number is known.
+ *
+ * Example:
+ *
+ * $messages = array(
+ * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
+ * );
+ * ...
+ * $message = $messages[ $type ];
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
- * @param int $count Number of objects
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $nooped_plural Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().
+ * @param int $count Number of objects.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * a text domain passed to _n_noop() or _nx_noop(), it will override this value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Either $single or $plural translated text.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {
</span></span></pre>
</div>
</div>
</body>
</html>