2007-05-25 09:16:21 +02:00
< ? php
2008-07-18 00:51:26 +02:00
/**
* WordPress Plugin Administration API
*
* @ package WordPress
* @ subpackage Administration
*/
2007-05-25 09:16:21 +02:00
2008-07-18 00:51:26 +02:00
/**
2008-07-22 21:18:07 +02:00
* Parse the plugin contents to retrieve plugin ' s metadata .
2008-07-18 00:51:26 +02:00
*
* The metadata of the plugin 's data searches for the following in the plugin' s
2008-07-22 21:18:07 +02:00
* header . All plugin data must be on its own line . For plugin description , it
* 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 .
2008-07-18 00:51:26 +02:00
*
* < code >
* /*
* 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 ()
2008-07-22 21:18:07 +02:00
* 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 .
2008-07-18 00:51:26 +02:00
* * / # Remove the space to close comment
* </ code >
*
* 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 .
2008-07-22 21:18:07 +02:00
* 'Author' - The author ' s name
* 'AuthorURI' - The authors web site address .
2008-07-18 00:51:26 +02:00
* 'Version' - The plugin version number .
2008-07-22 21:18:07 +02:00
* 'PluginURI' - Plugin web site address .
* 'TextDomain' - Plugin ' s text domain for localization .
* 'DomainPath' - Plugin ' s relative directory path to . mo files .
*
* Some users have issues with opening large files and manipulating the contents
* for want is usually the first 1 kiB or 2 kiB . This function stops pulling in
* the plugin contents when it has all of the required plugin data .
*
* The first 8 kiB of the file will be pulled in and if the plugin data is not
* within that first 8 kiB , then the plugin author should correct their plugin
* and move the plugin data headers to the top .
*
* The plugin file is assumed to have permissions to allow for scripts to read
* 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 .
* @ since 1.5 . 0
2008-07-18 00:51:26 +02:00
*
* @ param string $plugin_file Path to the plugin file
2008-10-22 02:08:22 +02:00
* @ param bool $markup If the returned data should have HTML markup applied
* @ param bool $translate If the returned data should be translated
2008-07-18 00:51:26 +02:00
* @ return array See above for description .
*/
2008-10-22 02:08:22 +02:00
function get_plugin_data ( $plugin_file , $markup = true , $translate = true ) {
2008-07-22 21:18:07 +02:00
// We don't need to write to the file, so just open for reading.
$fp = fopen ( $plugin_file , 'r' );
// Pull only the first 8kiB of the file in.
$plugin_data = fread ( $fp , 8192 );
// PHP will close file handle, but we are good citizens.
fclose ( $fp );
2008-07-18 05:16:53 +02:00
preg_match ( '|Plugin Name:(.*)$|mi' , $plugin_data , $name );
preg_match ( '|Plugin URI:(.*)$|mi' , $plugin_data , $uri );
preg_match ( '|Version:(.*)|i' , $plugin_data , $version );
2007-06-02 02:02:06 +02:00
preg_match ( '|Description:(.*)$|mi' , $plugin_data , $description );
preg_match ( '|Author:(.*)$|mi' , $plugin_data , $author_name );
preg_match ( '|Author URI:(.*)$|mi' , $plugin_data , $author_uri );
2008-07-18 05:16:53 +02:00
preg_match ( '|Text Domain:(.*)$|mi' , $plugin_data , $text_domain );
preg_match ( '|Domain Path:(.*)$|mi' , $plugin_data , $domain_path );
foreach ( array ( 'name' , 'uri' , 'version' , 'description' , 'author_name' , 'author_uri' , 'text_domain' , 'domain_path' ) as $field ) {
if ( ! empty ( ${$field} ) )
${$field} = trim ( ${$field} [ 1 ]);
else
${$field} = '' ;
2007-05-25 09:16:21 +02:00
}
2008-10-22 02:08:22 +02:00
$plugin_data = array (
'Name' => $name , 'Title' => $name , 'PluginURI' => $uri , 'Description' => $description ,
2008-08-09 07:36:14 +02:00
'Author' => $author_name , 'AuthorURI' => $author_uri , 'Version' => $version ,
2008-07-18 05:16:53 +02:00
'TextDomain' => $text_domain , 'DomainPath' => $domain_path
);
2008-10-22 02:08:22 +02:00
if ( $markup || $translate )
$plugin_data = _get_plugin_data_markup_translate ( $plugin_data , $markup , $translate );
return $plugin_data ;
}
function _get_plugin_data_markup_translate ( $plugin_data , $markup = true , $translate = true ) {
//Translate fields
if ( $translate && ! empty ( $plugin_data [ 'TextDomain' ]) ) {
if ( ! empty ( $plugin_data [ 'DomainPath' ] ) )
load_plugin_textdomain ( $plugin_data [ 'TextDomain' ], dirname ( $plugin_file ) . $plugin_data [ 'DomainPath' ]);
else
load_plugin_textdomain ( $plugin_data [ 'TextDomain' ], dirname ( $plugin_file ));
foreach ( array ( 'Name' , 'PluginURI' , 'Description' , 'Author' , 'AuthorURI' , 'Version' ) as $field )
$plugin_data [ $field ] = translate ( $plugin_data [ $field ], $plugin_data [ 'TextDomain' ]);
}
//Apply Markup
if ( $markup ) {
if ( ! empty ( $plugin_data [ 'PluginURI' ]) && ! empty ( $plugin_data [ 'Name' ]) )
$plugin_data [ 'Title' ] = '<a href="' . $plugin_data [ 'PluginURI' ] . '" title="' . __ ( 'Visit plugin homepage' ) . '">' . $plugin_data [ 'Name' ] . '</a>' ;
else
$plugin_data [ 'Title' ] = $plugin_data [ 'Name' ];
2009-01-21 20:02:15 +01:00
if ( ! empty ( $plugin_data [ 'AuthorURI' ]) && ! empty ( $plugin_data [ 'Author' ]) )
2008-10-22 02:08:22 +02:00
$plugin_data [ 'Author' ] = '<a href="' . $plugin_data [ 'AuthorURI' ] . '" title="' . __ ( 'Visit author homepage' ) . '">' . $plugin_data [ 'Author' ] . '</a>' ;
$plugin_data [ 'Description' ] = wptexturize ( $plugin_data [ 'Description' ] );
if ( ! empty ( $plugin_data [ 'Author' ]) )
$plugin_data [ 'Description' ] .= ' <cite>' . sprintf ( __ ( 'By %s' ), $plugin_data [ 'Author' ] ) . '.</cite>' ;
}
$plugins_allowedtags = array ( 'a' => array ( 'href' => array (), 'title' => array ()), 'abbr' => array ( 'title' => array ()), 'acronym' => array ( 'title' => array ()), 'code' => array (), 'em' => array (), 'strong' => array ());
// Sanitize all displayed data
$plugin_data [ 'Title' ] = wp_kses ( $plugin_data [ 'Title' ], $plugins_allowedtags );
$plugin_data [ 'Version' ] = wp_kses ( $plugin_data [ 'Version' ], $plugins_allowedtags );
$plugin_data [ 'Description' ] = wp_kses ( $plugin_data [ 'Description' ], $plugins_allowedtags );
$plugin_data [ 'Author' ] = wp_kses ( $plugin_data [ 'Author' ], $plugins_allowedtags );
return $plugin_data ;
2007-05-25 09:16:21 +02:00
}
2008-09-17 02:40:10 +02:00
/**
* Check the plugins directory and retrieve all plugin files with plugin data .
*
* WordPress only supports plugin files in the base plugins directory
* ( wp - content / plugins ) and in one directory above the plugins directory
* ( wp - content / plugins / my - plugin ) . The file it looks for has the plugin data and
* must be found in those two locations . It is recommended that do keep your
* plugin files in directories .
*
* The file with the plugin data is the file that will be included and therefore
* needs to have the main execution for the plugin . This does not mean
* everything must be contained in the file and it is recommended that the file
* be split for maintainability . Keep everything in one file for extreme
* optimization purposes .
*
* @ since unknown
*
* @ param string $plugin_folder Optional . Relative path to single plugin folder .
* @ return array Key is the plugin file path and the value is an array of the plugin data .
*/
2008-03-22 00:02:00 +01:00
function get_plugins ( $plugin_folder = '' ) {
2008-08-09 07:36:14 +02:00
2008-06-10 18:57:33 +02:00
if ( ! $cache_plugins = wp_cache_get ( 'plugins' , 'plugins' ) )
2008-08-01 06:26:32 +02:00
$cache_plugins = array ();
2008-08-09 07:36:14 +02:00
2008-06-10 18:57:33 +02:00
if ( isset ( $cache_plugins [ $plugin_folder ]) )
return $cache_plugins [ $plugin_folder ];
2008-08-09 07:36:14 +02:00
2007-05-25 09:16:21 +02:00
$wp_plugins = array ();
2008-05-27 19:55:24 +02:00
$plugin_root = WP_PLUGIN_DIR ;
2008-03-22 00:02:00 +01:00
if ( ! empty ( $plugin_folder ) )
$plugin_root .= $plugin_folder ;
2007-05-25 09:16:21 +02:00
// Files in wp-content/plugins directory
2007-08-14 04:58:33 +02:00
$plugins_dir = @ opendir ( $plugin_root );
2007-05-25 09:16:21 +02:00
if ( $plugins_dir ) {
2007-08-14 04:58:33 +02:00
while (( $file = readdir ( $plugins_dir ) ) !== false ) {
2007-05-25 09:16:21 +02:00
if ( substr ( $file , 0 , 1 ) == '.' )
continue ;
if ( is_dir ( $plugin_root . '/' . $file ) ) {
2007-08-14 04:58:33 +02:00
$plugins_subdir = @ opendir ( $plugin_root . '/' . $file );
2007-05-25 09:16:21 +02:00
if ( $plugins_subdir ) {
2007-08-14 04:58:33 +02:00
while (( $subfile = readdir ( $plugins_subdir ) ) !== false ) {
2007-05-25 09:16:21 +02:00
if ( substr ( $subfile , 0 , 1 ) == '.' )
continue ;
if ( substr ( $subfile , - 4 ) == '.php' )
$plugin_files [] = " $file / $subfile " ;
}
}
} else {
if ( substr ( $file , - 4 ) == '.php' )
$plugin_files [] = $file ;
}
}
}
2007-08-14 04:58:33 +02:00
@ closedir ( $plugins_dir );
@ closedir ( $plugins_subdir );
2007-05-25 09:16:21 +02:00
if ( ! $plugins_dir || ! $plugin_files )
return $wp_plugins ;
foreach ( $plugin_files as $plugin_file ) {
if ( ! is_readable ( " $plugin_root / $plugin_file " ) )
continue ;
2008-10-22 02:08:22 +02:00
$plugin_data = get_plugin_data ( " $plugin_root / $plugin_file " , false , false ); //Do not apply markup/translate as it'll be cached.
2007-05-25 09:16:21 +02:00
if ( empty ( $plugin_data [ 'Name' ] ) )
continue ;
$wp_plugins [ plugin_basename ( $plugin_file )] = $plugin_data ;
}
uasort ( $wp_plugins , create_function ( '$a, $b' , 'return strnatcasecmp( $a["Name"], $b["Name"] );' ));
2008-08-09 07:36:14 +02:00
$cache_plugins [ $plugin_folder ] = $wp_plugins ;
wp_cache_set ( 'plugins' , $cache_plugins , 'plugins' );
2008-06-10 18:57:33 +02:00
2007-05-25 09:16:21 +02:00
return $wp_plugins ;
}
2008-08-08 01:39:27 +02:00
/**
* Check whether the plugin is active by checking the active_plugins list .
*
* @ since 2.5 . 0
*
* @ param string $plugin Base plugin path from plugins directory .
* @ return bool True , if in the active plugins list . False , not in the list .
*/
function is_plugin_active ( $plugin ) {
2008-03-22 00:02:00 +01:00
return in_array ( $plugin , get_option ( 'active_plugins' ));
}
2008-09-17 02:40:10 +02:00
/**
* Attempts activation of plugin in a " sandbox " and redirects on success .
*
* A plugin that is already activated will not attempt to be activated again .
*
* The way it works is by setting the redirection to the error before trying to
* include the plugin file . If the plugin fails , then the redirection will not
* be overwritten with the success message . Also , the options will not be
* updated and the activation hook will not be called on plugin error .
*
* It should be noted that in no way the below code will actually prevent errors
* within the file . The code should not be used elsewhere to replicate the
* " sandbox " , which uses redirection to work .
* { @ source 13 1 }
*
* If any errors are found or text is outputted , then it will be captured to
* ensure that the success redirection will update the error redirection .
*
* @ since unknown
*
* @ param string $plugin Plugin path to main plugin file with plugin data .
* @ param string $redirect Optional . URL to redirect to .
* @ return WP_Error | null WP_Error on invalid file or null on success .
*/
2008-01-09 10:37:27 +01:00
function activate_plugin ( $plugin , $redirect = '' ) {
2008-09-17 02:40:10 +02:00
$current = get_option ( 'active_plugins' );
2008-10-22 01:55:58 +02:00
$plugin = plugin_basename ( trim ( $plugin ));
2008-09-17 02:40:10 +02:00
$valid = validate_plugin ( $plugin );
if ( is_wp_error ( $valid ) )
return $valid ;
2007-10-17 19:14:58 +02:00
2008-09-17 02:40:10 +02:00
if ( ! 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 ();
@ include ( WP_PLUGIN_DIR . '/' . $plugin );
$current [] = $plugin ;
sort ( $current );
update_option ( 'active_plugins' , $current );
do_action ( 'activate_' . $plugin );
ob_end_clean ();
}
return null ;
2007-10-17 19:14:58 +02:00
}
2008-09-17 02:40:10 +02:00
/**
* Deactivate a single plugin or multiple plugins .
*
* The deactivation hook is disabled by the plugin upgrader by using the $silent
* parameter .
*
* @ since unknown
*
* @ param string | array $plugins Single plugin or list of plugins to deactivate .
* @ param bool $silent Optional , default is false . Prevent calling deactivate hook .
*/
2008-03-22 00:02:00 +01:00
function deactivate_plugins ( $plugins , $silent = false ) {
2007-10-17 19:14:58 +02:00
$current = get_option ( 'active_plugins' );
2008-01-09 10:37:27 +01:00
if ( ! is_array ( $plugins ) )
2007-10-17 19:14:58 +02:00
$plugins = array ( $plugins );
2008-01-09 10:37:27 +01:00
foreach ( $plugins as $plugin ) {
2008-10-22 01:55:58 +02:00
$plugin = plugin_basename ( $plugin );
2008-03-23 17:36:05 +01:00
if ( ! is_plugin_active ( $plugin ) )
2008-03-20 18:24:44 +01:00
continue ;
2008-03-23 17:36:05 +01:00
array_splice ( $current , array_search ( $plugin , $current ), 1 ); // Fixed Array-fu!
if ( ! $silent ) //Used by Plugin updater to internally deactivate plugin, however, not to notify plugins of the fact to prevent plugin output.
2008-03-22 00:02:00 +01:00
do_action ( 'deactivate_' . trim ( $plugin ));
2007-10-17 19:14:58 +02:00
}
update_option ( 'active_plugins' , $current );
}
2008-09-17 02:40:10 +02:00
/**
* Activate multiple plugins .
*
* When WP_Error is returned , it does not mean that one of the plugins had
* errors . It means that one or more of the plugins file path was invalid .
*
* The execution will be halted as soon as one of the plugins has an error .
*
* @ since unknown
*
* @ param string | array $plugins
* @ param string $redirect Redirect to page after successful activation .
* @ return bool | WP_Error True when finished or WP_Error if there were errors during a plugin activation .
*/
2008-06-04 20:09:31 +02:00
function activate_plugins ( $plugins , $redirect = '' ) {
if ( ! is_array ( $plugins ) )
$plugins = array ( $plugins );
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
$errors = array ();
foreach ( ( array ) $plugins as $plugin ) {
if ( ! empty ( $redirect ) )
$redirect = add_query_arg ( 'plugin' , $plugin , $redirect );
$result = activate_plugin ( $plugin , $redirect );
if ( is_wp_error ( $result ) )
$errors [ $plugin ] = $result ;
}
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
if ( ! empty ( $errors ) )
return new WP_Error ( 'plugins_invalid' , __ ( 'One of the plugins is invalid.' ), $errors );
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
return true ;
}
2008-01-09 10:37:27 +01:00
2008-09-17 02:40:10 +02:00
/**
* Remove directory and files of a plugin for a single or list of plugin ( s ) .
*
* If the plugins parameter list is empty , false will be returned . True when
* completed .
*
* @ since unknown
*
* @ param array $plugins List of plugin
* @ param string $redirect Redirect to page when complete .
* @ return mixed
*/
2008-06-04 20:09:31 +02:00
function delete_plugins ( $plugins , $redirect = '' ) {
global $wp_filesystem ;
if ( empty ( $plugins ) )
return false ;
$checked = array ();
foreach ( $plugins as $plugin )
$checked [] = 'checked[]=' . $plugin ;
ob_start ();
2008-06-16 20:35:48 +02:00
$url = wp_nonce_url ( 'plugins.php?action=delete-selected&verify-delete=1&' . implode ( '&' , $checked ), 'bulk-manage-plugins' );
2008-06-04 20:09:31 +02:00
if ( false === ( $credentials = request_filesystem_credentials ( $url )) ) {
$data = ob_get_contents ();
ob_end_clean ();
if ( ! empty ( $data ) ){
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
echo $data ;
include ( ABSPATH . 'wp-admin/admin-footer.php' );
exit ;
}
2008-01-09 10:37:27 +01:00
return ;
2008-06-04 20:09:31 +02:00
}
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
if ( ! WP_Filesystem ( $credentials ) ) {
request_filesystem_credentials ( $url , '' , true ); //Failed to connect, Error and request again
$data = ob_get_contents ();
ob_end_clean ();
if ( ! empty ( $data ) ){
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
echo $data ;
include ( ABSPATH . 'wp-admin/admin-footer.php' );
exit ;
}
return ;
}
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
if ( $wp_filesystem -> errors -> get_error_code () ) {
return $wp_filesystem -> errors ;
2008-01-09 10:37:27 +01:00
}
2008-06-04 20:09:31 +02:00
if ( ! is_object ( $wp_filesystem ) )
return new WP_Error ( 'fs_unavailable' , __ ( 'Could not access filesystem.' ));
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
if ( $wp_filesystem -> errors -> get_error_code () )
return new WP_Error ( 'fs_error' , __ ( 'Filesystem error' ), $wp_filesystem -> errors );
//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.' ));
2008-08-09 07:36:14 +02:00
2008-06-04 20:09:31 +02:00
$plugins_dir = trailingslashit ( $plugins_dir );
2008-01-09 10:37:27 +01:00
2008-06-04 20:09:31 +02:00
$errors = array ();
foreach ( $plugins as $plugin_file ) {
2008-08-08 01:39:27 +02:00
// Run Uninstall hook
if ( is_uninstallable_plugin ( $plugin_file ) )
uninstall_plugin ( $plugin_file );
2008-06-04 20:09:31 +02:00
$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 seperator AND that its not the root plugin folder
$deleted = $wp_filesystem -> delete ( $this_plugin_dir , true );
else
$deleted = $wp_filesystem -> delete ( $plugins_dir . $plugin_file );
2008-08-09 07:36:14 +02:00
2008-06-04 20:09:31 +02:00
if ( ! $deleted )
$errors [] = $plugin_file ;
}
2008-08-09 07:36:14 +02:00
2008-12-04 19:39:11 +01:00
if ( ! empty ( $errors ) )
2008-06-04 20:09:31 +02:00
return new WP_Error ( 'could_not_remove_plugin' , sprintf ( __ ( 'Could not fully remove the plugin(s) %s' ), implode ( ', ' , $errors )) );
2008-08-09 07:36:14 +02:00
2008-12-04 19:39:11 +01:00
// Force refresh of plugin update information
delete_option ( 'update_plugins' );
2008-01-09 10:37:27 +01:00
return true ;
}
function validate_active_plugins () {
$check_plugins = get_option ( 'active_plugins' );
// Sanity check. If the active plugin list is not an array, make it an
// empty array.
if ( ! is_array ( $check_plugins ) ) {
update_option ( 'active_plugins' , array ());
return ;
}
2008-07-30 01:10:12 +02:00
//Invalid is any plugin that is deactivated due to error.
2008-08-09 07:36:14 +02:00
$invalid = array ();
2008-07-30 01:10:12 +02:00
2008-01-09 10:37:27 +01:00
// If a plugin file does not exist, remove it from the list of active
// plugins.
foreach ( $check_plugins as $check_plugin ) {
2008-06-16 20:35:48 +02:00
$result = validate_plugin ( $check_plugin );
if ( is_wp_error ( $result ) ) {
2008-07-30 01:10:12 +02:00
$invalid [ $check_plugin ] = $result ;
2008-06-16 20:35:48 +02:00
deactivate_plugins ( $check_plugin , true );
2008-01-09 10:37:27 +01:00
}
}
2008-07-30 01:10:12 +02:00
return $invalid ;
2008-01-09 10:37:27 +01:00
}
2008-09-17 02:40:10 +02:00
/**
* Validate the plugin path .
*
* Checks that the file exists and { @ link validate_file () is valid file } .
*
* @ since unknown
*
* @ param string $plugin Plugin Path
* @ return WP_Error | int 0 on success , WP_Error on failure .
*/
2008-01-09 10:37:27 +01:00
function validate_plugin ( $plugin ) {
if ( validate_file ( $plugin ) )
2008-07-30 02:02:47 +02:00
return new WP_Error ( 'plugin_invalid' , __ ( 'Invalid plugin path.' ));
2008-05-27 19:55:24 +02:00
if ( ! file_exists ( WP_PLUGIN_DIR . '/' . $plugin ) )
2008-01-09 10:37:27 +01:00
return new WP_Error ( 'plugin_not_found' , __ ( 'Plugin file does not exist.' ));
2009-02-19 19:39:04 +01:00
$installed_plugins = get_plugins ();
if ( ! isset ( $installed_plugins [ $plugin ]) )
return new WP_Error ( 'no_plugin_header' , __ ( 'The plugin does not have a valid header.' ));
2008-01-09 10:37:27 +01:00
return 0 ;
2007-10-17 19:14:58 +02:00
}
2008-08-08 01:39:27 +02:00
/**
* Whether the plugin can be uninstalled .
*
2008-09-17 02:40:10 +02:00
* @ since 2.7 . 0
2008-08-08 01:39:27 +02:00
*
* @ param string $plugin Plugin path to check .
* @ return bool Whether plugin can be uninstalled .
*/
function is_uninstallable_plugin ( $plugin ) {
$file = plugin_basename ( $plugin );
$uninstallable_plugins = ( array ) get_option ( 'uninstall_plugins' );
if ( isset ( $uninstallable_plugins [ $file ] ) || file_exists ( WP_PLUGIN_DIR . '/' . dirname ( $file ) . '/uninstall.php' ) )
return true ;
return false ;
}
/**
* Uninstall a single plugin .
*
* Calls the uninstall hook , if it is available .
*
2008-09-17 02:40:10 +02:00
* @ since 2.7 . 0
2008-08-08 06:15:03 +02:00
*
2008-08-08 01:39:27 +02:00
* @ param string $plugin Relative plugin path from Plugin Directory .
*/
function uninstall_plugin ( $plugin ) {
$file = plugin_basename ( $plugin );
$uninstallable_plugins = ( array ) get_option ( 'uninstall_plugins' );
if ( file_exists ( WP_PLUGIN_DIR . '/' . dirname ( $file ) . '/uninstall.php' ) ) {
if ( isset ( $uninstallable_plugins [ $file ] ) ) {
unset ( $uninstallable_plugins [ $file ]);
update_option ( 'uninstall_plugins' , $uninstallable_plugins );
}
unset ( $uninstallable_plugins );
define ( 'WP_UNINSTALL_PLUGIN' , $file );
include WP_PLUGIN_DIR . '/' . dirname ( $file ) . '/uninstall.php' ;
return true ;
}
if ( isset ( $uninstallable_plugins [ $file ] ) ) {
$callable = $uninstallable_plugins [ $file ];
unset ( $uninstallable_plugins [ $file ]);
update_option ( 'uninstall_plugins' , $uninstallable_plugins );
unset ( $uninstallable_plugins );
include WP_PLUGIN_DIR . '/' . $file ;
add_action ( 'uninstall_' . $file , $callable );
do_action ( 'uninstall_' . $file );
}
}
2007-05-25 09:16:21 +02:00
//
// Menu
//
2008-10-15 08:54:25 +02:00
function add_menu_page ( $page_title , $menu_title , $access_level , $file , $function = '' , $icon_url = '' ) {
2007-05-25 09:16:21 +02:00
global $menu , $admin_page_hooks ;
$file = plugin_basename ( $file );
$admin_page_hooks [ $file ] = sanitize_title ( $menu_title );
$hookname = get_plugin_page_hookname ( $file , '' );
if ( ! empty ( $function ) && ! empty ( $hookname ))
add_action ( $hookname , $function );
2008-10-15 08:54:25 +02:00
if ( empty ( $icon_url ) )
2008-11-09 15:54:39 +01:00
$icon_url = 'images/generic.png' ;
2008-12-09 19:03:31 +01:00
2008-11-09 15:54:39 +01:00
$menu [] = array ( $menu_title , $access_level , $file , $page_title , 'menu-top ' . $hookname , $hookname , $icon_url );
2008-10-15 00:44:56 +02:00
2007-05-25 09:16:21 +02:00
return $hookname ;
}
2008-11-05 23:46:58 +01:00
function add_object_page ( $page_title , $menu_title , $access_level , $file , $function = '' , $icon_url = '' ) {
global $menu , $admin_page_hooks , $_wp_last_object_menu ;
$file = plugin_basename ( $file );
$admin_page_hooks [ $file ] = sanitize_title ( $menu_title );
$hookname = get_plugin_page_hookname ( $file , '' );
if ( ! empty ( $function ) && ! empty ( $hookname ))
add_action ( $hookname , $function );
if ( empty ( $icon_url ) )
2008-11-12 10:35:50 +01:00
$icon_url = 'images/generic.png' ;
2008-11-05 23:46:58 +01:00
$_wp_last_object_menu ++ ;
2008-11-09 20:20:38 +01:00
$menu [ $_wp_last_object_menu ] = array ( $menu_title , $access_level , $file , $page_title , 'menu-top ' . $hookname , $hookname , $icon_url );
2008-11-28 20:34:49 +01:00
return $hookname ;
}
function add_utility_page ( $page_title , $menu_title , $access_level , $file , $function = '' , $icon_url = '' ) {
global $menu , $admin_page_hooks , $_wp_last_utility_menu ;
$file = plugin_basename ( $file );
$admin_page_hooks [ $file ] = sanitize_title ( $menu_title );
$hookname = get_plugin_page_hookname ( $file , '' );
if ( ! empty ( $function ) && ! empty ( $hookname ))
add_action ( $hookname , $function );
if ( empty ( $icon_url ) )
$icon_url = 'images/generic.png' ;
$_wp_last_utility_menu ++ ;
$menu [ $_wp_last_utility_menu ] = array ( $menu_title , $access_level , $file , $page_title , 'menu-top ' . $hookname , $hookname , $icon_url );
2008-11-05 23:46:58 +01:00
return $hookname ;
}
2007-05-25 09:16:21 +02:00
function add_submenu_page ( $parent , $page_title , $menu_title , $access_level , $file , $function = '' ) {
global $submenu ;
global $menu ;
global $_wp_real_parent_file ;
global $_wp_submenu_nopriv ;
$file = plugin_basename ( $file );
$parent = plugin_basename ( $parent );
if ( isset ( $_wp_real_parent_file [ $parent ] ) )
$parent = $_wp_real_parent_file [ $parent ];
if ( ! current_user_can ( $access_level ) ) {
$_wp_submenu_nopriv [ $parent ][ $file ] = true ;
return false ;
}
// If the parent doesn't already have a submenu, add a link to the parent
// as the first item in the submenu. If the submenu file is the same as the
// parent file someone is trying to link back to the parent manually. In
// this case, don't automatically add a link back to avoid duplication.
if ( ! isset ( $submenu [ $parent ] ) && $file != $parent ) {
2009-01-04 05:29:28 +01:00
foreach ( ( array ) $menu as $parent_menu ) {
2007-05-25 09:16:21 +02:00
if ( $parent_menu [ 2 ] == $parent && current_user_can ( $parent_menu [ 1 ] ) )
$submenu [ $parent ][] = $parent_menu ;
}
}
$submenu [ $parent ][] = array ( $menu_title , $access_level , $file , $page_title );
$hookname = get_plugin_page_hookname ( $file , $parent );
if ( ! empty ( $function ) && ! empty ( $hookname ))
add_action ( $hookname , $function );
return $hookname ;
}
2008-09-17 02:40:10 +02:00
/**
2008-11-14 21:53:43 +01:00
* Add sub menu page to the tools main menu .
2008-09-17 02:40:10 +02:00
*
2008-12-09 19:03:31 +01:00
* @ param string $page_title
2008-09-17 02:40:10 +02:00
* @ param unknown_type $menu_title
* @ param unknown_type $access_level
* @ param unknown_type $file
* @ param unknown_type $function
* @ return unknown
*/
2007-05-25 09:16:21 +02:00
function add_management_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
2008-11-27 22:11:25 +01:00
return add_submenu_page ( 'tools.php' , $page_title , $menu_title , $access_level , $file , $function );
2007-05-25 09:16:21 +02:00
}
function add_options_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
return add_submenu_page ( 'options-general.php' , $page_title , $menu_title , $access_level , $file , $function );
}
function add_theme_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
return add_submenu_page ( 'themes.php' , $page_title , $menu_title , $access_level , $file , $function );
}
function add_users_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
if ( current_user_can ( 'edit_users' ) )
$parent = 'users.php' ;
else
$parent = 'profile.php' ;
return add_submenu_page ( $parent , $page_title , $menu_title , $access_level , $file , $function );
}
2008-11-18 20:30:50 +01:00
function add_dashboard_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
return add_submenu_page ( 'index.php' , $page_title , $menu_title , $access_level , $file , $function );
}
2008-11-14 21:53:43 +01:00
function add_posts_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
2008-11-25 20:05:48 +01:00
return add_submenu_page ( 'edit.php' , $page_title , $menu_title , $access_level , $file , $function );
2008-11-14 21:53:43 +01:00
}
function add_media_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
2008-11-25 20:05:48 +01:00
return add_submenu_page ( 'upload.php' , $page_title , $menu_title , $access_level , $file , $function );
2008-11-14 21:53:43 +01:00
}
function add_links_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
2008-11-25 20:05:48 +01:00
return add_submenu_page ( 'link-manager.php' , $page_title , $menu_title , $access_level , $file , $function );
2008-11-14 21:53:43 +01:00
}
function add_pages_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
2008-11-25 20:05:48 +01:00
return add_submenu_page ( 'edit-pages.php' , $page_title , $menu_title , $access_level , $file , $function );
2008-11-14 21:53:43 +01:00
}
function add_comments_page ( $page_title , $menu_title , $access_level , $file , $function = '' ) {
return add_submenu_page ( 'edit-comments.php' , $page_title , $menu_title , $access_level , $file , $function );
}
2007-05-25 09:16:21 +02:00
//
// Pluggable Menu Support -- Private
//
2008-08-26 02:54:21 +02:00
function get_admin_page_parent ( $parent = '' ) {
2007-05-25 09:16:21 +02:00
global $parent_file ;
global $menu ;
global $submenu ;
global $pagenow ;
global $plugin_page ;
global $_wp_real_parent_file ;
global $_wp_menu_nopriv ;
global $_wp_submenu_nopriv ;
2008-08-26 06:27:00 +02:00
if ( ! empty ( $parent ) && 'admin.php' != $parent ) {
2008-08-26 02:54:21 +02:00
if ( isset ( $_wp_real_parent_file [ $parent ] ) )
$parent = $_wp_real_parent_file [ $parent ];
return $parent ;
}
2008-09-26 18:43:47 +02:00
/*
2007-05-25 09:16:21 +02:00
if ( ! empty ( $parent_file ) ) {
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
2008-09-26 18:43:47 +02:00
*/
2007-05-25 09:16:21 +02:00
if ( $pagenow == 'admin.php' && isset ( $plugin_page ) ) {
2009-01-04 05:29:28 +01:00
foreach ( ( array ) $menu as $parent_menu ) {
2007-05-25 09:16:21 +02:00
if ( $parent_menu [ 2 ] == $plugin_page ) {
$parent_file = $plugin_page ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
}
if ( isset ( $_wp_menu_nopriv [ $plugin_page ] ) ) {
$parent_file = $plugin_page ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
}
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $pagenow ][ $plugin_page ] ) ) {
$parent_file = $pagenow ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
2009-01-04 05:29:28 +01:00
foreach ( array_keys ( ( array ) $submenu ) as $parent ) {
2007-05-25 09:16:21 +02:00
foreach ( $submenu [ $parent ] as $submenu_array ) {
if ( isset ( $_wp_real_parent_file [ $parent ] ) )
$parent = $_wp_real_parent_file [ $parent ];
if ( $submenu_array [ 2 ] == $pagenow ) {
$parent_file = $parent ;
return $parent ;
} else
if ( isset ( $plugin_page ) && ( $plugin_page == $submenu_array [ 2 ] ) ) {
$parent_file = $parent ;
return $parent ;
}
}
}
2008-11-29 02:56:09 +01:00
if ( empty ( $parent_file ) )
$parent_file = '' ;
2007-05-25 09:16:21 +02:00
return '' ;
}
function get_admin_page_title () {
global $title ;
global $menu ;
global $submenu ;
global $pagenow ;
global $plugin_page ;
if ( isset ( $title ) && ! empty ( $title ) ) {
return $title ;
}
$hook = get_plugin_page_hook ( $plugin_page , $pagenow );
$parent = $parent1 = get_admin_page_parent ();
2008-10-15 00:44:56 +02:00
2007-05-25 09:16:21 +02:00
if ( empty ( $parent ) ) {
2009-01-04 05:29:28 +01:00
foreach ( ( array ) $menu as $menu_array ) {
2007-05-25 09:16:21 +02:00
if ( isset ( $menu_array [ 3 ] ) ) {
if ( $menu_array [ 2 ] == $pagenow ) {
$title = $menu_array [ 3 ];
return $menu_array [ 3 ];
} else
if ( isset ( $plugin_page ) && ( $plugin_page == $menu_array [ 2 ] ) && ( $hook == $menu_array [ 3 ] ) ) {
$title = $menu_array [ 3 ];
return $menu_array [ 3 ];
}
} else {
$title = $menu_array [ 0 ];
return $title ;
}
}
} else {
foreach ( array_keys ( $submenu ) as $parent ) {
foreach ( $submenu [ $parent ] as $submenu_array ) {
2007-09-04 01:32:58 +02:00
if ( isset ( $plugin_page ) &&
( $plugin_page == $submenu_array [ 2 ] ) &&
2007-05-25 09:16:21 +02:00
(( $parent == $pagenow ) || ( $parent == $plugin_page ) || ( $plugin_page == $hook ) || (( $pagenow == 'admin.php' ) && ( $parent1 != $submenu_array [ 2 ] ) ) )
) {
$title = $submenu_array [ 3 ];
return $submenu_array [ 3 ];
}
if ( $submenu_array [ 2 ] != $pagenow || isset ( $_GET [ 'page' ] ) ) // not the current page
continue ;
if ( isset ( $submenu_array [ 3 ] ) ) {
$title = $submenu_array [ 3 ];
return $submenu_array [ 3 ];
} else {
$title = $submenu_array [ 0 ];
return $title ;
}
}
}
}
return $title ;
}
function get_plugin_page_hook ( $plugin_page , $parent_page ) {
$hook = get_plugin_page_hookname ( $plugin_page , $parent_page );
2007-11-07 05:30:11 +01:00
if ( has_action ( $hook ) )
2007-05-25 09:16:21 +02:00
return $hook ;
else
2007-07-15 19:59:05 +02:00
return null ;
2007-05-25 09:16:21 +02:00
}
function get_plugin_page_hookname ( $plugin_page , $parent_page ) {
global $admin_page_hooks ;
2008-08-26 02:54:21 +02:00
$parent = get_admin_page_parent ( $parent_page );
2007-05-25 09:16:21 +02:00
2008-07-07 16:21:47 +02:00
$page_type = 'admin' ;
2008-10-15 00:44:56 +02:00
if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset ( $admin_page_hooks [ $plugin_page ] ) ) {
if ( isset ( $admin_page_hooks [ $plugin_page ] ) )
2007-05-25 09:16:21 +02:00
$page_type = 'toplevel' ;
else
if ( isset ( $admin_page_hooks [ $parent ] ))
$page_type = $admin_page_hooks [ $parent ];
2008-08-22 06:32:42 +02:00
} else if ( isset ( $admin_page_hooks [ $parent ] ) ) {
$page_type = $admin_page_hooks [ $parent ];
2008-07-07 16:21:47 +02:00
}
2007-05-25 09:16:21 +02:00
$plugin_name = preg_replace ( '!\.php!' , '' , $plugin_page );
return $page_type . '_page_' . $plugin_name ;
}
function user_can_access_admin_page () {
global $pagenow ;
global $menu ;
global $submenu ;
global $_wp_menu_nopriv ;
global $_wp_submenu_nopriv ;
global $plugin_page ;
$parent = get_admin_page_parent ();
2008-12-30 20:18:18 +01:00
if ( ! isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $parent ][ $pagenow ] ) )
2007-05-25 09:16:21 +02:00
return false ;
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $parent ][ $plugin_page ] ) )
return false ;
if ( empty ( $parent ) ) {
if ( isset ( $_wp_menu_nopriv [ $pagenow ] ) )
return false ;
if ( isset ( $_wp_submenu_nopriv [ $pagenow ][ $pagenow ] ) )
return false ;
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $pagenow ][ $plugin_page ] ) )
return false ;
foreach ( array_keys ( $_wp_submenu_nopriv ) as $key ) {
if ( isset ( $_wp_submenu_nopriv [ $key ][ $pagenow ] ) )
return false ;
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $key ][ $plugin_page ] ) )
return false ;
}
return true ;
}
if ( isset ( $submenu [ $parent ] ) ) {
foreach ( $submenu [ $parent ] as $submenu_array ) {
if ( isset ( $plugin_page ) && ( $submenu_array [ 2 ] == $plugin_page ) ) {
if ( current_user_can ( $submenu_array [ 1 ] ))
return true ;
else
return false ;
} else if ( $submenu_array [ 2 ] == $pagenow ) {
if ( current_user_can ( $submenu_array [ 1 ] ))
return true ;
else
return false ;
}
}
}
foreach ( $menu as $menu_array ) {
if ( $menu_array [ 2 ] == $parent ) {
if ( current_user_can ( $menu_array [ 1 ] ))
return true ;
else
return false ;
}
}
return true ;
}
2008-10-20 01:35:09 +02:00
/* Whitelist functions */
/**
* Register a setting and its sanitization callback
*
* @ since 2.7 . 0
*
* @ param string $option_group A settings group name . Can be anything .
* @ 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
*/
function register_setting ( $option_group , $option_name , $sanitize_callback = '' ) {
return add_option_update_handler ( $option_group , $option_name , $sanitize_callback );
}
/**
* Unregister a setting
*
* @ since 2.7 . 0
*
* @ param unknown_type $option_group
* @ param unknown_type $option_name
* @ param unknown_type $sanitize_callback
* @ return unknown
*/
function unregister_setting ( $option_group , $option_name , $sanitize_callback = '' ) {
return remove_option_update_handler ( $option_group , $option_name , $sanitize_callback );
}
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $option_group
* @ param unknown_type $option_name
* @ param unknown_type $sanitize_callback
*/
function add_option_update_handler ( $option_group , $option_name , $sanitize_callback = '' ) {
global $new_whitelist_options ;
$new_whitelist_options [ $option_group ][] = $option_name ;
if ( $sanitize_callback != '' )
add_filter ( " sanitize_option_ { $option_name } " , $sanitize_callback );
}
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $option_group
* @ param unknown_type $option_name
* @ param unknown_type $sanitize_callback
*/
function remove_option_update_handler ( $option_group , $option_name , $sanitize_callback = '' ) {
global $new_whitelist_options ;
$pos = array_search ( $option_name , $new_whitelist_options );
if ( $pos !== false )
unset ( $new_whitelist_options [ $option_group ][ $pos ] );
if ( $sanitize_callback != '' )
remove_filter ( " sanitize_option_ { $option_name } " , $sanitize_callback );
}
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $options
* @ return unknown
*/
function option_update_filter ( $options ) {
global $new_whitelist_options ;
if ( is_array ( $new_whitelist_options ) )
$options = add_option_whitelist ( $new_whitelist_options , $options );
return $options ;
}
add_filter ( 'whitelist_options' , 'option_update_filter' );
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $new_options
* @ param unknown_type $options
* @ return unknown
*/
function add_option_whitelist ( $new_options , $options = '' ) {
if ( $options == '' ) {
global $whitelist_options ;
} else {
$whitelist_options = $options ;
}
foreach ( $new_options as $page => $keys ) {
foreach ( $keys as $key ) {
2008-12-05 00:20:41 +01:00
if ( ! isset ( $whitelist_options [ $page ]) || ! is_array ( $whitelist_options [ $page ]) ) {
$whitelist_options [ $page ] = array ();
2008-10-20 01:35:09 +02:00
$whitelist_options [ $page ][] = $key ;
2008-12-05 00:20:41 +01:00
} else {
$pos = array_search ( $key , $whitelist_options [ $page ] );
if ( $pos === false )
$whitelist_options [ $page ][] = $key ;
}
2008-10-20 01:35:09 +02:00
}
}
return $whitelist_options ;
}
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $del_options
* @ param unknown_type $options
* @ return unknown
*/
function remove_option_whitelist ( $del_options , $options = '' ) {
if ( $options == '' ) {
global $whitelist_options ;
} else {
$whitelist_options = $options ;
}
foreach ( $del_options as $page => $keys ) {
foreach ( $keys as $key ) {
2008-12-18 23:26:03 +01:00
if ( isset ( $whitelist_options [ $page ]) && is_array ( $whitelist_options [ $page ]) ) {
$pos = array_search ( $key , $whitelist_options [ $page ] );
if ( $pos !== false )
unset ( $whitelist_options [ $page ][ $pos ] );
}
2008-10-20 01:35:09 +02:00
}
}
return $whitelist_options ;
}
/**
* Output nonce , action , and option_page fields for a settings page .
*
* @ since 2.7 . 0
*
* @ param string $option_group A settings group name . This should match the group name used in register_setting () .
*/
function settings_fields ( $option_group ) {
echo " <input type='hidden' name='option_page' value=' $option_group ' /> " ;
echo '<input type="hidden" name="action" value="update" />' ;
wp_nonce_field ( " $option_group -options " );
}
2008-11-27 22:11:25 +01:00
?>