Make WordPress Core


Ignore:
Timestamp:
07/06/2023 02:15:00 PM (23 months ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs in various function descriptions of load.php, as per docblocks standards.

See #57840.

File:
1 edited

Legend:

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

    r56152 r56153  
    77
    88/**
    9  * Return the HTTP protocol sent by the server.
     9 * Returns the HTTP protocol sent by the server.
    1010 *
    1111 * @since 4.4.0
     
    2222
    2323/**
    24  * Fix `$_SERVER` variables for various setups.
     24 * Fixes `$_SERVER` variables for various setups.
    2525 *
    2626 * @since 3.0.0
     
    135135
    136136/**
    137  * Check for the required PHP version, and the MySQL extension or
     137 * Checks for the required PHP version, and the MySQL extension or
    138138 * a database drop-in.
    139139 *
     
    311311
    312312/**
    313  * Don't load all of WordPress when handling a favicon.ico request.
     313 * Ensures all of WordPress is not loaded when handling a favicon.ico request.
    314314 *
    315315 * Instead, send the headers for a zero-length favicon and bail.
     
    326326
    327327/**
    328  * Die with a maintenance message when conditions are met.
     328 * Dies with a maintenance message when conditions are met.
    329329 *
    330330 * The default message can be replaced by using a drop-in (maintenance.php in
     
    358358
    359359/**
    360  * Check if maintenance mode is enabled.
     360 * Checks if maintenance mode is enabled.
    361361 *
    362362 * Checks for a file in the WordPress root directory named ".maintenance".
     
    405405
    406406/**
    407  * Get the time elapsed so far during this PHP script.
     407 * Gets the time elapsed so far during this PHP script.
    408408 *
    409409 * Uses REQUEST_TIME_FLOAT that appeared in PHP 5.4.0.
     
    418418
    419419/**
    420  * Start the WordPress micro-timer.
     420 * Starts the WordPress micro-timer.
    421421 *
    422422 * @since 0.71
     
    435435
    436436/**
    437  * Retrieve or display the time from the page start to when function is called.
     437 * Retrieves or displays the time from the page start to when function is called.
    438438 *
    439439 * @since 0.71
     
    461461
    462462/**
    463  * Set PHP error reporting based on WordPress debug settings.
     463 * Sets PHP error reporting based on WordPress debug settings.
    464464 *
    465465 * Uses three constants: `WP_DEBUG`, `WP_DEBUG_DISPLAY`, and `WP_DEBUG_LOG`.
     
    561561
    562562/**
    563  * Set the location of the language directory.
     563 * Sets the location of the language directory.
    564564 *
    565565 * To set directory manually, define the `WP_LANG_DIR` constant
     
    606606
    607607/**
    608  * Load the database class file and instantiate the `$wpdb` global.
     608 * Loads the database class file and instantiates the `$wpdb` global.
    609609 *
    610610 * @since 2.5.0
     
    634634
    635635/**
    636  * Set the database table prefix and the format specifiers for database
     636 * Sets the database table prefix and the format specifiers for database
    637637 * table columns.
    638638 *
     
    705705
    706706/**
    707  * Toggle `$_wp_using_ext_object_cache` on and off without directly
     707 * Toggles `$_wp_using_ext_object_cache` on and off without directly
    708708 * touching global.
    709709 *
     
    725725
    726726/**
    727  * Start the WordPress object cache.
     727 * Starts the WordPress object cache.
    728728 *
    729729 * If an object-cache.php file exists in the wp-content directory,
     
    833833
    834834/**
    835  * Redirect to the installer if WordPress is not installed.
     835 * Redirects to the installer if WordPress is not installed.
    836836 *
    837837 * Dies with an error message when Multisite is enabled.
     
    861861
    862862/**
    863  * Retrieve an array of must-use plugin files.
     863 * Retrieves an array of must-use plugin files.
    864864 *
    865865 * The default directory is wp-content/mu-plugins. To change the default
     
    893893
    894894/**
    895  * Retrieve an array of active and valid plugin files.
     895 * Retrieves an array of active and valid plugin files.
    896896 *
    897897 * While upgrading or installing WordPress, no plugins are returned.
     
    10461046
    10471047/**
    1048  * Is WordPress in Recovery Mode.
     1048 * Determines whether WordPress is in Recovery Mode.
    10491049 *
    10501050 * In this mode, plugins or themes that cause WSODs will be paused.
     
    11441144
    11451145/**
    1146  * Set internal encoding.
     1146 * Sets internal encoding.
    11471147 *
    11481148 * In most cases the default internal encoding is latin1, which is
     
    11631163
    11641164/**
    1165  * Add magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`.
     1165 * Adds magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`.
    11661166 *
    11671167 * Also forces `$_REQUEST` to be `$_GET + $_POST`. If `$_SERVER`,
     
    12001200
    12011201/**
    1202  * Copy an object.
     1202 * Clones an object.
    12031203 *
    12041204 * @since 2.7.0
     
    13281328
    13291329/**
    1330  * If Multisite is enabled.
     1330 * Determines whether Multisite is enabled.
    13311331 *
    13321332 * @since 3.0.0
     
    13471347
    13481348/**
    1349  * Retrieve the current site ID.
     1349 * Retrieves the current site ID.
    13501350 *
    13511351 * @since 3.1.0
     
    13821382
    13831383/**
    1384  * Attempt an early load of translations.
     1384 * Attempts an early load of translations.
    13851385 *
    13861386 * Used for errors encountered during the initial loading process, before
     
    14871487
    14881488/**
    1489  * Check or set whether WordPress is in "installation" mode.
     1489 * Checks or sets whether WordPress is in "installation" mode.
    14901490 *
    14911491 * If the `WP_INSTALLING` constant is defined during the bootstrap, `wp_installing()` will default to `true`.
     
    17021702
    17031703/**
    1704  * Start scraping edited file errors.
     1704 * Starts scraping edited file errors.
    17051705 *
    17061706 * @since 4.9.0
     
    17311731
    17321732/**
    1733  * Finalize scraping for edited file errors.
     1733 * Finalizes scraping for edited file errors.
    17341734 *
    17351735 * @since 4.9.0
Note: See TracChangeset for help on using the changeset viewer.