Changeset 25474

Timestamp:

09/18/2013 07:37:39 AM (11 years ago)

Author:

westi

Message:

Inline documentation for hooks in wp-admin/includes/plugin.php

See #25229 props dllh

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (5 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -541 +541 @@
 
         if ( ! $silent ) {
+            /**
+             * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false
+             * 
+             * @since 3.0.2
+             *
+             * @param string $plugin     Basename of the plugin path from {@see activate_plugin()}
+             * @param bool $network_wide Argument from {@see activate_plugin()}
+             */
             do_action( 'activate_plugin', $plugin, $network_wide );
+
+            /**
+             * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false
+             * 
+             * The action concatenates the 'activate_' prefix with the $plugin value passed to
+             * activate_plugin() to create a dynamically named action.
+             * 
+             * @since 3.0.2
+             *
+             * @param bool $network_wide Argument from {@see activate_plugin()}
+             */
             do_action( 'activate_' . $plugin, $network_wide );
         }
@@ -555 +574 @@
 
         if ( ! $silent ) {
+            /**
+             * Fires after a plugin has been activated in activate_plugin() when the $silent parameter is false
+             * 
+             * @since 3.0.2
+             *
+             * @param string $plugin     Basename of the plugin path from {@see activate_plugin()}
+             * @param bool $network_wide Argument from {@see activate_plugin()}
+             */
             do_action( 'activated_plugin', $plugin, $network_wide );
         }
@@ -595 +622 @@
 
         if ( ! $silent )
+            /**
+             * Fires for each plugin being deactivated in deactivate_plugins(), before deactivation
+             * and when the $silent parameter is false.
+             * 
+             * @since 3.3.2
+             *
+             * @param string $plugin     Basename of the plugin path from {@see activate_plugin()}
+             * @param bool $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} 
+             * is true and the plugin is active for the network.
+             */
             do_action( 'deactivate_plugin', $plugin, $network_deactivating );
 
@@ -615 +652 @@
 
         if ( ! $silent ) {
+            /**
+             * Fires for each plugin being deactivated in deactivate_plugins(), after deactivation
+             * and when the $silent parameter is false.
+             * 
+             * The action concatenates the 'deactivate_' prefix with the plugin's basename
+             * to create a dynamically named action.
+             * 
+             * @since 3.3.2
+             *
+             * @param bool $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} 
+             * is true and the plugin is active for the network.
+             */
             do_action( 'deactivate_' . $plugin, $network_deactivating );
+
+            /**
+             * Fires for each plugin being deactivated in deactivate_plugins(), after deactivation
+             * and when the $silent parameter is false.
+             * 
+             * @since 3.3.2
+             *
+             * @param string $plugin             Basename of the plugin path from {@see activate_plugin()}
+             * @param bool $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} 
+             * is true and the plugin is active for the network.
+             */
             do_action( 'deactivated_plugin', $plugin, $network_deactivating );
         }
@@ -866 +926 @@
 
         add_action( 'uninstall_' . $file, $callable );
+
+        /**
+         * Fires in uninstall_plugin() once the plugin has been uninstalled.
+         * 
+         * The action concatenates the 'uninstall_' prefix with the basename of the
+         * plugin passed to {@see uninstall_plugin()} to create a dynamically named action.
+         *
+         * @since 2.6.1
+         */
         do_action( 'uninstall_' . $file );
     }