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

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.

File:

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

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

@@ -17 +17 @@
  */
 class Plugin_Upgrader_Skin extends WP_Upgrader_Skin {
-        public $plugin                = '';
-        public $plugin_active         = false;
+
+        /**
+         * Holds the plugin slug in the Plugin Directory.
+         *
+         * @since 2.8.0
+         *
+         * @var object
+         */
+        public $plugin = '';
+
+        /**
+         * Whether the plugin is active.
+         *
+         * @since 2.8.0
+         *
+         * @var bool
+         */
+        public $plugin_active = false;
+
+        /**
+         * Whether the plugin is active for the entire network.
+         *
+         * @since 2.8.0
+         *
+         * @var bool
+         */
         public $plugin_network_active = false;
 
         /**
-         * @param array $args
+         * Constructor.
+         *
+         * Sets up the plugin upgrader skin.
+         *
+         * @since 2.8.0
+         *
+         * @param array $args Optional. The plugin upgrader skin arguments to
+         *                    override default options. Default empty array.
          */
         public function __construct( $args = array() ) {
@@ -42 +73 @@
 
         /**
+         * Action to perform following a single plugin update.
+         *
+         * @since 2.8.0
          */
         public function after() {