X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..1132430022383fdf47fa6cb9377300fd885297aa:/wp-admin/includes/plugin.php diff --git a/wp-admin/includes/plugin.php b/wp-admin/includes/plugin.php index 209b5c94..e2e37761 100644 --- a/wp-admin/includes/plugin.php +++ b/wp-admin/includes/plugin.php @@ -14,39 +14,38 @@ * must not have any newlines or only parts of the description will be displayed * and the same goes for the plugin data. The below is formatted for printing. * - * - * /* - * Plugin Name: Name of Plugin - * Plugin URI: Link to plugin information - * Description: Plugin Description - * Author: Plugin author's name - * Author URI: Link to the author's web site - * Version: Must be set in the plugin for WordPress 2.3+ - * Text Domain: Optional. Unique identifier, should be same as the one used in - * plugin_text_domain() - * Domain Path: Optional. Only useful if the translations are located in a - * folder above the plugin's base path. For example, if .mo files are - * located in the locale folder then Domain Path will be "/locale/" and - * must have the first slash. Defaults to the base folder the plugin is - * located in. - * Network: Optional. Specify "Network: true" to require that a plugin is activated - * across all sites in an installation. This will prevent a plugin from being - * activated on a single site when Multisite is enabled. - * * / # Remove the space to close comment - * + * /* + * Plugin Name: Name of Plugin + * Plugin URI: Link to plugin information + * Description: Plugin Description + * Author: Plugin author's name + * Author URI: Link to the author's web site + * Version: Must be set in the plugin for WordPress 2.3+ + * Text Domain: Optional. Unique identifier, should be same as the one used in + * plugin_text_domain() + * Domain Path: Optional. Only useful if the translations are located in a + * folder above the plugin's base path. For example, if .mo files are + * located in the locale folder then Domain Path will be "/locale/" and + * must have the first slash. Defaults to the base folder the plugin is + * located in. + * Network: Optional. Specify "Network: true" to require that a plugin is activated + * across all sites in an installation. This will prevent a plugin from being + * activated on a single site when Multisite is enabled. + * * / # Remove the space to close comment * * Plugin data returned array contains the following: - * 'Name' - Name of the plugin, must be unique. - * 'Title' - Title of the plugin and the link to the plugin's web site. - * 'Description' - Description of what the plugin does and/or notes - * from the author. - * 'Author' - The author's name - * 'AuthorURI' - The authors web site address. - * 'Version' - The plugin version number. - * 'PluginURI' - Plugin web site address. - * 'TextDomain' - Plugin's text domain for localization. - * 'DomainPath' - Plugin's relative directory path to .mo files. - * 'Network' - Boolean. Whether the plugin can only be activated network wide. + * + * - 'Name' - Name of the plugin, must be unique. + * - 'Title' - Title of the plugin and the link to the plugin's web site. + * - 'Description' - Description of what the plugin does and/or notes + * - from the author. + * - 'Author' - The author's name + * - 'AuthorURI' - The authors web site address. + * - 'Version' - The plugin version number. + * - 'PluginURI' - Plugin web site address. + * - 'TextDomain' - Plugin's text domain for localization. + * - 'DomainPath' - Plugin's relative directory path to .mo files. + * - 'Network' - Boolean. Whether the plugin can only be activated network wide. * * Some users have issues with opening large files and manipulating the contents * for want is usually the first 1kiB or 2kiB. This function stops pulling in @@ -60,8 +59,9 @@ * the file. This is not checked however and the file is only opened for * reading. * - * @link http://trac.wordpress.org/ticket/5651 Previous Optimizations. - * @link http://trac.wordpress.org/ticket/7372 Further and better Optimizations. + * @link https://core.trac.wordpress.org/ticket/5651 Previous Optimizations. + * @link https://core.trac.wordpress.org/ticket/7372 Further and better Optimizations. + * * @since 1.5.0 * * @param string $plugin_file Path to the plugin file @@ -533,7 +533,7 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen if ( is_wp_error($valid) ) return $valid; - if ( !in_array($plugin, $current) ) { + if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! in_array( $plugin, $current ) ) ) { if ( !empty($redirect) ) wp_redirect(add_query_arg('_error_nonce', wp_create_nonce('plugin-activation-error_' . $plugin), $redirect)); // we'll override this later if the plugin can be included without fatal error ob_start(); @@ -558,11 +558,11 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen do_action( 'activate_plugin', $plugin, $network_wide ); /** - * Fires as a specific plugin is being deactivated. + * Fires as a specific plugin is being activated. * - * This hook is the "deactivation" hook used internally by - * register_deactivation_hook(). The dynamic portion of the - * hook name, $plugin. refers to the plugin basename. + * This hook is the "activation" hook used internally by + * {@see register_activation_hook()}. The dynamic portion of the + * hook name, `$plugin`, refers to the plugin basename. * * If a plugin is silently activated (such as during an update), * this hook does not fire. @@ -674,8 +674,8 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) { * Fires as a specific plugin is being deactivated. * * This hook is the "deactivation" hook used internally by - * register_deactivation_hook(). The dynamic portion of the - * hook name, $plugin. refers to the plugin basename. + * {@see register_deactivation_hook()}. The dynamic portion of the + * hook name, `$plugin`, refers to the plugin basename. * * If a plugin is silently deactivated (such as during an update), * this hook does not fire. @@ -797,29 +797,50 @@ function delete_plugins( $plugins, $deprecated = '' ) { if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() ) return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors); - //Get the base plugin folder + // Get the base plugin folder. $plugins_dir = $wp_filesystem->wp_plugins_dir(); - if ( empty($plugins_dir) ) - return new WP_Error('fs_no_plugins_dir', __('Unable to locate WordPress Plugin directory.')); + if ( empty( $plugins_dir ) ) { + return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress Plugin directory.' ) ); + } $plugins_dir = trailingslashit( $plugins_dir ); + $translations_dir = $wp_filesystem->wp_lang_dir(); + $translations_dir = trailingslashit( $translations_dir ); + + $plugin_translations = wp_get_installed_translations( 'plugins' ); + $errors = array(); foreach( $plugins as $plugin_file ) { - // Run Uninstall hook - if ( is_uninstallable_plugin( $plugin_file ) ) + // Run Uninstall hook. + if ( is_uninstallable_plugin( $plugin_file ) ) { uninstall_plugin($plugin_file); + } - $this_plugin_dir = trailingslashit( dirname($plugins_dir . $plugin_file) ); + $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) ); // If plugin is in its own directory, recursively delete the directory. - if ( strpos($plugin_file, '/') && $this_plugin_dir != $plugins_dir ) //base check on if plugin includes directory separator AND that it's not the root plugin folder - $deleted = $wp_filesystem->delete($this_plugin_dir, true); - else - $deleted = $wp_filesystem->delete($plugins_dir . $plugin_file); + if ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) { //base check on if plugin includes directory separator AND that it's not the root plugin folder + $deleted = $wp_filesystem->delete( $this_plugin_dir, true ); + } else { + $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file ); + } - if ( ! $deleted ) + if ( ! $deleted ) { $errors[] = $plugin_file; + continue; + } + + // Remove language files, silently. + $plugin_slug = dirname( $plugin_file ); + if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) { + $translations = $plugin_translations[ $plugin_slug ]; + + foreach ( $translations as $translation => $data ) { + $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' ); + $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' ); + } + } } // Remove deleted plugins from the plugin updates list. @@ -1098,7 +1119,7 @@ function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $f * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { global $submenu; @@ -1168,7 +1189,7 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1189,7 +1210,7 @@ function add_management_page( $page_title, $menu_title, $capability, $menu_slug, * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1210,7 +1231,7 @@ function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $f * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1231,7 +1252,7 @@ function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1252,7 +1273,7 @@ function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $f * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { if ( current_user_can('edit_users') ) @@ -1276,7 +1297,7 @@ function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1297,7 +1318,7 @@ function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1318,7 +1339,7 @@ function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1339,7 +1360,7 @@ function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1360,7 +1381,7 @@ function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1381,7 +1402,7 @@ function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $fun * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param callback $function The function to be called to output the content for this page. * - * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. + * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. */ function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function ); @@ -1723,8 +1744,7 @@ function user_can_access_admin_page() { * @param string $option_group A settings group name. Should correspond to a whitelisted option key name. * Default whitelisted option key names include "general," "discussion," and "reading," among others. * @param string $option_name The name of an option to sanitize and save. - * @param unknown_type $sanitize_callback A callback function that sanitizes the option's value. - * @return unknown + * @param callable $sanitize_callback A callback function that sanitizes the option's value. */ function register_setting( $option_group, $option_name, $sanitize_callback = '' ) { global $new_whitelist_options; @@ -1749,10 +1769,9 @@ function register_setting( $option_group, $option_name, $sanitize_callback = '' * * @since 2.7.0 * - * @param unknown_type $option_group - * @param unknown_type $option_name - * @param unknown_type $sanitize_callback - * @return unknown + * @param string $option_group + * @param string $option_name + * @param callable $sanitize_callback */ function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) { global $new_whitelist_options; @@ -1779,8 +1798,8 @@ function unregister_setting( $option_group, $option_name, $sanitize_callback = ' * * @since 2.7.0 * - * @param unknown_type $options - * @return unknown + * @param array $options + * @return array */ function option_update_filter( $options ) { global $new_whitelist_options; @@ -1797,9 +1816,9 @@ add_filter( 'whitelist_options', 'option_update_filter' ); * * @since 2.7.0 * - * @param unknown_type $new_options - * @param unknown_type $options - * @return unknown + * @param array $new_options + * @param string|array $options + * @return array */ function add_option_whitelist( $new_options, $options = '' ) { if ( $options == '' ) @@ -1828,9 +1847,9 @@ function add_option_whitelist( $new_options, $options = '' ) { * * @since 2.7.0 * - * @param unknown_type $del_options - * @param unknown_type $options - * @return unknown + * @param array $del_options + * @param string|array $options + * @return array */ function remove_option_whitelist( $del_options, $options = '' ) { if ( $options == '' )