Changeset 48661 for trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

Timestamp:

07/28/2020 11:55:19 AM (4 years ago)

Author:

SergeyBiryukov

Message:

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

Props ramiy.
Fixes #42923.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader-skin.php (modified) (3 diffs)

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

@@ -16 +16 @@
 class WP_Upgrader_Skin {
 
+    /**
+     * Holds the upgrader data.
+     *
+     * @since 2.8.0
+     *
+     * @var object
+     */
     public $upgrader;
+
+    /**
+     * Whether header is done.
+     *
+     * @since 2.8.0
+     *
+     * @var bool
+     */
     public $done_header = false;
+
+    /**
+     * Whether footer is done.
+     *
+     * @since 2.8.0
+     *
+     * @var bool
+     */
     public $done_footer = false;
 
@@ -24 +47 @@
      *
      * @since 2.8.0
+     *
      * @var string|bool|WP_Error
      */
-    public $result  = false;
+    public $result = false;
+
+    /**
+     * Holds the options of an upgrade.
+     *
+     * @since 2.8.0
+     *
+     * @var array
+     */
     public $options = array();
 
     /**
-     * @param array $args
+     * Constructor.
+     *
+     * Sets up the generic skin for the WordPress Upgrader classes.
+     *
+     * @since 2.8.0
+     *
+     * @param array $args Optional. The WordPress upgrader skin arguments to
+     *                    override default options. Default empty array.
      */
     public function __construct( $args = array() ) {
@@ -162 +201 @@
 
     /**
+     * Action to perform before an update.
+     *
+     * @since 2.8.0
      */
     public function before() {}
 
     /**
+     * Action to perform following an update.
+     *
+     * @since 2.8.0
      */
     public function after() {}