| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
WordPress Plugin Administration API: WP_Plugin_Dependencies class
| File Size: | 878 lines (25 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files wp-admin/includes/plugin.php wp-admin/includes/plugin-install.php |
WP_Plugin_Dependencies:: (25 methods):
initialize()
has_dependents()
has_dependencies()
has_active_dependents()
get_dependents()
get_dependencies()
get_dependent_filepath()
has_unmet_dependencies()
has_circular_dependency()
get_dependent_names()
get_dependency_names()
get_dependency_filepath()
get_dependency_data()
display_admin_notice_for_unmet_dependencies()
display_admin_notice_for_circular_dependencies()
check_plugin_dependencies_during_ajax()
get_plugins()
read_dependencies_from_plugin_headers()
sanitize_dependency_slugs()
get_dependency_filepaths()
get_dependency_api_data()
get_plugin_dirnames()
get_circular_dependencies()
check_for_circular_dependencies()
convert_to_slug()
Class: WP_Plugin_Dependencies - X-Ref
Core class for installing plugin dependencies.| initialize() X-Ref |
| Initializes by fetching plugin header and plugin API data. |
| has_dependents( $plugin_file ) X-Ref |
| Determines whether the plugin has plugins that depend on it. return: bool Whether the plugin has plugins that depend on it. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| has_dependencies( $plugin_file ) X-Ref |
| Determines whether the plugin has plugin dependencies. return: bool Whether a plugin has plugin dependencies. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| has_active_dependents( $plugin_file ) X-Ref |
| Determines whether the plugin has active dependents. return: bool Whether the plugin has active dependents. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| get_dependents( $slug ) X-Ref |
| Gets filepaths of plugins that require the dependency. return: array An array of dependent plugin filepaths, relative to the plugins directory. param: string $slug The dependency's slug. |
| get_dependencies( $plugin_file ) X-Ref |
| Gets the slugs of plugins that the dependent requires. return: array An array of dependency plugin slugs. param: string $plugin_file The dependent plugin's filepath, relative to the plugins directory. |
| get_dependent_filepath( $slug ) X-Ref |
| Gets a dependent plugin's filepath. return: string|false The dependent plugin's filepath, relative to the plugins directory, param: string $slug The dependent plugin's slug. |
| has_unmet_dependencies( $plugin_file ) X-Ref |
| Determines whether the plugin has unmet dependencies. return: bool Whether the plugin has unmet dependencies. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| has_circular_dependency( $plugin_file ) X-Ref |
| Determines whether the plugin has a circular dependency. return: bool Whether the plugin has a circular dependency. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| get_dependent_names( $plugin_file ) X-Ref |
| Gets the names of plugins that require the plugin. return: array An array of dependent names. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| get_dependency_names( $plugin_file ) X-Ref |
| Gets the names of plugins required by the plugin. return: array An array of dependency names. param: string $plugin_file The dependent plugin's filepath, relative to the plugins directory. |
| get_dependency_filepath( $slug ) X-Ref |
| Gets the filepath for a dependency, relative to the plugin's directory. return: string|false If installed, the dependency's filepath relative to the plugins directory, otherwise false. param: string $slug The dependency's slug. |
| get_dependency_data( $slug ) X-Ref |
| Returns API data for the dependency. return: array|false The dependency's API data on success, otherwise false. param: string $slug The dependency's slug. |
| display_admin_notice_for_unmet_dependencies() X-Ref |
| Displays an admin notice if dependencies are not installed. |
| display_admin_notice_for_circular_dependencies() X-Ref |
| Displays an admin notice if circular dependencies are installed. |
| check_plugin_dependencies_during_ajax() X-Ref |
| Checks plugin dependencies after a plugin is installed via AJAX. |
| get_plugins() X-Ref |
| No description |
| read_dependencies_from_plugin_headers() X-Ref |
| Reads and stores dependency slugs from a plugin's 'Requires Plugins' header. |
| sanitize_dependency_slugs( $slugs ) X-Ref |
| Sanitizes slugs. return: array An array of sanitized plugin dependency slugs. param: string $slugs A comma-separated string of plugin dependency slugs. |
| get_dependency_filepaths() X-Ref |
| Gets the filepath of installed dependencies. If a dependency is not installed, the filepath defaults to false. return: array An array of install dependencies filepaths, relative to the plugins directory. |
| get_dependency_api_data() X-Ref |
| Retrieves and stores dependency plugin data from the WordPress.org Plugin API. return: array|void An array of dependency API data, or void on early exit. |
| get_plugin_dirnames() X-Ref |
| Gets plugin directory names. return: array An array of plugin directory names. |
| get_circular_dependencies() X-Ref |
| Gets circular dependency data. return: array[] An array of circular dependency pairings. |
| check_for_circular_dependencies( $dependents, $dependencies ) X-Ref |
| Checks for circular dependencies. return: array A circular dependency pairing, or an empty array if none exists. param: array $dependents Array of dependent plugins. param: array $dependencies Array of plugins dependencies. |
| convert_to_slug( $plugin_file ) X-Ref |
| Converts a plugin filepath to a slug. return: string The plugin's slug. param: string $plugin_file The plugin's filepath, relative to the plugins directory. |
| Generated : Sat Dec 21 08:20:01 2024 | Cross-referenced by PHPXref |