<!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>[25586] trunk/src/wp-includes/l10n.php: Standardize usage of 'text domain' in inline documentation for 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">

<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25586">25586</a></dd>

<dt>Author</dt> <dd>DrewAPicture</dd>

<dt>Date</dt> <dd>2013-09-23 22:27:17 +0000 (Mon, 23 Sep 2013)</dd>

</dl>

<h3>Log Message</h3>

<pre>Standardize usage of 'text domain' in inline documentation for wp-includes/l10n.php.

Props ericlewis, SergeyBiryukov.

Fixes <a href="http://core.trac.wordpress.org/ticket/16750">#16750</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>Modified: trunk/src/wp-includes/l10n.php (25585 => 25586)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/src/wp-includes/l10n.php   2013-09-23 21:43:25 UTC (rev 25585)

+++ trunk/src/wp-includes/l10n.php      2013-09-23 22:27:17 UTC (rev 25586)

</span><span class="lines">@@ -60,14 +60,14 @@

</span><span class="cx"> /**

<span class="cx">  * Retrieve the translation of $text.

</span><span class="cx">  *

<del>- * If there is no translation, or the domain isn't loaded, the original text is returned.

</del><ins>+ * If there is no translation, or the text domain isn't loaded, the original text is returned.

</ins><span class="cx">  *

<span class="cx">  * Note: Don't use translate() directly, use __() or related functions.

</span><span class="cx">  *

</span><span class="cx">  * @since 2.2.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text

</span><span class="cx">  */

