vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-12 00:24:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
See #42505


git-svn-id: https://develop.svn.wordpress.org/trunk@42787 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2018-03-05 21:49:53 +00:00
parent 3e182c7f71
commit b20dc7aaaf
9 changed files with 42 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
src/wp-admin/includes/plugin.php
View File

@@ -47,7 +47,7 @@
*
* @since 1.5.0
*
* @param string $plugin_file Path to the main plugin file.
* @param string $plugin_file Absolute path to the main plugin file.
* @param bool $markup Optional. If the returned data should have HTML markup applied.
* Default true.
* @param bool $translate Optional. If the returned data should be translated. Default true.
@@ -194,7 +194,7 @@ function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup
*
* @since 2.8.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return array List of files relative to the plugin root.
*/
function get_plugin_files( $plugin ) {
@@ -470,7 +470,7 @@ function _get_dropins() {
*
* @since 2.5.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool True, if in the active plugins list. False, not in the list.
*/
function is_plugin_active( $plugin ) {
@@ -489,7 +489,7 @@ function is_plugin_active( $plugin ) {
* @since 3.1.0
* @see is_plugin_active()
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool True if inactive. False if active.
*/
function is_plugin_inactive( $plugin ) {
@@ -510,7 +510,7 @@ function is_plugin_inactive( $plugin ) {
*
* @since 3.0.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool True if active for the network, otherwise false.
*/
function is_plugin_active_for_network( $plugin ) {
@@ -535,7 +535,7 @@ function is_plugin_active_for_network( $plugin ) {
*
* @since 3.0.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool True if plugin is network only, false otherwise.
*/
function is_network_only_plugin( $plugin ) {
@@ -566,7 +566,7 @@ function is_network_only_plugin( $plugin ) {
*
* @since 2.5.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param string $redirect Optional. URL to redirect to.
* @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network
* or just the current site. Multisite only. Default false.
@@ -608,7 +608,7 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
*
* @since 2.9.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param bool $network_wide Whether to enable the plugin for all sites in the network
* or just the current site. Multisite only. Default is false.
*/
@@ -650,7 +650,7 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
*
* @since 2.9.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param bool $network_wide Whether to enable the plugin for all sites in the network
* or just the current site. Multisite only. Default is false.
*/
@@ -704,7 +704,7 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
*
* @since 2.9.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
* or just the current site. Multisite only. Default is false.
*/
@@ -752,7 +752,7 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
*
* @since 2.9.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network.
* or just the current site. Multisite only. Default false.
*/
@@ -814,10 +814,10 @@ function activate_plugins( $plugins, $redirect = '', $network_wide = false, $sil
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param array $plugins List of plugins to delete.
* @param string $deprecated Deprecated.
* @return bool|null|WP_Error True on success, false if `$plugins` is empty, WP_Error on failure.
* Null if filesystem credentials are required to proceed.
* @param string[] $plugins List of plugin paths to delete, relative to the plugins directory.
* @param string $deprecated Not used.
* @return bool|null|WP_Error True on success, false if `$plugins` is empty, `WP_Error` on failure.
* `null` if filesystem credentials are required to proceed.
*/
function delete_plugins( $plugins, $deprecated = '' ) {
global $wp_filesystem;
@@ -892,7 +892,7 @@ function delete_plugins( $plugins, $deprecated = '' ) {
*
* @since 4.4.0
*
* @param string $plugin_file Plugin file name.
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
*/
do_action( 'delete_plugin', $plugin_file );
@@ -910,7 +910,7 @@ function delete_plugins( $plugins, $deprecated = '' ) {
*
* @since 4.4.0
*
* @param string $plugin_file Plugin file name.
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param bool $deleted Whether the plugin deletion was successful.
*/
do_action( 'deleted_plugin', $plugin_file, $deleted );
@@ -1005,7 +1005,7 @@ function validate_active_plugins() {
*
* @since 2.5.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return WP_Error|int 0 on success, WP_Error on failure.
*/
function validate_plugin( $plugin ) {
@@ -1028,7 +1028,7 @@ function validate_plugin( $plugin ) {
*
* @since 2.7.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool Whether plugin can be uninstalled.
*/
function is_uninstallable_plugin( $plugin ) {
@@ -1049,7 +1049,7 @@ function is_uninstallable_plugin( $plugin ) {
*
* @since 2.7.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return true True if a plugin's uninstall.php file has been found and included.
*/
function uninstall_plugin( $plugin ) {
@@ -1062,7 +1062,7 @@ function uninstall_plugin( $plugin ) {
*
* @since 4.5.0
*
* @param string $plugin Path to the main plugin file from plugins directory.
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @param array $uninstallable_plugins Uninstallable plugins.
*/
do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins );
@@ -2008,7 +2008,7 @@ function wp_clean_plugins_cache( $clear_update_cache = true ) {
* @since 3.0.0
* @since 4.4.0 Function was moved into the `wp-admin/includes/plugin.php` file.
*
* @param string $plugin Plugin file to load.
* @param string $plugin Path to the plugin file relative to the plugins directory.
*/
function plugin_sandbox_scrape( $plugin ) {
wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );