WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/23/2019 06:49:59 PM (11 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing @since tags for functions in wp-admin/includes/update.php.

Props sathyapulse, zodiac1978.
Fixes #48777.

File:
1 edited

Legend:

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

    r46185 r46763  
    99/**
    1010 * Selects the first update version from the update_core option.
     11 *
     12 * @since 2.7.0
    1113 *
    1214 * @return object|array|false The response from the API on success, false on failure.
     
    2426
    2527/**
    26  * Get available core updates.
     28 * Gets available core updates.
     29 *
     30 * @since 2.7.0
    2731 *
    2832 * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
     
    7377
    7478/**
    75  * Gets the best available (and enabled) Auto-Update for WordPress Core.
    76  *
    77  * If there's 1.2.3 and 1.3 on offer, it'll choose 1.3 if the installation allows it, else, 1.2.3
     79 * Gets the best available (and enabled) Auto-Update for WordPress core.
     80 *
     81 * If there's 1.2.3 and 1.3 on offer, it'll choose 1.3 if the installation allows it, else, 1.2.3.
    7882 *
    7983 * @since 3.7.0
    8084 *
    81  * @return array|false False on failure, otherwise the core update offering.
     85 * @return object|false The core update offering on success, false on failure.
    8286 */
    8387function find_core_auto_update() {
     
    114118 * @param string $version Version string to query.
    115119 * @param string $locale  Locale to query.
    116  * @return bool|array False on failure. An array of checksums on success.
     120 * @return array|false An array of checksums on success, false on failure.
    117121 */
    118122function get_core_checksums( $version, $locale ) {
     
    157161
    158162/**
     163 * Dismisses core update.
     164 *
     165 * @since 2.7.0
     166 *
    159167 * @param object $update
    160168 * @return bool
     
    167175
    168176/**
     177 * Undismisses core update.
     178 *
     179 * @since 2.7.0
     180 *
    169181 * @param string $version
    170182 * @param string $locale
     
    184196
    185197/**
    186  * @param string $version
    187  * @param string $locale
    188  * @return object|false
     198 * Finds the available update for WordPress core.
     199 *
     200 * @since 2.7.0
     201 *
     202 * @param string $version Version string to find the update for.
     203 * @param string $locale  Locale to find the update for.
     204 * @return object|false The core update offering on success, false on failure.
    189205 */
    190206function find_core_update( $version, $locale ) {
     
    205221
    206222/**
     223 * @since 2.3.0
     224 *
    207225 * @param string $msg
    208226 * @return string
     
    256274
    257275/**
     276 * @since 2.3.0
     277 *
    258278 * @global string $pagenow
    259279 * @return false|void
     
    302322}
    303323
    304 // Called directly from dashboard
     324/**
     325 * Displays WordPress version and active theme in the 'At a Glance' dashboard widget.
     326 *
     327 * @since 2.5.0
     328 */
    305329function update_right_now_message() {
    306330    $theme_name = wp_get_theme();
     
    381405/**
    382406 * Displays update information for a plugin.
     407 *
     408 * @since 2.3.0
    383409 *
    384410 * @param string $file        Plugin basename.
     
    541567
    542568/**
     569 * @since 2.9.0
     570 *
    543571 * @return array
    544572 */
     
    579607/**
    580608 * Displays update information for a theme.
     609 *
     610 * @since 3.1.0
    581611 *
    582612 * @param string   $theme_key Theme stylesheet.
     
    688718
    689719/**
     720 * @since 2.7.0
     721 *
    690722 * @global int $upgrading
    691723 * @return false|void
Note: See TracChangeset for help on using the changeset viewer.