Make WordPress Core

Changeset 53474


Ignore:
Timestamp:
06/07/2022 05:16:30 AM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in the Core Translation API.

See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/l10n.php

    r53060 r53474  
    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
     
    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.
     
    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
     
    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.
     
    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.
     
    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.
     
    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
     
    332332
    333333/**
    334  * Display translated text.
     334 * Displays translated text.
    335335 *
    336336 * @since 1.2.0
     
    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).
     
    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
     
    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
     
    402402
    403403/**
    404  * Display translated string with gettext context.
     404 * Displays translated string with gettext context.
    405405 *
    406406 * @since 3.0.0
     
    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
     
    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
     
    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
     
    767767
    768768/**
    769  * Unload translations for a text domain.
     769 * Unloads translations for a text domain.
    770770 *
    771771 * @since 3.0.0
     
    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.
     
    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
     
    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
     
    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
     
    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.
     
    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
     
    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.
     
    14021402
    14031403/**
    1404  * Get installed translations.
     1404 * Gets installed translations.
    14051405 *
    14061406 * Looks in the wp-content/languages directory for translations of
     
    14581458
    14591459/**
    1460  * Extract headers from a PO file.
     1460 * Extracts headers from a PO file.
    14611461 *
    14621462 * @since 3.7.0
     
    14831483
    14841484/**
    1485  * Language selector.
     1485 * Displays or returns a Language selector.
    14861486 *
    14871487 * @since 4.0.0
     
    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
Note: See TracChangeset for help on using the changeset viewer.