<!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>[25458] trunk/src/wp-includes/l10n.php: Update inline documentation for l10n functions.</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/25458">25458</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2013-09-16 20:16:58 +0000 (Mon, 16 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Update inline documentation for l10n functions. props CharlesClarkson, DrewAPicture. 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 (25457 => 25458)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/l10n.php 2013-09-16 20:13:36 UTC (rev 25457)
+++ trunk/src/wp-includes/l10n.php 2013-09-16 20:16:58 UTC (rev 25458)
</span><span class="lines">@@ -7,7 +7,7 @@
</span><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Gets the current locale.
</del><ins>+ * Get the current locale.
</ins><span class="cx"> *
</span><span class="cx"> * If the locale is set, then it will filter the locale in the 'locale' filter
</span><span class="cx"> * hook and return the value.
</span><span class="lines">@@ -20,8 +20,6 @@
</span><span class="cx"> * always be filtered using the 'locale' hook.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><del>- * @uses apply_filters() Calls 'locale' hook on locale value.
- * @uses $locale Gets the locale stored in the global.
</del><span class="cx"> *
</span><span class="cx"> * @return string The locale of the blog or from the 'locale' hook.
</span><span class="cx"> */
</span><span class="lines">@@ -52,16 +50,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieves the translation of $text. If there is no translation, or
- * the domain isn't loaded, the original text is returned.
</del><ins>+ * Retrieve the translation of $text.
</ins><span class="cx"> *
</span><del>- * @see __() Don't use translate() directly, use __()
</del><ins>+ * If there is no translation, or the domain isn't loaded, the original text is returned.
+ *
+ * <strong>Note:</strong> Don't use translate() directly, use __() or related functions.
+ *
</ins><span class="cx"> * @since 2.2.0
</span><del>- * @uses apply_filters() Calls 'gettext' on domain translated text
- * with the untranslated text as second parameter.
</del><span class="cx"> *
</span><del>- * @param string $text Text to translate.
- * @param string $domain Domain to retrieve the translated text.
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. 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">@@ -69,6 +67,17 @@
</span><span class="cx"> return apply_filters( 'gettext', $translations->translate( $text ), $text, $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Remove last item on a pipe-delimited string.
+ *
+ * Meant for removing the last item in a string, such as 'Role name|User role'. The original
+ * string will be returned if no pipe '|' characters are found in the string.
+ *
+ * @since 2.8.0
+ *
+ * @param string $string A pipe-delimited string.
+ * @return string Either $string or everything before the last pipe.
+ */
</ins><span class="cx"> function before_last_bar( $string ) {
</span><span class="cx"> $last_bar = strrpos( $string, '|' );
</span><span class="cx"> if ( false == $last_bar )
</span><span class="lines">@@ -77,52 +86,62 @@
</span><span class="cx"> return substr( $string, 0, $last_bar );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Retrieve the translation of $text in the context defined in $context.
+ *
+ * If there is no translation, or the domain isn't loaded the original
+ * text is returned.
+ *
+ * @since 2.8.0
+ *
+ * @param string $text Text to translate.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated text on success, original text on failure.
+ */
</ins><span class="cx"> function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
</span><span class="cx"> $translations = get_translations_for_domain( $domain );
</span><span class="cx"> return apply_filters( 'gettext_with_context', $translations->translate( $text, $context ), $text, $context, $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieves the translation of $text. If there is no translation, or
- * the domain isn't loaded, the original text is returned.
</del><ins>+ * Retrieve the translation of $text. If there is no translation,
+ * or the domain isn't loaded, the original text is returned.
</ins><span class="cx"> *
</span><del>- * @see translate() An alias of translate()
</del><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
- * @return string Translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated text.
</ins><span class="cx"> */
</span><span class="cx"> function __( $text, $domain = 'default' ) {
</span><span class="cx"> return translate( $text, $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieves the translation of $text and escapes it for safe use in an attribute.
</del><ins>+ * Retrieve the translation of $text and escapes it for safe use in an attribute.
+ *
</ins><span class="cx"> * If there is no translation, or the domain isn't loaded, the original text is returned.
</span><span class="cx"> *
</span><del>- * @see translate() An alias of translate()
- * @see esc_attr()
</del><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
- * @return string Translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated text on success, original text on failure.
</ins><span class="cx"> */
</span><span class="cx"> function esc_attr__( $text, $domain = 'default' ) {
</span><span class="cx"> return esc_attr( translate( $text, $domain ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieves the translation of $text and escapes it for safe use in HTML output.
</del><ins>+ * Retrieve the translation of $text and escapes it for safe use in HTML output.
+ *
</ins><span class="cx"> * If there is no translation, or the domain isn't loaded, the original text is returned.
</span><span class="cx"> *
</span><del>- * @see translate() An alias of translate()
- * @see esc_html()
</del><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. 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">@@ -130,90 +149,83 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays the returned translated text from translate().
</del><ins>+ * Display translated text.
</ins><span class="cx"> *
</span><del>- * @see translate() Echoes returned translate() string
</del><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. 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="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays translated text that has been escaped for safe use in an attribute.
</del><ins>+ * Display translated text that has been escaped for safe use in an attribute.
</ins><span class="cx"> *
</span><del>- * @see translate() Echoes returned translate() string
- * @see esc_attr()
</del><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. 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="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays translated text that has been escaped for safe use in HTML output.
</del><ins>+ * Display translated text that has been escaped for safe use in HTML output.
</ins><span class="cx"> *
</span><del>- * @see translate() Echoes returned translate() string
- * @see esc_html()
</del><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $domain Optional. Domain to retrieve the translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $domain Optional. 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="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve translated string with gettext context
</del><ins>+ * Retrieve translated string with gettext context.
</ins><span class="cx"> *
</span><span class="cx"> * Quite a few times, there will be collisions with similar translatable text
</span><del>- * found in more than two places but with different translated context.
</del><ins>+ * found in more than two places, but with different translated context.
</ins><span class="cx"> *
</span><del>- * By including the context in the pot file translators can translate the two
</del><ins>+ * By including the context in the pot file, translators can translate the two
</ins><span class="cx"> * strings differently.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $context Context information for the translators
- * @param string $domain Optional. Domain to retrieve the translated text
- * @return string Translated context string without pipe
</del><ins>+ * @param string $text Text to translate.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated context string without pipe.
</ins><span class="cx"> */
</span><span class="cx"> function _x( $text, $context, $domain = 'default' ) {
</span><span class="cx"> return translate_with_gettext_context( $text, $context, $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays translated string with gettext context
</del><ins>+ * Display translated string with gettext context.
</ins><span class="cx"> *
</span><del>- * @see _x
</del><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $context Context information for the translators
- * @param string $domain Optional. Domain to retrieve the translated text
- * @return string Translated context string without pipe
</del><ins>+ * @param string $text Text to translate.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated context string without pipe.
</ins><span class="cx"> */
</span><span class="cx"> function _ex( $text, $context, $domain = 'default' ) {
</span><span class="cx"> echo _x( $text, $context, $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays translated string with gettext context and escapes it for safe use in an attribute.
</del><ins>+ * Display translated string with gettext context, and escapes it for safe use in an attribute.
</ins><span class="cx"> *
</span><del>- * @see esc_attr()
</del><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $context Context information for the translators
- * @param string $domain Optional. Domain to retrieve the translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. 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">@@ -221,22 +233,21 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays translated string with gettext context and escapes it for safe use in HTML output.
</del><ins>+ * Display translated string with gettext context, and escapes it for safe use in HTML output.
</ins><span class="cx"> *
</span><del>- * @see esc_html()
</del><span class="cx"> * @since 2.9.0
</span><span class="cx"> *
</span><del>- * @param string $text Text to translate
- * @param string $context Context information for the translators
- * @param string $domain Optional. Domain to retrieve the translated text
- * @return string Translated text
</del><ins>+ * @param string $text Text to translate.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Translated text.
</ins><span class="cx"> */
</span><span class="cx"> function esc_html_x( $text, $context, $domain = 'default' ) {
</span><span class="cx"> return esc_html( translate_with_gettext_context( $text, $context, $domain ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve the plural or single form based on the amount.
</del><ins>+ * Retrieve the plural or single form based on the supplied amount.
</ins><span class="cx"> *
</span><span class="cx"> * If the domain is not set in the $l10n list, then a comparison will be made
</span><span class="cx"> * and either $plural or $single parameters returned.
</span><span class="lines">@@ -247,15 +258,12 @@
</span><span class="cx"> * type will be a string.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><del>- * @uses $l10n Gets list of domain translated string (gettext_reader) objects
- * @uses apply_filters() Calls 'ngettext' hook on domains text returned,
- * along with $single, $plural, and $number parameters. Expected to return string.
</del><span class="cx"> *
</span><del>- * @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
- * @param string $domain Optional. The domain identifier the text should be retrieved in
- * @return string Either $single or $plural translated text
</del><ins>+ * @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.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Either $single or $plural translated text.
</ins><span class="cx"> */
</span><span class="cx"> function _n( $single, $plural, $number, $domain = 'default' ) {
</span><span class="cx"> $translations = get_translations_for_domain( $domain );
</span><span class="lines">@@ -264,11 +272,18 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * A hybrid of _n() and _x(). It supports contexts and plurals.
</del><ins>+ * Retrieve the plural or single form based on the supplied amount with gettext context.
</ins><span class="cx"> *
</span><del>- * @see _n()
- * @see _x()
</del><ins>+ * This is a hybrid of _n() and _x(). It supports contexts and plurals.
</ins><span class="cx"> *
</span><ins>+ * @since 2.8.0
+ *
+ * @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.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Unique identifier for retrieving translated strings.
+ * @return string Either $single or $plural translated text with context.
</ins><span class="cx"> */
</span><span class="cx"> function _nx($single, $plural, $number, $context, $domain = 'default') {
</span><span class="cx"> $translations = get_translations_for_domain( $domain );
</span><span class="lines">@@ -279,22 +294,25 @@
</span><span class="cx"> /**
</span><span class="cx"> * Register plural strings in POT file, but don't translate them.
</span><span class="cx"> *
</span><del>- * Used when you want to keep structures with translatable plural strings and
- * use them later.
</del><ins>+ * Used when you want to keep structures with translatable plural
+ * strings and use them later.
</ins><span class="cx"> *
</span><span class="cx"> * Example:
</span><del>- * $messages = array(
</del><ins>+ * <code>
+ * $messages = array(
</ins><span class="cx"> * 'post' => _n_noop('%s post', '%s posts'),
</span><span class="cx"> * 'page' => _n_noop('%s pages', '%s pages')
</span><del>- * );
- * ...
- * $message = $messages[$type];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
</del><ins>+ * );
+ * ...
+ * $message = $messages[$type];
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
+ * </code>
</ins><span class="cx"> *
</span><del>- * @since 2.5
- * @param string $singular Single form to be i18ned
- * @param string $plural Plural form to be i18ned
- * @param string $domain Optional. The domain identifier the text will be retrieved in
</del><ins>+ * @since 2.5.0
+ *
+ * @param string $singular Single form to be i18ned.
+ * @param string $plural Plural form to be i18ned.
+ * @param string $domain Optional. 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">@@ -304,20 +322,22 @@
</span><span class="cx"> /**
</span><span class="cx"> * Register plural strings with context in POT file, but don't translate them.
</span><span class="cx"> *
</span><del>- * @see _n_noop()
</del><ins>+ * @since 2.8.0
</ins><span class="cx"> */
</span><span class="cx"> function _nx_noop( $singular, $plural, $context, $domain = null ) {
</span><span class="cx"> return array( 0 => $singular, 1 => $plural, 2 => $context, 'singular' => $singular, 'plural' => $plural, 'context' => $context, 'domain' => $domain );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Translate the result of _n_noop() or _nx_noop()
</del><ins>+ * Translate the result of _n_noop() or _nx_noop().
</ins><span class="cx"> *
</span><del>- * @since 3.1
- * @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
- * @param string $domain Optional. The domain identifier the text should be retrieved in. If $nooped_plural contains
- * a domain passed to _n_noop() or _nx_noop(), it will override this value.
</del><ins>+ * @since 3.1.0
+ *
+ * @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
+ * @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.
+ * @return string Either $single or $plural translated text.
</ins><span class="cx"> */
</span><span class="cx"> function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {
</span><span class="cx"> if ( $nooped_plural['domain'] )
</span><span class="lines">@@ -330,7 +350,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads a MO file into the domain $domain.
</del><ins>+ * Load a .mo file into the domain $domain.
</ins><span class="cx"> *
</span><span class="cx"> * If the domain already exists, the translations will be merged. If both
</span><span class="cx"> * sets have the same string, the translation from the original value will be taken.
</span><span class="lines">@@ -339,11 +359,10 @@
</span><span class="cx"> * and will be a MO object.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><del>- * @uses $l10n Gets list of domain translated string objects
</del><span class="cx"> *
</span><del>- * @param string $domain Unique identifier for retrieving translated strings
- * @param string $mofile Path to the .mo file
- * @return bool True on success, false on failure
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @param string $mofile Path to the .mo file.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function load_textdomain( $domain, $mofile ) {
</span><span class="cx"> global $l10n;
</span><span class="lines">@@ -372,11 +391,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Unloads translations for a domain
</del><ins>+ * Unload translations for a domain.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @param string $domain Textdomain to be unloaded
- * @return bool Whether textdomain was unloaded
</del><ins>+ *
+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @return bool Whether textdomain was unloaded.
</ins><span class="cx"> */
</span><span class="cx"> function unload_textdomain( $domain ) {
</span><span class="cx"> global $l10n;
</span><span class="lines">@@ -397,11 +417,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads default translated strings based on locale.
</del><ins>+ * Load default translated strings based on locale.
</ins><span class="cx"> *
</span><del>- * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The
- * translated (.mo) file is named based on the locale.
</del><ins>+ * Loads the .mo file in WP_LANG_DIR constant path from WordPress root.
+ * The translated (.mo) file is named based on the locale.
</ins><span class="cx"> *
</span><ins>+ * @see load_textdomain()
+ *
</ins><span class="cx"> * @since 1.5.0
</span><span class="cx"> */
</span><span class="cx"> function load_default_textdomain() {
</span><span class="lines">@@ -423,26 +445,26 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads the plugin's translated strings.
</del><ins>+ * Load a plugin's translated strings.
</ins><span class="cx"> *
</span><span class="cx"> * If the path is not given then it will be the root of the plugin directory.
</span><ins>+ *
</ins><span class="cx"> * The .mo file should be named based on the domain with a dash, and then the locale exactly.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $domain Unique identifier for retrieving translated strings
- * @param string $abs_rel_path Optional. Relative path to ABSPATH of a folder,
- * where the .mo file resides. Deprecated, but still functional until 2.7
- * @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings
+ * @param string $deprecated Use the $plugin_rel_path parameter instead.
+ * @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
</ins><span class="cx"> */
</span><del>-function load_plugin_textdomain( $domain, $abs_rel_path = false, $plugin_rel_path = false ) {
</del><ins>+function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
</ins><span class="cx"> $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
</span><span class="cx">
</span><span class="cx"> if ( false !== $plugin_rel_path ) {
</span><span class="cx"> $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
</span><del>- } else if ( false !== $abs_rel_path ) {
</del><ins>+ } else if ( false !== $deprecated ) {
</ins><span class="cx"> _deprecated_argument( __FUNCTION__, '2.7' );
</span><del>- $path = ABSPATH . trim( $abs_rel_path, '/' );
</del><ins>+ $path = ABSPATH . trim( $deprecated, '/' );
</ins><span class="cx"> } else {
</span><span class="cx"> $path = WP_PLUGIN_DIR;
</span><span class="cx"> }
</span><span class="lines">@@ -458,13 +480,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Load the translated strings for a plugin residing in the mu-plugins dir.
</del><ins>+ * Load the translated strings for a plugin residing in the mu-plugins directory.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string $domain Unique identifier for retrieving translated strings
- * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which
- * the MO file resides. Defaults to empty string.
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.
+ * Default empty string.
+ * @return bool True when textdomain is successfully loaded, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
</span><span class="cx"> $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
</span><span class="lines">@@ -481,7 +504,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads the theme's translated strings.
</del><ins>+ * Load the theme's translated strings.
</ins><span class="cx"> *
</span><span class="cx"> * If the current locale exists as a .mo file in the theme's root directory, it
</span><span class="cx"> * will be included in the translated strings by the $domain.
</span><span class="lines">@@ -490,7 +513,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $domain Unique identifier for retrieving translated strings
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @return bool True when textdomain is successfully loaded, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function load_theme_textdomain( $domain, $path = false ) {
</span><span class="cx"> $locale = apply_filters( 'theme_locale', get_locale(), $domain );
</span><span class="lines">@@ -509,16 +533,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads the child themes translated strings.
</del><ins>+ * Load the child themes translated strings.
</ins><span class="cx"> *
</span><del>- * If the current locale exists as a .mo file in the child themes root directory, it
- * will be included in the translated strings by the $domain.
</del><ins>+ * If the current locale exists as a .mo file in the child themes
+ * root directory, it will be included in the translated strings by the $domain.
</ins><span class="cx"> *
</span><span class="cx"> * The .mo files must be named based on the locale exactly.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><span class="cx"> *
</span><del>- * @param string $domain Unique identifier for retrieving translated strings
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @return bool True when the theme textdomain is successfully loaded, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function load_child_theme_textdomain( $domain, $path = false ) {
</span><span class="cx"> if ( ! $path )
</span><span class="lines">@@ -527,11 +552,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns the Translations instance for a domain. If there isn't one,
- * returns empty Translations instance.
</del><ins>+ * Return the Translations instance for a domain.
</ins><span class="cx"> *
</span><del>- * @param string $domain
- * @return object A Translation instance
</del><ins>+ * If there isn't one, returns empty Translations instance.
+ *
+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @return Translations A Translations instance.
</ins><span class="cx"> */
</span><span class="cx"> function get_translations_for_domain( $domain ) {
</span><span class="cx"> global $l10n;
</span><span class="lines">@@ -545,8 +571,8 @@
</span><span class="cx"> * Whether there are translations for the domain
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @param string $domain
- * @return bool Whether there are translations
</del><ins>+ * @param string $domain Unique identifier for retrieving translated strings.
+ * @return bool Whether there are translations.
</ins><span class="cx"> */
</span><span class="cx"> function is_textdomain_loaded( $domain ) {
</span><span class="cx"> global $l10n;
</span><span class="lines">@@ -554,26 +580,36 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Translates role name. Since the role names are in the database and
- * not in the source there are dummy gettext calls to get them into the POT
- * file and this function properly translates them back.
</del><ins>+ * Translates role name.
</ins><span class="cx"> *
</span><ins>+ * Since the role names are in the database and not in the source there
+ * are dummy gettext calls to get them into the POT file and this function
+ * properly translates them back.
+ *
</ins><span class="cx"> * The before_last_bar() call is needed, because older installs keep the roles
</span><span class="cx"> * using the old context format: 'Role name|User role' and just skipping the
</span><span class="cx"> * content after the last bar is easier than fixing them in the DB. New installs
</span><span class="cx"> * won't suffer from that problem.
</span><ins>+ *
+ * @since 2.8.0
+ *
+ * @param string $name The role name.
+ * @return string Translated role name on success, original name on failure.
</ins><span class="cx"> */
</span><span class="cx"> function translate_user_role( $name ) {
</span><span class="cx"> return translate_with_gettext_context( before_last_bar($name), 'User role' );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR.
</del><ins>+ * Get all available languages based on the presence of *.mo files in a given directory.
</ins><span class="cx"> *
</span><ins>+ * The default directory is WP_LANG_DIR.
+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR.
- * @return array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
</del><ins>+ * @param string $dir A directory to search for language files.
+ * Default WP_LANG_DIR.
+ * @return array An array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
</ins><span class="cx"> */
</span><span class="cx"> function get_available_languages( $dir = null ) {
</span><span class="cx"> $languages = array();
</span><span class="lines">@@ -586,4 +622,4 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return $languages;
</span><del>-}
</del><span class="cx">\ No newline at end of file
</span><ins>+}
</ins></span></pre>
</div>
</div>
</body>
</html>