WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/18/2013 07:35:10 PM (7 years ago)
Author:
SergeyBiryukov
Message:

Clean up the documentation for hooks in wp-admin/includes/plugin.php.

props DrewAPicture.
see #25229.

File:
1 edited

Legend:

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

    r25477 r25482  
    542542        if ( ! $silent ) {
    543543            /**
    544              * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false
     544             * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false.
    545545             *
    546546             * @since 2.9.0
    547547             *
    548              * @param string $plugin       Basename of the plugin path from {@see activate_plugin()}.
    549              * @param bool   $network_wide Argument from {@see activate_plugin()}.
     548             * @param string $plugin       Plugin path to main plugin file with plugin data.
     549             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
     550             *                             or just the current site. Multisite only. Default is false.
    550551             */
    551552            do_action( 'activate_plugin', $plugin, $network_wide );
    552553
    553554            /**
    554              * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false
     555             * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false.
    555556             *
    556557             * The action concatenates the 'activate_' prefix with the $plugin value passed to
    557              * activate_plugin() to create a dynamically named action.
     558             * activate_plugin() to create a dynamically-named action.
    558559             *
    559560             * @since 2.0.0
    560561             *
    561              * @param bool $network_wide Argument from {@see activate_plugin()}.
     562             * @param bool $network_wide Whether to enable the plugin for all sites in the network
     563             *                           or just the current site. Multisite only. Default is false.
    562564             */
    563565            do_action( 'activate_' . $plugin, $network_wide );
     
    575577        if ( ! $silent ) {
    576578            /**
    577              * Fires after a plugin has been activated in activate_plugin() when the $silent parameter is false
     579             * Fires after a plugin has been activated in activate_plugin() when the $silent parameter is false.
    578580             *
    579581             * @since 2.9.0
    580582             *
    581              * @param string $plugin       Basename of the plugin path from {@see activate_plugin()}.
    582              * @param bool   $network_wide Argument from {@see activate_plugin()}.
     583             * @param string $plugin       Plugin path to main plugin file with plugin data.
     584             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
     585             *                             or just the current site. Multisite only. Default is false.
    583586             */
    584587            do_action( 'activated_plugin', $plugin, $network_wide );
     
    628631             * @since 2.9.0
    629632             *
    630              * @param string $plugin               Basename of the plugin path from {@see activate_plugin()}.
    631              * @param bool   $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} is true and the plugin is active for the network.
     633             * @param string $plugin               Plugin path to main plugin file with plugin data.
     634             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
     635             *                                     or just the current site. Multisite only. Default is false.
    632636             */
    633637            do_action( 'deactivate_plugin', $plugin, $network_deactivating );
     
    656660             *
    657661             * The action concatenates the 'deactivate_' prefix with the plugin's basename
    658              * to create a dynamically named action.
     662             * to create a dynamically-named action.
    659663             *
    660664             * @since 2.0.0
    661665             *
    662              * @param bool $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} is true and the plugin is active for the network.
     666             * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
     667             *                                   or just the current site. Multisite only. Default is false.
    663668             */
    664669            do_action( 'deactivate_' . $plugin, $network_deactivating );
     
    670675             * @since 2.9.0
    671676             *
    672              * @param string $plugin               Basename of the plugin path from {@see activate_plugin()}.
    673              * @param bool   $network_deactivating True if $network_wide passed in {@see deactivate_plugin()} is true and the plugin is active for the network.
     677             * @param string $plugin               Plugin path to main plugin file with plugin data.
     678             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
     679             *                                     or just the current site. Multisite only. Default is false.
    674680             */
    675681            do_action( 'deactivated_plugin', $plugin, $network_deactivating );
     
    928934         *
    929935         * The action concatenates the 'uninstall_' prefix with the basename of the
    930          * plugin passed to {@see uninstall_plugin()} to create a dynamically named action.
     936         * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
    931937         *
    932938         * @since 2.7.0
Note: See TracChangeset for help on using the changeset viewer.