WordPress.org

Make WordPress Core

Changeset 34499


Ignore:
Timestamp:
09/24/2015 02:53:46 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize and clarify class DocBlocks for all of the Upgrade API classes.

Standardizes summaries and tags for the following classes:

  • WP_Upgrader
  • Plugin_Upgrader
  • Theme_Upgrader
  • Language_Pack_Upgrader
  • Core_Upgrader
  • File_Upload_Upgrader
  • WP_Automatic_Updater

See #32246.

File:
1 edited

Legend:

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

    r34498 r34499  
    1515
    1616/**
    17  * WordPress Upgrader class for Upgrading/Installing a local set of files via the Filesystem Abstraction classes from a Zip file.
     17 * Core class used for upgrading/installing a local set of files via
     18 * the Filesystem Abstraction classes from a Zip file.
    1819 *
    19  * @package WordPress
    20  * @subpackage Upgrader
    2120 * @since 2.8.0
    2221 */
     
    754753
    755754/**
    756  * Plugin Upgrader class for WordPress Plugins, It is designed to upgrade/install plugins from a local zip, remote zip URL, or uploaded zip file.
     755 * Core class used for upgrading/installing plugins.
    757756 *
    758  * @package WordPress
    759  * @subpackage Upgrader
     757 * It is designed to upgrade/install plugins from a local zip, remote zip URL,
     758 * or uploaded zip file.
     759 *
    760760 * @since 2.8.0
     761 *
     762 * @see WP_Upgrader
    761763 */
    762764class Plugin_Upgrader extends WP_Upgrader {
     
    12151217
    12161218/**
    1217  * Theme Upgrader class for WordPress Themes, It is designed to upgrade/install themes from a local zip, remote zip URL, or uploaded zip file.
     1219 * Core class used for upgrading/installing themes.
    12181220 *
    1219  * @package WordPress
    1220  * @subpackage Upgrader
     1221 * It is designed to upgrade/install themes from a local zip, remote zip URL,
     1222 * or uploaded zip file.
     1223 *
    12211224 * @since 2.8.0
     1225 *
     1226 * @see WP_Upgrader
    12221227 */
    12231228class Theme_Upgrader extends WP_Upgrader {
     
    17791784
    17801785/**
    1781  * Language pack upgrader, for updating translations of plugins, themes, and core.
     1786 * Core class used for updating/installing language packs (translations)
     1787 * for plugins, themes, and core.
    17821788 *
    1783  * @package WordPress
    1784  * @subpackage Upgrader
    17851789 * @since 3.7.0
     1790 *
     1791 * @see WP_Upgrader
    17861792 */
    17871793class Language_Pack_Upgrader extends WP_Upgrader {
     
    21072113
    21082114/**
    2109  * Core Upgrader class for WordPress. It allows for WordPress to upgrade itself in combination with the wp-admin/includes/update-core.php file
     2115 * Core class used for updating core.
    21102116 *
    2111  * @package WordPress
    2112  * @subpackage Upgrader
     2117 * It allows for WordPress to upgrade itself in combination with
     2118 * the wp-admin/includes/update-core.php file.
     2119 *
    21132120 * @since 2.8.0
     2121 *
     2122 * @see WP_Upgrader
    21142123 */
    21152124class Core_Upgrader extends WP_Upgrader {
     
    24442453
    24452454/**
    2446  * Upgrade Skin helper for File uploads. This class handles the upload process and passes it as if it's a local file to the Upgrade/Installer functions.
     2455 * Core class used for handling file uploads.
    24472456 *
    2448  * @package WordPress
    2449  * @subpackage Upgrader
     2457 * This class handles the upload process and passes it as if it's a local file
     2458 * to the Upgrade/Installer functions.
     2459 *
    24502460 * @since 2.8.0
    24512461 */
     
    25592569
    25602570/**
    2561  * The WordPress automatic background updater.
     2571 * Core class used for handling automatic background updates.
    25622572 *
    2563  * @package WordPress
    2564  * @subpackage Upgrader
    25652573 * @since 3.7.0
    25662574 */
Note: See TracChangeset for help on using the changeset viewer.