WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/05/2018 09:49:53 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Standardise and correct documentation relating to parameters which accept plugin names.

See #42505

File:
1 edited

Legend:

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

    r42778 r42787  
    4848 * @since 1.5.0
    4949 *
    50  * @param string $plugin_file Path to the main plugin file.
     50 * @param string $plugin_file Absolute path to the main plugin file.
    5151 * @param bool   $markup      Optional. If the returned data should have HTML markup applied.
    5252 *                            Default true.
     
    195195 * @since 2.8.0
    196196 *
    197  * @param string $plugin Path to the main plugin file from plugins directory.
     197 * @param string $plugin Path to the plugin file relative to the plugins directory.
    198198 * @return array List of files relative to the plugin root.
    199199 */
     
    471471 * @since 2.5.0
    472472 *
    473  * @param string $plugin Path to the main plugin file from plugins directory.
     473 * @param string $plugin Path to the plugin file relative to the plugins directory.
    474474 * @return bool True, if in the active plugins list. False, not in the list.
    475475 */
     
    490490 * @see is_plugin_active()
    491491 *
    492  * @param string $plugin Path to the main plugin file from plugins directory.
     492 * @param string $plugin Path to the plugin file relative to the plugins directory.
    493493 * @return bool True if inactive. False if active.
    494494 */
     
    511511 * @since 3.0.0
    512512 *
    513  * @param string $plugin Path to the main plugin file from plugins directory.
     513 * @param string $plugin Path to the plugin file relative to the plugins directory.
    514514 * @return bool True if active for the network, otherwise false.
    515515 */
     
    536536 * @since 3.0.0
    537537 *
    538  * @param string $plugin Path to the main plugin file from plugins directory.
     538 * @param string $plugin Path to the plugin file relative to the plugins directory.
    539539 * @return bool True if plugin is network only, false otherwise.
    540540 */
     
    567567 * @since 2.5.0
    568568 *
    569  * @param string $plugin       Path to the main plugin file from plugins directory.
     569 * @param string $plugin       Path to the plugin file relative to the plugins directory.
    570570 * @param string $redirect     Optional. URL to redirect to.
    571571 * @param bool   $network_wide Optional. Whether to enable the plugin for all sites in the network
     
    609609             * @since 2.9.0
    610610             *
    611              * @param string $plugin       Path to the main plugin file from plugins directory.
     611             * @param string $plugin       Path to the plugin file relative to the plugins directory.
    612612             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    613613             *                             or just the current site. Multisite only. Default is false.
     
    651651             * @since 2.9.0
    652652             *
    653              * @param string $plugin       Path to the main plugin file from plugins directory.
     653             * @param string $plugin       Path to the plugin file relative to the plugins directory.
    654654             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    655655             *                             or just the current site. Multisite only. Default is false.
     
    705705             * @since 2.9.0
    706706             *
    707              * @param string $plugin               Path to the main plugin file from plugins directory.
     707             * @param string $plugin               Path to the plugin file relative to the plugins directory.
    708708             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
    709709             *                                     or just the current site. Multisite only. Default is false.
     
    753753             * @since 2.9.0
    754754             *
    755              * @param string $plugin               Path to the main plugin file from plugins directory.
     755             * @param string $plugin               Path to the plugin file relative to the plugins directory.
    756756             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network.
    757757             *                                     or just the current site. Multisite only. Default false.
     
    815815 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
    816816 *
    817  * @param array  $plugins    List of plugins to delete.
    818  * @param string $deprecated Deprecated.
    819  * @return bool|null|WP_Error True on success, false if `$plugins` is empty, WP_Error on failure.
    820  *                            Null if filesystem credentials are required to proceed.
     817 * @param string[] $plugins    List of plugin paths to delete, relative to the plugins directory.
     818 * @param string   $deprecated Not used.
     819 * @return bool|null|WP_Error True on success, false if `$plugins` is empty, `WP_Error` on failure.
     820 *                            `null` if filesystem credentials are required to proceed.
    821821 */
    822822function delete_plugins( $plugins, $deprecated = '' ) {
     
    893893         * @since 4.4.0
    894894         *
    895          * @param string $plugin_file Plugin file name.
     895         * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    896896         */
    897897        do_action( 'delete_plugin', $plugin_file );
     
    911911         * @since 4.4.0
    912912         *
    913          * @param string $plugin_file Plugin file name.
     913         * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    914914         * @param bool   $deleted     Whether the plugin deletion was successful.
    915915         */
     
    10061006 * @since 2.5.0
    10071007 *
    1008  * @param string $plugin Path to the main plugin file from plugins directory.
     1008 * @param string $plugin Path to the plugin file relative to the plugins directory.
    10091009 * @return WP_Error|int 0 on success, WP_Error on failure.
    10101010 */
     
    10291029 * @since 2.7.0
    10301030 *
    1031  * @param string $plugin Path to the main plugin file from plugins directory.
     1031 * @param string $plugin Path to the plugin file relative to the plugins directory.
    10321032 * @return bool Whether plugin can be uninstalled.
    10331033 */
     
    10501050 * @since 2.7.0
    10511051 *
    1052  * @param string $plugin Path to the main plugin file from plugins directory.
     1052 * @param string $plugin Path to the plugin file relative to the plugins directory.
    10531053 * @return true True if a plugin's uninstall.php file has been found and included.
    10541054 */
     
    10631063     * @since 4.5.0
    10641064     *
    1065      * @param string $plugin                Path to the main plugin file from plugins directory.
     1065     * @param string $plugin                Path to the plugin file relative to the plugins directory.
    10661066     * @param array  $uninstallable_plugins Uninstallable plugins.
    10671067     */
     
    20092009 * @since 4.4.0 Function was moved into the `wp-admin/includes/plugin.php` file.
    20102010 *
    2011  * @param string $plugin Plugin file to load.
     2011 * @param string $plugin Path to the plugin file relative to the plugins directory.
    20122012 */
    20132013function plugin_sandbox_scrape( $plugin ) {
Note: See TracChangeset for help on using the changeset viewer.