WordPress.org

Make WordPress Core

Changeset 39890


Ignore:
Timestamp:
01/12/2017 06:15:23 AM (17 months ago)
Author:
SergeyBiryukov
Message:

Docs: Use a consistent description for $plugin parameter in various plugin API functions.

See #36333.

File:
1 edited

Legend:

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

    r39889 r39890  
    4848 * @since 1.5.0
    4949 *
    50  * @param string $plugin_file Path to the plugin file
     50 * @param string $plugin_file Path to the main plugin file.
    5151 * @param bool   $markup      Optional. If the returned data should have HTML markup applied.
    5252 *                            Default true.
     
    188188 * @since 2.8.0
    189189 *
    190  * @param string $plugin Plugin ID
     190 * @param string $plugin Path to the main plugin file from plugins directory.
    191191 * @return array List of files relative to the plugin root.
    192192 */
     
    445445 * @since 2.5.0
    446446 *
    447  * @param string $plugin Base plugin path from plugins directory.
     447 * @param string $plugin Path to the main plugin file from plugins directory.
    448448 * @return bool True, if in the active plugins list. False, not in the list.
    449449 */
     
    460460 * @see is_plugin_active()
    461461 *
    462  * @param string $plugin Base plugin path from plugins directory.
     462 * @param string $plugin Path to the main plugin file from plugins directory.
    463463 * @return bool True if inactive. False if active.
    464464 */
     
    477477 * @since 3.0.0
    478478 *
    479  * @param string $plugin Base plugin path from plugins directory.
     479 * @param string $plugin Path to the main plugin file from plugins directory.
    480480 * @return bool True, if active for the network, otherwise false.
    481481 */
     
    500500 * @since 3.0.0
    501501 *
    502  * @param string $plugin Plugin to check
     502 * @param string $plugin Path to the main plugin file from plugins directory.
    503503 * @return bool True if plugin is network only, false otherwise.
    504504 */
     
    530530 * @since 2.5.0
    531531 *
    532  * @param string $plugin       Plugin path to main plugin file with plugin data.
     532 * @param string $plugin       Path to the main plugin file from plugins directory.
    533533 * @param string $redirect     Optional. URL to redirect to.
    534534 * @param bool   $network_wide Optional. Whether to enable the plugin for all sites in the network
     
    570570             * @since 2.9.0
    571571             *
    572              * @param string $plugin       Plugin path to main plugin file with plugin data.
     572             * @param string $plugin       Path to the main plugin file from plugins directory.
    573573             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    574574             *                             or just the current site. Multisite only. Default is false.
     
    612612             * @since 2.9.0
    613613             *
    614              * @param string $plugin       Plugin path to main plugin file with plugin data.
     614             * @param string $plugin       Path to the main plugin file from plugins directory.
    615615             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    616616             *                             or just the current site. Multisite only. Default is false.
     
    664664             * @since 2.9.0
    665665             *
    666              * @param string $plugin               Plugin path to main plugin file with plugin data.
     666             * @param string $plugin               Path to the main plugin file from plugins directory.
    667667             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
    668668             *                                     or just the current site. Multisite only. Default is false.
     
    712712             * @since 2.9.0
    713713             *
    714              * @param string $plugin               Plugin basename.
    715              * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
     714             * @param string $plugin               Path to the main plugin file from plugins directory.
     715             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network.
    716716             *                                     or just the current site. Multisite only. Default false.
    717717             */
     
    965965 * @since 2.7.0
    966966 *
    967  * @param string $plugin Plugin path to check.
     967 * @param string $plugin Path to the main plugin file from plugins directory.
    968968 * @return bool Whether plugin can be uninstalled.
    969969 */
     
    985985 * @since 2.7.0
    986986 *
    987  * @param string $plugin Relative plugin path from Plugin Directory.
     987 * @param string $plugin Path to the main plugin file from plugins directory.
    988988 * @return true True if a plugin's uninstall.php file has been found and included.
    989989 */
     
    998998     * @since 4.5.0
    999999     *
    1000      * @param string $plugin                Relative plugin path from plugin directory.
     1000     * @param string $plugin                Path to the main plugin file from plugins directory.
    10011001     * @param array  $uninstallable_plugins Uninstallable plugins.
    10021002     */
Note: See TracChangeset for help on using the changeset viewer.