Changeset 24825

Timestamp:

07/28/2013 09:26:10 PM (11 years ago)

Author:

nacin

Message:

Inline documentation for esc_attr_x() and esc_html_x(). props fjarrett, fixes #24212.

File:

• trunk/wp-includes/l10n.php (modified) (1 diff)

trunk/wp-includes/l10n.php

@@ -206 +206 @@
 }
 
-function esc_attr_x( $single, $context, $domain = 'default' ) {
-    return esc_attr( translate_with_gettext_context( $single, $context, $domain ) );
-}
-
-function esc_html_x( $single, $context, $domain = 'default' ) {
-    return esc_html( translate_with_gettext_context( $single, $context, $domain ) );
+/**
+ * Displays translated string with gettext context and escapes it for safe use in an attribute.
+ *
+ * @see esc_attr()
+ * @since 2.8.0
+ *
+ * @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
+ */
+function esc_attr_x( $text, $context, $domain = 'default' ) {
+    return esc_attr( translate_with_gettext_context( $text, $context, $domain ) );
+}
+
+/**
+ * Displays translated string with gettext context and escapes it for safe use in HTML output.
+ *
+ * @see esc_html()
+ * @since 2.9.0
+ *
+ * @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
+ */
+function esc_html_x( $text, $context, $domain = 'default' ) {
+    return esc_html( translate_with_gettext_context( $text, $context, $domain ) );
 }