WordPress.org
Get WordPress

Make WordPress Core

Changeset 48661


Ignore:
Timestamp:
07/28/2020 11:55:19 AM (6 years ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing documentation for various upgrade/install class properties and methods.

Props ramiy.
Fixes #42923.

Location:
trunk/src/wp-admin/includes
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-plugin-installer-skin.php

    r48508 r48661  
    4747
    4848        /**
     49         * Action to perform before installing a plugin.
     50         *
     51         * @since 2.8.0
    4952         */
    5053        public function before() {
    … …  
    7982
    8083        /**
     84         * Action to perform following a plugin install.
     85         *
     86         * @since 2.8.0
    8187         */
    8288        public function after() {

  • trunk/src/wp-admin/includes/class-plugin-upgrader-skin.php

    r46072 r48661  
    1717 */
    1818class Plugin_Upgrader_Skin extends WP_Upgrader_Skin {
    19         public $plugin                = '';
    20         public $plugin_active         = false;
     19
     20        /**
     21         * Holds the plugin slug in the Plugin Directory.
     22         *
     23         * @since 2.8.0
     24         *
     25         * @var object
     26         */
     27        public $plugin = '';
     28
     29        /**
     30         * Whether the plugin is active.
     31         *
     32         * @since 2.8.0
     33         *
     34         * @var bool
     35         */
     36        public $plugin_active = false;
     37
     38        /**
     39         * Whether the plugin is active for the entire network.
     40         *
     41         * @since 2.8.0
     42         *
     43         * @var bool
     44         */
    2145        public $plugin_network_active = false;
    2246
    2347        /**
    24          * @param array $args
     48         * Constructor.
     49         *
     50         * Sets up the plugin upgrader skin.
     51         *
     52         * @since 2.8.0
     53         *
     54         * @param array $args Optional. The plugin upgrader skin arguments to
     55         *                    override default options. Default empty array.
    2556         */
    2657        public function __construct( $args = array() ) {
    … …  
    4273
    4374        /**
     75         * Action to perform following a single plugin update.
     76         *
     77         * @since 2.8.0
    4478         */
    4579        public function after() {

  • trunk/src/wp-admin/includes/class-theme-installer-skin.php

    r48545 r48661  
    4747
    4848        /**
     49         * Action to perform before installing a theme.
     50         *
     51         * @since 2.8.0
    4952         */
    5053        public function before() {
    … …  
    7982
    8083        /**
     84         * Action to perform following a single theme install.
     85         *
     86         * @since 2.8.0
    8187         */
    8288        public function after() {

  • trunk/src/wp-admin/includes/class-theme-upgrader-skin.php

    r48545 r48661  
    1717 */
    1818class Theme_Upgrader_Skin extends WP_Upgrader_Skin {
     19
     20        /**
     21         * Holds the theme slug in the Theme Directory.
     22         *
     23         * @since 2.8.0
     24         *
     25         * @var object
     26         */
    1927        public $theme = '';
    2028
    2129        /**
    22          * @param array $args
     30         * Constructor.
     31         *
     32         * Sets up the theme upgrader skin.
     33         *
     34         * @since 2.8.0
     35         *
     36         * @param array $args Optional. The theme upgrader skin arguments to
     37         *                    override default options. Default empty array.
    2338         */
    2439        public function __construct( $args = array() ) {
    … …  
    3752
    3853        /**
     54         * Action to perform following a single theme update.
     55         *
     56         * @since 2.8.0
    3957         */
    4058        public function after() {

  • trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php

    r46586 r48661  
    2323         *
    2424         * @since 4.6.0
     25         *
    2526         * @var null|WP_Error
    2627         */
    … …  
    3031         * Constructor.
    3132         *
     33         * Sets up the WordPress Ajax upgrader skin.
     34         *
    3235         * @since 4.6.0
    3336         *
    34          * @param array $args Options for the upgrader, see WP_Upgrader_Skin::__construct().
     37         * @see WP_Upgrader_Skin::__construct()
     38         *
     39         * @param array $args Optional. The WordPress Ajax upgrader skin arguments to
     40         *                    override default options. See WP_Upgrader_Skin::__construct().
     41         *                    Default empty array.
    3542         */
    3643        public function __construct( $args = array() ) {

  • trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

    r48508 r48661  
    1616class WP_Upgrader_Skin {
    1717
     18        /**
     19         * Holds the upgrader data.
     20         *
     21         * @since 2.8.0
     22         *
     23         * @var object
     24         */
    1825        public $upgrader;
     26
     27        /**
     28         * Whether header is done.
     29         *
     30         * @since 2.8.0
     31         *
     32         * @var bool
     33         */
    1934        public $done_header = false;
     35
     36        /**
     37         * Whether footer is done.
     38         *
     39         * @since 2.8.0
     40         *
     41         * @var bool
     42         */
    2043        public $done_footer = false;
    2144
    … …  
    2447         *
    2548         * @since 2.8.0
     49         *
    2650         * @var string|bool|WP_Error
    2751         */
    28         public $result  = false;
     52        public $result = false;
     53
     54        /**
     55         * Holds the options of an upgrade.
     56         *
     57         * @since 2.8.0
     58         *
     59         * @var array
     60         */
    2961        public $options = array();
    3062
    3163        /**
    32          * @param array $args
     64         * Constructor.
     65         *
     66         * Sets up the generic skin for the WordPress Upgrader classes.
     67         *
     68         * @since 2.8.0
     69         *
     70         * @param array $args Optional. The WordPress upgrader skin arguments to
     71         *                    override default options. Default empty array.
    3372         */
    3473        public function __construct( $args = array() ) {
    … …  
    162201
    163202        /**
     203         * Action to perform before an update.
     204         *
     205         * @since 2.8.0
    164206         */
    165207        public function before() {}
    166208
    167209        /**
     210         * Action to perform following an update.
     211         *
     212         * @since 2.8.0
    168213         */
    169214        public function after() {}
Note: See TracChangeset for help on using the changeset viewer.