WordPress.org

Make WordPress Core

Changeset 36397


Ignore:
Timestamp:
01/26/2016 12:31:08 AM (5 years ago)
Author:
ericlewis
Message:

Plugins: Clarify that mu-plugins can't be "active" in docs.

Plugins installed in the plugins/ folder can be activated by users. This puts the plugin in an "active" state. Plugins in the mu-folder/ are "must-use" plugins that are always loaded. They can't be activated, and thereby can't be "active." Because of this, using the is_plugin_active() or is_plugin_active_for_network() returns false when checking for these plugins. This clarifies that behavior in the functions' docs.

File:
1 edited

Legend:

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

    r36283 r36397  
    428428
    429429/**
    430  * Check whether the plugin is active by checking the active_plugins list.
     430 * Check whether a plugin is active.
     431 *
     432 * Only plugins installed in the plugins/ folder can be active.
     433 *
     434 * Plugins in the mu-plugins/ folder can't be "activated," so this function will
     435 * return false for those plugins.
    431436 *
    432437 * @since 2.5.0
     
    456461/**
    457462 * Check whether the plugin is active for the entire network.
     463 *
     464 * Only plugins installed in the plugins/ folder can be active.
     465 *
     466 * Plugins in the mu-plugins/ folder can't be "activated," so this function will
     467 * return false for those plugins.
    458468 *
    459469 * @since 3.0.0
Note: See TracChangeset for help on using the changeset viewer.