Skip to content

Commit 68f5aa6

Browse files
audrasjbaudrasjb
committed
Docs: Use third-person singular verbs for function descriptions in the Core Translation API.
See #55646. git-svn-id: https://develop.svn.wordpress.org/trunk@53474 602fd350-edb4-49c9-b593-d223f7449a82
1 parent a147212 commit 68f5aa6

1 file changed

Lines changed: 27 additions & 27 deletions

File tree

‎src/wp-includes/l10n.php‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ function get_user_locale( $user_id = 0 ) {
110110
}
111111

112112
/**
113-
* Determine the current locale desired for the request.
113+
* Determines the current locale desired for the request.
114114
*
115115
* @since 5.0.0
116116
*
@@ -167,7 +167,7 @@ function determine_locale() {
167167
}
168168

169169
/**
170-
* Retrieve the translation of $text.
170+
* Retrieves the translation of $text.
171171
*
172172
* If there is no translation, or the text domain isn't loaded, the original text is returned.
173173
*
@@ -213,7 +213,7 @@ function translate( $text, $domain = 'default' ) {
213213
}
214214

215215
/**
216-
* Remove last item on a pipe-delimited string.
216+
* Removes last item on a pipe-delimited string.
217217
*
218218
* Meant for removing the last item in a string, such as 'Role name|User role'. The original
219219
* string will be returned if no pipe '|' characters are found in the string.
@@ -233,7 +233,7 @@ function before_last_bar( $string ) {
233233
}
234234

235235
/**
236-
* Retrieve the translation of $text in the context defined in $context.
236+
* Retrieves the translation of $text in the context defined in $context.
237237
*
238238
* If there is no translation, or the text domain isn't loaded, the original text is returned.
239239
*
@@ -282,7 +282,7 @@ function translate_with_gettext_context( $text, $context, $domain = 'default' )
282282
}
283283

284284
/**
285-
* Retrieve the translation of $text.
285+
* Retrieves the translation of $text.
286286
*
287287
* If there is no translation, or the text domain isn't loaded, the original text is returned.
288288
*
@@ -298,7 +298,7 @@ function __( $text, $domain = 'default' ) {
298298
}
299299

300300
/**
301-
* Retrieve the translation of $text and escapes it for safe use in an attribute.
301+
* Retrieves the translation of $text and escapes it for safe use in an attribute.
302302
*
303303
* If there is no translation, or the text domain isn't loaded, the original text is returned.
304304
*
@@ -314,7 +314,7 @@ function esc_attr__( $text, $domain = 'default' ) {
314314
}
315315

316316
/**
317-
* Retrieve the translation of $text and escapes it for safe use in HTML output.
317+
* Retrieves the translation of $text and escapes it for safe use in HTML output.
318318
*
319319
* If there is no translation, or the text domain isn't loaded, the original text
320320
* is escaped and returned.
@@ -331,7 +331,7 @@ function esc_html__( $text, $domain = 'default' ) {
331331
}
332332

333333
/**
334-
* Display translated text.
334+
* Displays translated text.
335335
*
336336
* @since 1.2.0
337337
*
@@ -344,7 +344,7 @@ function _e( $text, $domain = 'default' ) {
344344
}
345345

346346
/**
347-
* Display translated text that has been escaped for safe use in an attribute.
347+
* Displays translated text that has been escaped for safe use in an attribute.
348348
*
349349
* Encodes `< > & " '` (less than, greater than, ampersand, double quote, single quote).
350350
* Will never double encode entities.
@@ -362,7 +362,7 @@ function esc_attr_e( $text, $domain = 'default' ) {
362362
}
363363

364364
/**
365-
* Display translated text that has been escaped for safe use in HTML output.
365+
* Displays translated text that has been escaped for safe use in HTML output.
366366
*
367367
* If there is no translation, or the text domain isn't loaded, the original text
368368
* is escaped and displayed.
@@ -380,7 +380,7 @@ function esc_html_e( $text, $domain = 'default' ) {
380380
}
381381

382382
/**
383-
* Retrieve translated string with gettext context.
383+
* Retrieves translated string with gettext context.
384384
*
385385
* Quite a few times, there will be collisions with similar translatable text
386386
* found in more than two places, but with different translated context.
@@ -401,7 +401,7 @@ function _x( $text, $context, $domain = 'default' ) {
401401
}
402402

403403
/**
404-
* Display translated string with gettext context.
404+
* Displays translated string with gettext context.
405405
*
406406
* @since 3.0.0
407407
*
@@ -415,7 +415,7 @@ function _ex( $text, $context, $domain = 'default' ) {
415415
}
416416

417417
/**
418-
* Translate string with gettext context, and escapes it for safe use in an attribute.
418+
* Translates string with gettext context, and escapes it for safe use in an attribute.
419419
*
420420
* If there is no translation, or the text domain isn't loaded, the original text
421421
* is escaped and returned.
@@ -433,7 +433,7 @@ function esc_attr_x( $text, $context, $domain = 'default' ) {
433433
}
434434

435435
/**
436-
* Translate string with gettext context, and escapes it for safe use in HTML output.
436+
* Translates string with gettext context, and escapes it for safe use in HTML output.
437437
*
438438
* If there is no translation, or the text domain isn't loaded, the original text
439439
* is escaped and returned.
@@ -686,7 +686,7 @@ function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' )
686686
}
687687

688688
/**
689-
* Load a .mo file into the text domain $domain.
689+
* Loads a .mo file into the text domain $domain.
690690
*
691691
* If the text domain already exists, the translations will be merged. If both
692692
* sets have the same string, the translation from the original value will be taken.
@@ -766,7 +766,7 @@ function load_textdomain( $domain, $mofile ) {
766766
}
767767

768768
/**
769-
* Unload translations for a text domain.
769+
* Unloads translations for a text domain.
770770
*
771771
* @since 3.0.0
772772
*
@@ -818,7 +818,7 @@ function unload_textdomain( $domain ) {
818818
}
819819

820820
/**
821-
* Load default translated strings based on locale.
821+
* Loads default translated strings based on locale.
822822
*
823823
* Loads the .mo file in WP_LANG_DIR constant path from WordPress root.
824824
* The translated (.mo) file is named based on the locale.
@@ -904,7 +904,7 @@ function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path
904904
}
905905

906906
/**
907-
* Load the translated strings for a plugin residing in the mu-plugins directory.
907+
* Loads the translated strings for a plugin residing in the mu-plugins directory.
908908
*
909909
* @since 3.0.0
910910
* @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
@@ -931,7 +931,7 @@ function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
931931
}
932932

933933
/**
934-
* Load the theme's translated strings.
934+
* Loads the theme's translated strings.
935935
*
936936
* If the current locale exists as a .mo file in the theme's root directory, it
937937
* will be included in the translated strings by the $domain.
@@ -972,7 +972,7 @@ function load_theme_textdomain( $domain, $path = false ) {
972972
}
973973

974974
/**
975-
* Load the child themes translated strings.
975+
* Loads the child themes translated strings.
976976
*
977977
* If the current locale exists as a .mo file in the child themes
978978
* root directory, it will be included in the translated strings by the $domain.
@@ -1299,7 +1299,7 @@ function _get_path_to_translation_from_lang_dir( $domain ) {
12991299
}
13001300

13011301
/**
1302-
* Return the Translations instance for a text domain.
1302+
* Returns the Translations instance for a text domain.
13031303
*
13041304
* If there isn't one, returns empty Translations instance.
13051305
*
@@ -1325,7 +1325,7 @@ function get_translations_for_domain( $domain ) {
13251325
}
13261326

13271327
/**
1328-
* Whether there are translations for the text domain.
1328+
* Determines whether there are translations for the text domain.
13291329
*
13301330
* @since 3.0.0
13311331
*
@@ -1364,7 +1364,7 @@ function translate_user_role( $name, $domain = 'default' ) {
13641364
}
13651365

13661366
/**
1367-
* Get all available languages based on the presence of *.mo files in a given directory.
1367+
* Gets all available languages based on the presence of *.mo files in a given directory.
13681368
*
13691369
* The default directory is WP_LANG_DIR.
13701370
*
@@ -1401,7 +1401,7 @@ function get_available_languages( $dir = null ) {
14011401
}
14021402

14031403
/**
1404-
* Get installed translations.
1404+
* Gets installed translations.
14051405
*
14061406
* Looks in the wp-content/languages directory for translations of
14071407
* plugins or themes.
@@ -1457,7 +1457,7 @@ function wp_get_installed_translations( $type ) {
14571457
}
14581458

14591459
/**
1460-
* Extract headers from a PO file.
1460+
* Extracts headers from a PO file.
14611461
*
14621462
* @since 3.7.0
14631463
*
@@ -1482,7 +1482,7 @@ function wp_get_pomo_file_data( $po_file ) {
14821482
}
14831483

14841484
/**
1485-
* Language selector.
1485+
* Displays or returns a Language selector.
14861486
*
14871487
* @since 4.0.0
14881488
* @since 4.3.0 Introduced the `echo` argument.
@@ -1712,7 +1712,7 @@ function restore_current_locale() {
17121712
}
17131713

17141714
/**
1715-
* Whether switch_to_locale() is in effect.
1715+
* Determines whether switch_to_locale() is in effect.
17161716
*
17171717
* @since 4.7.0
17181718
*

0 commit comments

Comments
 (0)