</span><span class="cx"> function translate( $text, $domain = 'default' ) {

</span><span class="lines">@@ -107,14 +107,14 @@

</span><span class="cx"> /**

<span class="cx">  * Retrieve the translation of $text in the context defined in $context.

</span><span class="cx">  *

</span><del>- * If there is no translation, or the domain isn't loaded the original

</del><ins>+ * If there is no translation, or the text domain isn't loaded the original

</ins><span class="cx">  * text is returned.

</span><span class="cx">  *

</span><span class="cx">  * @since 2.8.0

</span><span class="cx">  *

<span class="cx">  * @param string $text    Text to translate.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text on success, original text on failure.

</span><span class="cx">  */

</span><span class="cx"> function translate_with_gettext_context( $text, $context, $domain = 'default' ) {

</span><span class="lines">@@ -135,12 +135,12 @@

</span><span class="cx"> 

</span><span class="cx"> /**

</span><span class="cx">  * Retrieve the translation of $text. If there is no translation,

<del>- * or the domain isn't loaded, the original text is returned.

</del><ins>+ * or the text domain isn't loaded, the original text is returned.

</ins><span class="cx">  *

</span><span class="cx">  * @since 2.1.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text.

</span><span class="cx">  */

</span><span class="cx"> function __( $text, $domain = 'default' ) {

</span><span class="lines">@@ -150,12 +150,12 @@

</span><span class="cx"> /**

<span class="cx">  * Retrieve the translation of $text and escapes it for safe use in an attribute.

</span><span class="cx">  *

<del>- * If there is no translation, or the domain isn't loaded, the original text is returned.

</del><ins>+ * If there is no translation, or the text domain isn't loaded, the original text is returned.

</ins><span class="cx">  *

</span><span class="cx">  * @since 2.8.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text on success, original text on failure.

</span><span class="cx">  */

</span><span class="cx"> function esc_attr__( $text, $domain = 'default' ) {

</span><span class="lines">@@ -165,12 +165,12 @@

</span><span class="cx"> /**

<span class="cx">  * Retrieve the translation of $text and escapes it for safe use in HTML output.

</span><span class="cx">  *

<del>- * If there is no translation, or the domain isn't loaded, the original text is returned.

</del><ins>+ * If there is no translation, or the text domain isn't loaded, the original text is returned.

</ins><span class="cx">  *

</span><span class="cx">  * @since 2.8.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text

</span><span class="cx">  */

</span><span class="cx"> function esc_html__( $text, $domain = 'default' ) {

</span><span class="lines">@@ -183,7 +183,7 @@

</span><span class="cx">  * @since 1.2.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  */

</span><span class="cx"> function _e( $text, $domain = 'default' ) {

</span><span class="cx">  echo translate( $text, $domain );

</span><span class="lines">@@ -195,7 +195,7 @@

</span><span class="cx">  * @since 2.8.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  */

</span><span class="cx"> function esc_attr_e( $text, $domain = 'default' ) {

</span><span class="cx">  echo esc_attr( translate( $text, $domain ) );

</span><span class="lines">@@ -207,7 +207,7 @@

</span><span class="cx">  * @since 2.8.0

</span><span class="cx">  *

<span class="cx">  * @param string $text   Text to translate.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  */

</span><span class="cx"> function esc_html_e( $text, $domain = 'default' ) {

</span><span class="cx">  echo esc_html( translate( $text, $domain ) );

</span><span class="lines">@@ -226,7 +226,7 @@

</span><span class="cx">  *

<span class="cx">  * @param string $text    Text to translate.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated context string without pipe.

</span><span class="cx">  */

</span><span class="cx"> function _x( $text, $context, $domain = 'default' ) {

</span><span class="lines">@@ -240,7 +240,7 @@

</span><span class="cx">  *

<span class="cx">  * @param string $text    Text to translate.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated context string without pipe.

</span><span class="cx">  */

</span><span class="cx"> function _ex( $text, $context, $domain = 'default' ) {

</span><span class="lines">@@ -254,7 +254,7 @@

</span><span class="cx">  *

<span class="cx">  * @param string $text    Text to translate.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text

</span><span class="cx">  */

</span><span class="cx"> function esc_attr_x( $text, $context, $domain = 'default' ) {

</span><span class="lines">@@ -268,7 +268,7 @@

</span><span class="cx">  *

<span class="cx">  * @param string $text    Text to translate.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Translated text.

</span><span class="cx">  */

</span><span class="cx"> function esc_html_x( $text, $context, $domain = 'default' ) {

</span><span class="lines">@@ -278,11 +278,11 @@

</span><span class="cx"> /**

<span class="cx">  * Retrieve the plural or single form based on the supplied amount.

</span><span class="cx">  *

</span><del>- * If the domain is not set in the $l10n list, then a comparison will be made

</del><ins>+ * If the text domain is not set in the $l10n list, then a comparison will be made

</ins><span class="cx">  * and either $plural or $single parameters returned.

</span><span class="cx">  *

</span><del>- * If the domain does exist, then the parameters $single, $plural, and $number

- * will first be passed to the domain's ngettext method. Then it will be passed

</del><ins>+ * 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

</ins><span class="cx">  * to the 'ngettext' filter hook along with the same parameters. The expected

<span class="cx">  * type will be a string.

</span><span class="cx">  *

</span><span class="lines">@@ -291,7 +291,7 @@

<span class="cx">  * @param string $single The text that will be used if $number is 1.

<span class="cx">  * @param string $plural The text that will be used if $number is not 1.

<span class="cx">  * @param int    $number The number to compare against to use either $single or $plural.

<del>- * @param string $domain Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Either $single or $plural translated text.

</span><span class="cx">  */

</span><span class="cx"> function _n( $single, $plural, $number, $domain = 'default' ) {

</span><span class="lines">@@ -322,7 +322,7 @@

<span class="cx">  * @param string $plural  The text that will be used if $number is not 1.

<span class="cx">  * @param int    $number  The number to compare against to use either $single or $plural.

<span class="cx">  * @param string $context Context information for the translators.

<del>- * @param string $domain  Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return string Either $single or $plural translated text with context.

</span><span class="cx">  */

</span><span class="cx"> function _nx($single, $plural, $number, $context, $domain = 'default') {

</span><span class="lines">@@ -364,7 +364,7 @@

</span><span class="cx">  *

<span class="cx">  * @param string $singular Single form to be i18ned.

<span class="cx">  * @param string $plural   Plural form to be i18ned.

<del>- * @param string $domain   Optional. Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain   Optional. Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return array array($singular, $plural)

</span><span class="cx">  */

</span><span class="cx"> function _n_noop( $singular, $plural, $domain = null ) {

</span><span class="lines">@@ -387,8 +387,8 @@

</span><span class="cx">  *

</span><span class="cx">  * @param array  $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()

</span><span class="cx">  * @param int    $count         Number of objects

</span><del>- * @param string $domain        Optional. Unique identifier for retrieving translated strings. If $nooped_plural contains

- *                              a domain passed to _n_noop() or _nx_noop(), it will override this value.

</del><ins>+ * @param string $domain        Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains

+ *                              a text domain passed to _n_noop() or _nx_noop(), it will override this value.

</ins><span class="cx">  * @return string Either $single or $plural translated text.

</span><span class="cx">  */

</span><span class="cx"> function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {

</span><span class="lines">@@ -402,9 +402,9 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

<del>- * Load a .mo file into the domain $domain.

</del><ins>+ * Load a .mo file into the text domain $domain.

</ins><span class="cx">  *

</span><del>- * If the domain already exists, the translations will be merged. If both

</del><ins>+ * If the text domain already exists, the translations will be merged. If both

</ins><span class="cx">  * sets have the same string, the translation from the original value will be taken.

</span><span class="cx">  *

</span><span class="cx">  * On success, the .mo file will be placed in the $l10n global by $domain

</span><span class="lines">@@ -412,7 +412,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 1.5.0

</span><span class="cx">  *

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @param string $mofile Path to the .mo file.

<span class="cx">  * @return bool True on success, false on failure.

</span><span class="cx">  */

</span><span class="lines">@@ -468,18 +468,18 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

<del>- * Unload translations for a domain.

</del><ins>+ * Unload translations for a text domain.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.0.0

</span><span class="cx">  *

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return bool Whether textdomain was unloaded.

</span><span class="cx">  */

</span><span class="cx"> function unload_textdomain( $domain ) {

</span><span class="cx">  global $l10n;

</span><span class="cx"> 

</span><span class="cx">  /**

<del>-        * Filter text domain for loading translation.

</del><ins>+         * Filter text text domain for loading translation.

</ins><span class="cx">    *

</span><span class="cx">   * @since 3.0.0

</span><span class="cx">   *

</span><span class="lines">@@ -541,7 +541,7 @@

</span><span class="cx">  *

<span class="cx">  * If the path is not given then it will be the root of the plugin directory.

</span><span class="cx">  *

<del>- * The .mo file should be named based on the domain with a dash, and then the locale exactly.

</del><ins>+ * The .mo file should be named based on the text domain with a dash, and then the locale exactly.

</ins><span class="cx">  *

</span><span class="cx">  * @since 1.5.0

</span><span class="cx">  *

</span><span class="lines">@@ -585,7 +585,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 3.0.0

</span><span class="cx">  *

<del>- * @param string $domain             Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain             Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.

<span class="cx">  *                                   Default empty string.

<span class="cx">  * @return bool True when textdomain is successfully loaded, false otherwise.

</span><span class="lines">@@ -615,7 +615,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 1.5.0

</span><span class="cx">  *

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @param string $path   Optional. Path to the directory containing the .mo file.

<span class="cx">  *                       Default false.

<span class="cx">  * @return bool True when textdomain is successfully loaded, false otherwise.

</span><span class="lines">@@ -655,7 +655,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.9.0

</span><span class="cx">  *

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return bool True when the theme textdomain is successfully loaded, false otherwise.

</span><span class="cx">  */

</span><span class="cx"> function load_child_theme_textdomain( $domain, $path = false ) {

</span><span class="lines">@@ -665,11 +665,11 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

<del>- * Return the Translations instance for a domain.

</del><ins>+ * Return the Translations instance for a text domain.

</ins><span class="cx">  *

<span class="cx">  * If there isn't one, returns empty Translations instance.

</span><span class="cx">  *

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return Translations A Translations instance.

</span><span class="cx">  */

</span><span class="cx"> function get_translations_for_domain( $domain ) {

</span><span class="lines">@@ -681,10 +681,10 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span><del>- * Whether there are translations for the domain

</del><ins>+ * Whether there are translations for the text domain.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.0.0

<del>- * @param string $domain Unique identifier for retrieving translated strings.

</del><ins>+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.

</ins><span class="cx">  * @return bool Whether there are translations.

</span><span class="cx">  */

</span><span class="cx"> function is_textdomain_loaded( $domain ) {

</span></span></pre>

</div>

</div>

</body>

</html>