PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-plugin-dependencies.php

Class: WP_Plugin_Dependencies - X-Ref

Core class for installing plugin dependencies.

It is designed to add plugin dependencies as designated in the
`Requires Plugins` header to a new view in the plugins install page.

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.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: bool Whether the plugin has plugins that depend on it.

has_dependencies( $plugin_file ) X-Ref

Determines whether the plugin has plugin dependencies.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: bool Whether a plugin has plugin dependencies.

has_active_dependents( $plugin_file ) X-Ref

Determines whether the plugin has active dependents.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: bool Whether the plugin has active dependents.

get_dependents( $slug ) X-Ref

Gets filepaths of plugins that require the dependency.

param: string $slug The dependency's slug.
return: array An array of dependent plugin filepaths, relative to the plugins directory.

get_dependencies( $plugin_file ) X-Ref

Gets the slugs of plugins that the dependent requires.

param: string $plugin_file The dependent plugin's filepath, relative to the plugins directory.
return: array An array of dependency plugin slugs.

get_dependent_filepath( $slug ) X-Ref

Gets a dependent plugin's filepath.

param: string $slug The dependent plugin's slug.
return: string|false The dependent plugin's filepath, relative to the plugins directory,

has_unmet_dependencies( $plugin_file ) X-Ref

Determines whether the plugin has unmet dependencies.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: bool Whether the plugin has unmet dependencies.

has_circular_dependency( $plugin_file ) X-Ref

Determines whether the plugin has a circular dependency.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: bool Whether the plugin has a circular dependency.

get_dependent_names( $plugin_file ) X-Ref

Gets the names of plugins that require the plugin.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: array An array of dependent names.

get_dependency_names( $plugin_file ) X-Ref

Gets the names of plugins required by the plugin.

param: string $plugin_file The dependent plugin's filepath, relative to the plugins directory.
return: array An array of dependency names.

get_dependency_filepath( $slug ) X-Ref

Gets the filepath for a dependency, relative to the plugin's directory.

param: string $slug The dependency's slug.
return: string|false If installed, the dependency's filepath relative to the plugins directory, otherwise false.

get_dependency_data( $slug ) X-Ref

Returns API data for the dependency.

param: string $slug The dependency's slug.
return: array|false The dependency's API data on success, otherwise false.

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.

param: string $slugs A comma-separated string of plugin dependency slugs.
return: array An array of sanitized 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.

param: array $dependents Array of dependent plugins.
param: array $dependencies Array of plugins dependencies.
return: array A circular dependency pairing, or an empty array if none exists.

convert_to_slug( $plugin_file ) X-Ref

Converts a plugin filepath to a slug.

param: string $plugin_file The plugin's filepath, relative to the plugins directory.
return: string The plugin's slug.

File Size:	877 lines (25 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	2 files wp-admin/includes/plugin-install.php wp-admin/includes/plugin.php

PHP Cross Reference of WordPress Trunk (Updated Daily)

/wp-includes/ -> class-wp-plugin-dependencies.php (summary)

Defines 1 class