WordPress.org
Get WordPress

Make WordPress Core

Ticket #51126: 51126.2.diff

File 51126.2.diff, 11.3 KB (added by audrasjb, 5 years ago)

Added update offer documentation in other functions/hooks

  • src/wp-admin/includes/class-wp-automatic-updater.php 

    diff --git a/src/wp-admin/includes/class-wp-automatic-updater.php b/src/wp-admin/includes/class-wp-automatic-updater.php
index 641db4b325..0e5e17ab3c 100644
    a b class WP_Automatic_Updater {  
    131131         *
    132132         * @param string $type    The type of update being checked: 'core', 'theme',
    133133         *                        'plugin', 'translation'.
    134          * @param object $item    The update offer.
     134         * @param object $item {
     135         *     The update offer.
     136         *
     137         *     @type string   $current            The version number of the update offer.
     138         *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     139         *                                        remotely disabled via the update API response.
     140         *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     141         *     @type string   $download           URL to the ZIP file for the update.
     142         *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     143         *     @type string   $mysql_version      Minimum required MySQL version for the update.
     144         *     @type object   $packages {
     145         *         URLs for various ZIP packages for the update.
     146         *
     147         *         @type false|string $full        URL to the full ZIP package.
     148         *         @type false|string $no_content  URL to the no content ZIP package.
     149         *         @type false|string $new_bundled URL to the new bundled ZIP package.
     150         *         @type false|string $partial     URL to the partial ZIP package.
     151         *         @type false|string $rollback    URL to the rollback ZIP package.
     152         *     }
     153         *     @type string   $php_version        Minimum required PHP version for the update.
     154         *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     155         *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     156         * }
    135157         * @param string $context The filesystem context (a path) against which filesystem
    136158         *                        access and status should be checked.
    137159         * @return bool True if the item should be updated, false otherwise.
    … … class WP_Automatic_Updater {  
    206228                 *
    207229                 * @param bool|null $update Whether to update. The value of null is internally used
    208230                 *                          to detect whether nothing has hooked into this filter.
    209                  * @param object    $item   The update offer.
     231                 * @param object    $item {
     232                 *     The update offer.
     233                 *
     234                 *     @type string   $current            The version number of the update offer.
     235                 *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     236                 *                                        remotely disabled via the update API response.
     237                 *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     238                 *     @type string   $download           URL to the ZIP file for the update.
     239                 *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     240                 *     @type string   $mysql_version      Minimum required MySQL version for the update.
     241                 *     @type object   $packages {
     242                 *         URLs for various ZIP packages for the update.
     243                 *
     244                 *         @type false|string $full        URL to the full ZIP package.
     245                 *         @type false|string $no_content  URL to the no content ZIP package.
     246                 *         @type false|string $new_bundled URL to the new bundled ZIP package.
     247                 *         @type false|string $partial     URL to the partial ZIP package.
     248                 *         @type false|string $rollback    URL to the rollback ZIP package.
     249                 *     }
     250                 *     @type string   $php_version        Minimum required PHP version for the update.
     251                 *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     252                 *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     253                 * }
    210254                 */
    211255                $update = apply_filters( "auto_update_{$type}", $update, $item );
    212256
    … … class WP_Automatic_Updater {  
    248292         *
    249293         * @since 3.7.0
    250294         *
    251          * @param object $item The update offer.
     295         * @param object $item {
     296         *     The update offer.
     297         *
     298         *     @type string   $current            The version number of the update offer.
     299         *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     300         *                                        remotely disabled via the update API response.
     301         *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     302         *     @type string   $download           URL to the ZIP file for the update.
     303         *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     304         *     @type string   $mysql_version      Minimum required MySQL version for the update.
     305         *     @type object   $packages {
     306         *         URLs for various ZIP packages for the update.
     307         *
     308         *         @type false|string $full        URL to the full ZIP package.
     309         *         @type false|string $no_content  URL to the no content ZIP package.
     310         *         @type false|string $new_bundled URL to the new bundled ZIP package.
     311         *         @type false|string $partial     URL to the partial ZIP package.
     312         *         @type false|string $rollback    URL to the rollback ZIP package.
     313         *     }
     314         *     @type string   $php_version        Minimum required PHP version for the update.
     315         *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     316         *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     317         * }
    252318         * @return bool True if the site administrator is notified of a core update,
    253319         *              false otherwise.
    254320         */
    … … class WP_Automatic_Updater {  
    283349                 * @since 3.7.0
    284350                 *
    285351                 * @param bool   $notify Whether the site administrator is notified.
    286                  * @param object $item   The update offer.
     352                 * @param object $item {
     353                 *     The update offer.
     354                 *
     355                 *     @type string   $current            The version number of the update offer.
     356                 *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     357                 *                                        remotely disabled via the update API response.
     358                 *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     359                 *     @type string   $download           URL to the ZIP file for the update.
     360                 *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     361                 *     @type string   $mysql_version      Minimum required MySQL version for the update.
     362                 *     @type object   $packages {
     363                 *         URLs for various ZIP packages for the update.
     364                 *
     365                 *         @type false|string $full        URL to the full ZIP package.
     366                 *         @type false|string $no_content  URL to the no content ZIP package.
     367                 *         @type false|string $new_bundled URL to the new bundled ZIP package.
     368                 *         @type false|string $partial     URL to the partial ZIP package.
     369                 *         @type false|string $rollback    URL to the rollback ZIP package.
     370                 *     }
     371                 *     @type string   $php_version        Minimum required PHP version for the update.
     372                 *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     373                 *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     374                 * }
    287375                 */
    288376                if ( ! apply_filters( 'send_core_update_notification_email', $notify, $item ) ) {
    289377                        return false;
    … … class WP_Automatic_Updater {  
    299387         * @since 3.7.0
    300388         *
    301389         * @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
    302          * @param object $item The update offer.
     390         * @param object $item {
     391         *     The update offer.
     392         *
     393         *     @type string   $current            The version number of the update offer.
     394         *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     395         *                                        remotely disabled via the update API response.
     396         *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     397         *     @type string   $download           URL to the ZIP file for the update.
     398         *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     399         *     @type string   $mysql_version      Minimum required MySQL version for the update.
     400         *     @type object   $packages {
     401         *         URLs for various ZIP packages for the update.
     402         *
     403         *         @type false|string $full        URL to the full ZIP package.
     404         *         @type false|string $no_content  URL to the no content ZIP package.
     405         *         @type false|string $new_bundled URL to the new bundled ZIP package.
     406         *         @type false|string $partial     URL to the partial ZIP package.
     407         *         @type false|string $rollback    URL to the rollback ZIP package.
     408         *     }
     409         *     @type string   $php_version        Minimum required PHP version for the update.
     410         *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     411         *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     412         * }
    303413         * @return null|WP_Error
    304414         */
    305415        public function update( $type, $item ) {
    … … class WP_Automatic_Updater {  
    337447                 * @since 4.4.0
    338448                 *
    339449                 * @param string $type    The type of update being checked: 'core', 'theme', 'plugin', or 'translation'.
    340                  * @param object $item    The update offer.
     450                 * @param object $item {
     451                 *     The update offer.
     452                 *
     453                 *     @type string   $current            The version number of the update offer.
     454                 *     @type bool     $disable_autoupdate Whether automatic updates for this particular update offer have been
     455                 *                                        remotely disabled via the update API response.
     456                 *     @type bool     $dismissed          Whether this update offer has previously been dismissed.
     457                 *     @type string   $download           URL to the ZIP file for the update.
     458                 *     @type string   $locale             Locale of the update offer, eg. `en_US`.
     459                 *     @type string   $mysql_version      Minimum required MySQL version for the update.
     460                 *     @type object   $packages {
     461                 *         URLs for various ZIP packages for the update.
     462                 *
     463                 *         @type false|string $full        URL to the full ZIP package.
     464                 *         @type false|string $no_content  URL to the no content ZIP package.
     465                 *         @type false|string $new_bundled URL to the new bundled ZIP package.
     466                 *         @type false|string $partial     URL to the partial ZIP package.
     467                 *         @type false|string $rollback    URL to the rollback ZIP package.
     468                 *     }
     469                 *     @type string   $php_version        Minimum required PHP version for the update.
     470                 *     @type string   $plugin             File name of the plugin in the update offer, eg. `akismet/akismet.php`.
     471                 *     @type string   $theme              Directory name of the theme in the update offer, eg. `twentytwenty`.
     472                 * }
    341473                 * @param string $context The filesystem context (a path) against which filesystem access and status
    342474                 *                        should be checked.
    343475                 */