| [ Index ] |
PHP Cross Reference of Wordpress 2.9.1 |
[Source view] [Print] [Project Stats]
WordPress Plugin Administration API
| File Size: | 1126 lines (36 kb) |
| Included or required: | 2 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files wp-admin/admin-header.php wp-admin/admin-footer.php |
| get_plugin_data( $plugin_file, $markup = true, $translate = true ) X-Ref |
| Parse the plugin contents to retrieve plugin's metadata. The metadata of the plugin's data searches for the following in the plugin's 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. <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() 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. * / # 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. '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. 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 the plugin contents when it has all of the required plugin data. The first 8kiB of the file will be pulled in and if the plugin data is not within that first 8kiB, 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. param: string $plugin_file Path to the plugin file param: bool $markup If the returned data should have HTML markup applied param: bool $translate If the returned data should be translated return: array See above for description. |
| _get_plugin_data_markup_translate($plugin_file, $plugin_data, $markup = true, $translate = true) X-Ref |
| No description |
| get_plugin_files($plugin) X-Ref |
| Get a list of a plugin's files. param: string $plugin Plugin ID return: array List of files relative to the plugin root. |
| get_plugins($plugin_folder = '') X-Ref |
| 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. 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. |
| is_plugin_active($plugin) X-Ref |
| Check whether the plugin is active by checking the active_plugins list. param: string $plugin Base plugin path from plugins directory. return: bool True, if in the active plugins list. False, not in the list. |
| activate_plugin($plugin, $redirect = '') X-Ref |
| 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. 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. |
| deactivate_plugins($plugins, $silent= false) X-Ref |
| Deactivate a single plugin or multiple plugins. The deactivation hook is disabled by the plugin upgrader by using the $silent parameter. param: string|array $plugins Single plugin or list of plugins to deactivate. param: bool $silent Optional, default is false. Prevent calling deactivate hook. |
| activate_plugins($plugins, $redirect = '') X-Ref |
| 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. 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. |
| delete_plugins($plugins, $redirect = '' ) X-Ref |
| 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. param: array $plugins List of plugin param: string $redirect Redirect to page when complete. return: mixed |
| validate_active_plugins() X-Ref |
| No description |
| validate_plugin($plugin) X-Ref |
| Validate the plugin path. Checks that the file exists and {@link validate_file() is valid file}. param: string $plugin Plugin Path return: WP_Error|int 0 on success, WP_Error on failure. |
| is_uninstallable_plugin($plugin) X-Ref |
| Whether the plugin can be uninstalled. param: string $plugin Plugin path to check. return: bool Whether plugin can be uninstalled. |
| uninstall_plugin($plugin) X-Ref |
| Uninstall a single plugin. Calls the uninstall hook, if it is available. param: string $plugin Relative plugin path from Plugin Directory. |
| add_menu_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '', $position = NULL ) X-Ref |
| No description |
| add_object_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '') X-Ref |
| No description |
| add_utility_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '') X-Ref |
| No description |
| add_submenu_page( $parent, $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_management_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| Add sub menu page to the tools main menu. param: string $page_title param: unknown_type $menu_title param: unknown_type $access_level param: unknown_type $file param: unknown_type $function return: unknown |
| add_options_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_theme_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_users_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_dashboard_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_posts_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_media_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_links_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_pages_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| add_comments_page( $page_title, $menu_title, $access_level, $file, $function = '' ) X-Ref |
| No description |
| get_admin_page_parent( $parent = '' ) X-Ref |
| No description |
| get_admin_page_title() X-Ref |
| No description |
| get_plugin_page_hook( $plugin_page, $parent_page ) X-Ref |
| No description |
| get_plugin_page_hookname( $plugin_page, $parent_page ) X-Ref |
| No description |
| user_can_access_admin_page() X-Ref |
| No description |
| register_setting($option_group, $option_name, $sanitize_callback = '') X-Ref |
| Register a setting and its sanitization callback param: string $option_group A settings group name. Should correspond to a whitelisted option key name. 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 |
| unregister_setting($option_group, $option_name, $sanitize_callback = '') X-Ref |
| Unregister a setting param: unknown_type $option_group param: unknown_type $option_name param: unknown_type $sanitize_callback return: unknown |
| add_option_update_handler($option_group, $option_name, $sanitize_callback = '') X-Ref |
| {@internal Missing Short Description}} param: unknown_type $option_group param: unknown_type $option_name param: unknown_type $sanitize_callback |
| remove_option_update_handler($option_group, $option_name, $sanitize_callback = '') X-Ref |
| {@internal Missing Short Description}} param: unknown_type $option_group param: unknown_type $option_name param: unknown_type $sanitize_callback |
| option_update_filter( $options ) X-Ref |
| {@internal Missing Short Description}} param: unknown_type $options return: unknown |
| add_option_whitelist( $new_options, $options = '' ) X-Ref |
| {@internal Missing Short Description}} param: unknown_type $new_options param: unknown_type $options return: unknown |
| remove_option_whitelist( $del_options, $options = '' ) X-Ref |
| {@internal Missing Short Description}} param: unknown_type $del_options param: unknown_type $options return: unknown |
| settings_fields($option_group) X-Ref |
| Output nonce, action, and option_page fields for a settings page. param: string $option_group A settings group name. This should match the group name used in register_setting(). |
| Generated: Fri Jan 8 00:19:48 2010 | Cross-referenced by PHPXref 0.7 |