Docs: Properly mark the optional $redirect, $network_wide, and $silent parameters as such in the DocBlock for activate_plugin().

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36072 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-23 06:59:47 +00:00
parent d4ea8d9f62
commit 857de6f1ba

View File

@ -508,11 +508,11 @@ function is_network_only_plugin( $plugin ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $plugin Plugin path to main plugin file with plugin data. * @param string $plugin Plugin path to main plugin file with plugin data.
* @param string $redirect Optional. URL to redirect to. * @param string $redirect Optional. URL to redirect to.
* @param bool $network_wide Whether to enable the plugin for all sites in the * @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network
* network or just the current site. Multisite only. Default is false. * or just the current site. Multisite only. Default false.
* @param bool $silent Prevent calling activation hooks. Optional, default is false. * @param bool $silent Optional. Whether to prevent calling activation hooks. Default false.
* @return WP_Error|null WP_Error on invalid file or null on success. * @return WP_Error|null WP_Error on invalid file or null on success.
*/ */
function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) { function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {