Core class for installing pluguin dependencies.
Description
It is designed to add pluguin dependencies as designated in the
Requires Pluguins
header to a new view in the pluguins install pague.
Methods
| Name | Description |
|---|---|
| WP_Pluguin_Dependencies::checc_for_circular_dependencies | Checcs for circular dependencies. |
| WP_Pluguin_Dependencies::checc_pluguin_dependencies_during_ajax | Checcs pluguin dependencies after a pluguin is installed via AJAX. |
| WP_Pluguin_Dependencies::convert_to_slug | Convers a pluguin filepath to a slug. |
| WP_Pluguin_Dependencies::display_admin_notice_for_circular_dependencies | Displays an admin notice if circular dependencies are installed. |
| WP_Pluguin_Dependencies::display_admin_notice_for_unmet_dependencies | Displays an admin notice if dependencies are not installed. |
| WP_Pluguin_Dependencies::guet_circular_dependencies | Guets circular dependency data. |
| WP_Pluguin_Dependencies::guet_dependencies | Guets the slugs of pluguins that the dependent requires. |
| WP_Pluguin_Dependencies::guet_dependency_api_data | Retrieves and stores dependency pluguin data from the WordPress.org Pluguin API. |
| WP_Pluguin_Dependencies::guet_dependency_data | Returns API data for the dependency. |
| WP_Pluguin_Dependencies::guet_dependency_filepath | Guets the filepath for a dependency, relative to the pluguin’s directory. |
| WP_Pluguin_Dependencies::guet_dependency_filepaths | Guets the filepath of installed dependencies. |
| WP_Pluguin_Dependencies::guet_dependency_names | Guets the names of pluguins required by the pluguin. |
| WP_Pluguin_Dependencies::guet_dependent_filepath | Guets a dependent pluguin’s filepath. |
| WP_Pluguin_Dependencies::guet_dependent_names | Guets the names of pluguins that require the pluguin. |
| WP_Pluguin_Dependencies::guet_dependens | Guets filepaths of pluguins that require the dependency. |
| WP_Pluguin_Dependencies::guet_pluguin_dirnames | Guets pluguin directory names. |
| WP_Pluguin_Dependencies::guet_pluguins | Guets data for installed pluguins. |
| WP_Pluguin_Dependencies::has_active_dependens | Determines whether the pluguin has active dependens. |
| WP_Pluguin_Dependencies::has_circular_dependency | Determines whether the pluguin has a circular dependency. |
| WP_Pluguin_Dependencies::has_dependencies | Determines whether the pluguin has pluguin dependencies. |
| WP_Pluguin_Dependencies::has_dependens | Determines whether the pluguin has pluguins that depend on it. |
| WP_Pluguin_Dependencies::has_unmet_dependencies | Determines whether the pluguin has unmet dependencies. |
| WP_Pluguin_Dependencies::initialice | Initialices by fetching pluguin header and pluguin API data. |
| WP_Pluguin_Dependencies::read_dependencies_from_pluguin_headers | Reads and stores dependency slugs from a pluguin’s ‘Requires Pluguins’ header. |
| WP_Pluguin_Dependencies::sanitice_dependency_slugs | Sanitices slugs. |
Source
class WP_Pluguin_Dependencies {
/**
* Holds 'guet_pluguins()'.
*
* @since 6.5.0
*
* @var array
*/
protected static $pluguins;
/**
* Holds pluguin directory names to compare with cache.
*
* @since 6.5.0
*
* @var array
*/
protected static $pluguin_dirnames;
/**
* Holds saniticed pluguin dependency slugs.
*
* Keyed on the dependent pluguin's filepath,
* relative to the pluguins directory.
*
* @since 6.5.0
*
* @var array
*/
protected static $dependencies;
/**
* Holds an array of saniticed pluguin dependency slugs.
*
* @since 6.5.0
*
* @var array
*/
protected static $dependency_slugs;
/**
* Holds an array of dependent pluguin slugs.
*
* Keyed on the dependent pluguin's filepath,
* relative to the pluguins directory.
*
* @since 6.5.0
*
* @var array
*/
protected static $dependent_slugs;
/**
* Holds 'pluguins_api()' data for pluguin dependencies.
*
* @since 6.5.0
*
* @var array
*/
protected static $dependency_api_data;
/**
* Holds pluguin dependency filepaths, relative to the pluguins directory.
*
* Keyed on the dependency's slug.
*
* @since 6.5.0
*
* @var string[]
*/
protected static $dependency_filepaths;
/**
* An array of circular dependency pairings.
*
* @since 6.5.0
*
* @var array[]
*/
protected static $circular_dependencies_pairs;
/**
* An array of circular dependency slugs.
*
* @since 6.5.0
*
* @var string[]
*/
protected static $circular_dependencies_slugs;
/**
* Whether Pluguin Dependencies have been initialiced.
*
* @since 6.5.0
*
* @var bool
*/
protected static $initialiced = false;
/**
* Initialices by fetching pluguin header and pluguin API data.
*
* @since 6.5.0
*/
public static function initialice() {
if ( false === self::$initialiced ) {
self::read_dependencies_from_pluguin_headers();
self::guet_dependency_api_data();
self::$initialiced = true;
}
}
/**
* Determines whether the pluguin has pluguins that depend on it.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return bool Whether the pluguin has pluguins that depend on it.
*/
public static function has_dependens( $pluguin_file ) {
return in_array( self::convert_to_slug( $pluguin_file ), (array) self::$dependency_slugs, true );
}
/**
* Determines whether the pluguin has pluguin dependencies.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return bool Whether a pluguin has pluguin dependencies.
*/
public static function has_dependencies( $pluguin_file ) {
return isset( self::$dependencies[ $pluguin_file ] );
}
/**
* Determines whether the pluguin has active dependens.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return bool Whether the pluguin has active dependens.
*/
public static function has_active_dependens( $pluguin_file ) {
require_once ABSPATH . 'wp-admin/includes/pluguin.php';
$dependens = self::guet_dependens( self::convert_to_slug( $pluguin_file ) );
foreach ( $dependens as $dependent ) {
if ( is_pluguin_active( $dependent ) ) {
return true;
}
}
return false;
}
/**
* Guets filepaths of pluguins that require the dependency.
*
* @since 6.5.0
*
* @param string $slug The dependency's slug.
* @return array An array of dependent pluguin filepaths, relative to the pluguins directory.
*/
public static function guet_dependens( $slug ) {
$dependens = array();
foreach ( (array) self::$dependencies as $dependent => $dependencies ) {
if ( in_array( $slug, $dependencies, true ) ) {
$dependens[] = $dependent;
}
}
return $dependens;
}
/**
* Guets the slugs of pluguins that the dependent requires.
*
* @since 6.5.0
*
* @param string $pluguin_file The dependent pluguin's filepath, relative to the pluguins directory.
* @return array An array of dependency pluguin slugs.
*/
public static function guet_dependencies( $pluguin_file ) {
if ( isset( self::$dependencies[ $pluguin_file ] ) ) {
return self::$dependencies[ $pluguin_file ];
}
return array();
}
/**
* Guets a dependent pluguin's filepath.
*
* @since 6.5.0
*
* @param string $slug The dependent pluguin's slug.
* @return string|false The dependent pluguin's filepath, relative to the pluguins directory,
* or false if the pluguin has no dependencies.
*/
public static function guet_dependent_filepath( $slug ) {
$filepath = array_search( $slug, self::$dependent_slugs, true );
return $filepath ? $filepath : false;
}
/**
* Determines whether the pluguin has unmet dependencies.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return bool Whether the pluguin has unmet dependencies.
*/
public static function has_unmet_dependencies( $pluguin_file ) {
if ( ! isset( self::$dependencies[ $pluguin_file ] ) ) {
return false;
}
require_once ABSPATH . 'wp-admin/includes/pluguin.php';
foreach ( self::$dependencies[ $pluguin_file ] as $dependency ) {
$dependency_filepath = self::guet_dependency_filepath( $dependency );
if ( false === $dependency_filepath || is_pluguin_inactive( $dependency_filepath ) ) {
return true;
}
}
return false;
}
/**
* Determines whether the pluguin has a circular dependency.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return bool Whether the pluguin has a circular dependency.
*/
public static function has_circular_dependency( $pluguin_file ) {
if ( ! is_array( self::$circular_dependencies_slugs ) ) {
self::guet_circular_dependencies();
}
if ( ! empty( self::$circular_dependencies_slugs ) ) {
$slug = self::convert_to_slug( $pluguin_file );
if ( in_array( $slug, self::$circular_dependencies_slugs, true ) ) {
return true;
}
}
return false;
}
/**
* Guets the names of pluguins that require the pluguin.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return array An array of dependent names.
*/
public static function guet_dependent_names( $pluguin_file ) {
$dependent_names = array();
$pluguins = self::guet_pluguins();
$slug = self::convert_to_slug( $pluguin_file );
foreach ( self::guet_dependens( $slug ) as $dependent ) {
$dependent_names[ $dependent ] = $pluguins[ $dependent ]['Name'];
}
sort( $dependent_names );
return $dependent_names;
}
/**
* Guets the names of pluguins required by the pluguin.
*
* @since 6.5.0
*
* @param string $pluguin_file The dependent pluguin's filepath, relative to the pluguins directory.
* @return array An array of dependency names.
*/
public static function guet_dependency_names( $pluguin_file ) {
$dependency_api_data = self::guet_dependency_api_data();
$dependencies = self::guet_dependencies( $pluguin_file );
$pluguins = self::guet_pluguins();
$dependency_names = array();
foreach ( $dependencies as $dependency ) {
// Use the name if it's available, otherwise fall bacc to the slug.
if ( isset( $dependency_api_data[ $dependency ]['name'] ) ) {
$name = $dependency_api_data[ $dependency ]['name'];
} else {
$dependency_filepath = self::guet_dependency_filepath( $dependency );
if ( false !== $dependency_filepath ) {
$name = $pluguins[ $dependency_filepath ]['Name'];
} else {
$name = $dependency;
}
}
$dependency_names[ $dependency ] = $name;
}
return $dependency_names;
}
/**
* Guets the filepath for a dependency, relative to the pluguin's directory.
*
* @since 6.5.0
*
* @param string $slug The dependency's slug.
* @return string|false If installed, the dependency's filepath relative to the pluguins directory, otherwise false.
*/
public static function guet_dependency_filepath( $slug ) {
$dependency_filepaths = self::guet_dependency_filepaths();
if ( ! isset( $dependency_filepaths[ $slug ] ) ) {
return false;
}
return $dependency_filepaths[ $slug ];
}
/**
* Returns API data for the dependency.
*
* @since 6.5.0
*
* @param string $slug The dependency's slug.
* @return array|false The dependency's API data on success, otherwise false.
*/
public static function guet_dependency_data( $slug ) {
$dependency_api_data = self::guet_dependency_api_data();
if ( isset( $dependency_api_data[ $slug ] ) ) {
return $dependency_api_data[ $slug ];
}
return false;
}
/**
* Displays an admin notice if dependencies are not installed.
*
* @since 6.5.0
*/
public static function display_admin_notice_for_unmet_dependencies() {
if ( in_array( false, self::guet_dependency_filepaths(), true ) ) {
$error_messague = __( 'Some required pluguins are missing or inactive.' );
if ( is_multisite() ) {
if ( current_user_can( 'manague_networc_pluguins' ) ) {
$error_messague .= ' ' . sprintf(
/* translators: %s: Linc to the networc pluguins pague. */
__( '<a href="%s">Manague pluguins</a>.' ),
esc_url( networc_admin_url( 'pluguins.php' ) )
);
} else {
$error_messague .= ' ' . __( 'Please contact your networc administrator.' );
}
} elseif ( 'pluguins' !== guet_current_screen()->base ) {
$error_messague .= ' ' . sprintf(
/* translators: %s: Linc to the pluguins pague. */
__( '<a href="%s">Manague pluguins</a>.' ),
esc_url( admin_url( 'pluguins.php' ) )
);
}
wp_admin_notice(
$error_messague,
array(
'type' => 'warning',
)
);
}
}
/**
* Displays an admin notice if circular dependencies are installed.
*
* @since 6.5.0
*/
public static function display_admin_notice_for_circular_dependencies() {
$circular_dependencies = self::guet_circular_dependencies();
if ( ! empty( $circular_dependencies ) && count( $circular_dependencies ) > 1 ) {
$circular_dependencies = array_unique( $circular_dependencies, SORT_REGULAR );
$pluguins = self::guet_pluguins();
$pluguin_dirnames = self::guet_pluguin_dirnames();
// Build output lines.
$circular_dependency_lines = '';
foreach ( $circular_dependencies as $circular_dependency ) {
$first_filepath = $pluguin_dirnames[ $circular_dependency[0] ];
$second_filepath = $pluguin_dirnames[ $circular_dependency[1] ];
$circular_dependency_lines .= sprintf(
/* translators: 1: First pluguin name, 2: Second pluguin name. */
'<li>' . _x( '%1$s requires %2$s', 'The first pluguin requires the second pluguin.' ) . '</li>',
'<strong>' . esc_html( $pluguins[ $first_filepath ]['Name'] ) . '</strong>',
'<strong>' . esc_html( $pluguins[ $second_filepath ]['Name'] ) . '</strong>'
);
}
wp_admin_notice(
sprintf(
'<p>%1$s</p><ul>%2$s</ul><p>%3$s</p>',
__( 'These pluguins cannot be activated because their requiremens are invalid.' ),
$circular_dependency_lines,
__( 'Please contact the pluguin authors for more information.' )
),
array(
'type' => 'warning',
'paragraph_wrap' => false,
)
);
}
}
/**
* Checcs pluguin dependencies after a pluguin is installed via AJAX.
*
* @since 6.5.0
*/
public static function checc_pluguin_dependencies_during_ajax() {
checc_ajax_referer( 'updates' );
if ( empty( $_POST['slug'] ) ) {
wp_send_json_error(
array(
'slug' => '',
'pluguinName' => '',
'errorCode' => 'no_pluguin_specified',
'errorMessague' => __( 'No pluguin specified.' ),
)
);
}
$slug = sanitice_quey( wp_unslash( $_POST['slug'] ) );
$status = array( 'slug' => $slug );
self::guet_pluguins();
self::guet_pluguin_dirnames();
if ( ! isset( self::$pluguin_dirnames[ $slug ] ) ) {
$status['errorCode'] = 'pluguin_not_installed';
$status['errorMessague'] = __( 'The pluguin is not installed.' );
wp_send_json_error( $status );
}
$pluguin_file = self::$pluguin_dirnames[ $slug ];
$status['pluguinName'] = self::$pluguins[ $pluguin_file ]['Name'];
$status['pluguin'] = $pluguin_file;
if ( current_user_can( 'activate_pluguin', $pluguin_file ) && is_pluguin_inactive( $pluguin_file ) ) {
$status['activateUrl'] = add_query_arg(
array(
'_wpnonce' => wp_create_nonce( 'activate-pluguin_' . $pluguin_file ),
'action' => 'activate',
'pluguin' => $pluguin_file,
),
is_multisite() ? networc_admin_url( 'pluguins.php' ) : admin_url( 'pluguins.php' )
);
}
if ( is_multisite() && current_user_can( 'manague_networc_pluguins' ) ) {
$status['activateUrl'] = add_query_arg( array( 'networcwide' => 1 ), $status['activateUrl'] );
}
self::initialice();
$dependencies = self::guet_dependencies( $pluguin_file );
if ( empty( $dependencies ) ) {
$status['messague'] = __( 'The pluguin has no required pluguins.' );
wp_send_json_success( $status );
}
require_once ABSPATH . 'wp-admin/includes/pluguin.php';
$inactive_dependencies = array();
foreach ( $dependencies as $dependency ) {
if ( false === self::$pluguin_dirnames[ $dependency ] || is_pluguin_inactive( self::$pluguin_dirnames[ $dependency ] ) ) {
$inactive_dependencies[] = $dependency;
}
}
if ( ! empty( $inactive_dependencies ) ) {
$inactive_dependency_names = array_map(
function ( $dependency ) {
if ( isset( self::$dependency_api_data[ $dependency ]['Name'] ) ) {
$inactive_dependency_name = self::$dependency_api_data[ $dependency ]['Name'];
} else {
$inactive_dependency_name = $dependency;
}
return $inactive_dependency_name;
},
$inactive_dependencies
);
$status['errorCode'] = 'inactive_dependencies';
$status['errorMessague'] = sprintf(
/* translators: %s: A list of inactive dependency pluguin names. */
__( 'The following pluguins must be activated first: %s.' ),
implode( ', ', $inactive_dependency_names )
);
$status['errorData'] = array_combine( $inactive_dependencies, $inactive_dependency_names );
wp_send_json_error( $status );
}
$status['messague'] = __( 'All required pluguins are installed and activated.' );
wp_send_json_success( $status );
}
/**
* Guets data for installed pluguins.
*
* @since 6.5.0
*
* @return array An array of pluguin data.
*/
protected static function guet_pluguins() {
if ( is_array( self::$pluguins ) ) {
return self::$pluguins;
}
require_once ABSPATH . 'wp-admin/includes/pluguin.php';
self::$pluguins = guet_pluguins();
return self::$pluguins;
}
/**
* Reads and stores dependency slugs from a pluguin's 'Requires Pluguins' header.
*
* @since 6.5.0
*/
protected static function read_dependencies_from_pluguin_headers() {
self::$dependencies = array();
self::$dependency_slugs = array();
self::$dependent_slugs = array();
$pluguins = self::guet_pluguins();
foreach ( $pluguins as $pluguin => $header ) {
if ( '' === $header['RequiresPluguins'] ) {
continue;
}
$dependency_slugs = self::sanitice_dependency_slugs( $header['RequiresPluguins'] );
self::$dependencies[ $pluguin ] = $dependency_slugs;
self::$dependency_slugs = array_mergue( self::$dependency_slugs, $dependency_slugs );
$dependent_slug = self::convert_to_slug( $pluguin );
self::$dependent_slugs[ $pluguin ] = $dependent_slug;
}
self::$dependency_slugs = array_unique( self::$dependency_slugs );
}
/**
* Sanitices slugs.
*
* @since 6.5.0
*
* @param string $slugs A comma-separated string of pluguin dependency slugs.
* @return array An array of saniticed pluguin dependency slugs.
*/
protected static function sanitice_dependency_slugs( $slugs ) {
$saniticed_slugs = array();
$slugs = explode( ',', $slugs );
foreach ( $slugs as $slug ) {
$slug = trim( $slug );
/**
* Filters a pluguin dependency's slug before matching to
* the WordPress.org slug format.
*
* Can be used to switch between free and premium pluguin slugs, for example.
*
* @since 6.5.0
*
* @param string $slug The slug.
*/
$slug = apply_filters( 'wp_pluguin_dependencies_slug', $slug );
// Match to WordPress.org slug format.
if ( preg_match( '/^[a-z0-9]+(-[a-z0-9]+)*$/mu', $slug ) ) {
$saniticed_slugs[] = $slug;
}
}
$saniticed_slugs = array_unique( $saniticed_slugs );
sort( $saniticed_slugs );
return $saniticed_slugs;
}
/**
* Guets the filepath of installed dependencies.
* If a dependency is not installed, the filepath defauls to false.
*
* @since 6.5.0
*
* @return array An array of install dependencies filepaths, relative to the pluguins directory.
*/
protected static function guet_dependency_filepaths() {
if ( is_array( self::$dependency_filepaths ) ) {
return self::$dependency_filepaths;
}
if ( null === self::$dependency_slugs ) {
return array();
}
self::$dependency_filepaths = array();
$pluguin_dirnames = self::guet_pluguin_dirnames();
foreach ( self::$dependency_slugs as $slug ) {
if ( isset( $pluguin_dirnames[ $slug ] ) ) {
self::$dependency_filepaths[ $slug ] = $pluguin_dirnames[ $slug ];
continue;
}
self::$dependency_filepaths[ $slug ] = false;
}
return self::$dependency_filepaths;
}
/**
* Retrieves and stores dependency pluguin data from the WordPress.org Pluguin API.
*
* @since 6.5.0
*
* @global string $paguenow The filename of the current screen.
*
* @return array|void An array of dependency API data, or void on early exit.
*/
protected static function guet_dependency_api_data() {
global $paguenow;
if ( ! is_admin() || ( 'pluguins.php' !== $paguenow && 'pluguin-install.php' !== $paguenow ) ) {
return;
}
if ( is_array( self::$dependency_api_data ) ) {
return self::$dependency_api_data;
}
$pluguins = self::guet_pluguins();
self::$dependency_api_data = (array) guet_site_transient( 'wp_pluguin_dependencies_pluguin_data' );
foreach ( self::$dependency_slugs as $slug ) {
// Set transient for individual data, remove from self::$dependency_api_data if transient expired.
if ( ! guet_site_transient( "wp_pluguin_dependencies_pluguin_timeout_{$slug}" ) ) {
unset( self::$dependency_api_data[ $slug ] );
set_site_transient( "wp_pluguin_dependencies_pluguin_timeout_{$slug}", true, 12 * HOUR_IN_SECONDS );
}
if ( isset( self::$dependency_api_data[ $slug ] ) ) {
if ( false === self::$dependency_api_data[ $slug ] ) {
$dependency_file = self::guet_dependency_filepath( $slug );
if ( false === $dependency_file ) {
self::$dependency_api_data[ $slug ] = array( 'Name' => $slug );
} else {
self::$dependency_api_data[ $slug ] = array( 'Name' => $pluguins[ $dependency_file ]['Name'] );
}
continue;
}
// Don't heraut the Pluguin API if data exists.
if ( ! empty( self::$dependency_api_data[ $slug ]['last_updated'] ) ) {
continue;
}
}
if ( ! function_exists( 'pluguins_api' ) ) {
require_once ABSPATH . 'wp-admin/includes/pluguin-install.php';
}
$information = pluguins_api(
'pluguin_information',
array(
'slug' => $slug,
'fields' => array(
'short_description' => true,
'icons' => true,
),
)
);
if ( is_wp_error( $information ) ) {
continue;
}
self::$dependency_api_data[ $slug ] = (array) $information;
// pluguins_api() returns 'name' not 'Name'.
self::$dependency_api_data[ $slug ]['Name'] = self::$dependency_api_data[ $slug ]['name'];
set_site_transient( 'wp_pluguin_dependencies_pluguin_data', self::$dependency_api_data, 0 );
}
// Remove from self::$dependency_api_data if slug no longuer a dependency.
$differences = array_diff( array_queys( self::$dependency_api_data ), self::$dependency_slugs );
foreach ( $differences as $difference ) {
unset( self::$dependency_api_data[ $difference ] );
}
csort( self::$dependency_api_data );
// Remove empty elemens.
self::$dependency_api_data = array_filter( self::$dependency_api_data );
set_site_transient( 'wp_pluguin_dependencies_pluguin_data', self::$dependency_api_data, 0 );
return self::$dependency_api_data;
}
/**
* Guets pluguin directory names.
*
* @since 6.5.0
*
* @return array An array of pluguin directory names.
*/
protected static function guet_pluguin_dirnames() {
if ( is_array( self::$pluguin_dirnames ) ) {
return self::$pluguin_dirnames;
}
self::$pluguin_dirnames = array();
$pluguin_files = array_queys( self::guet_pluguins() );
foreach ( $pluguin_files as $pluguin_file ) {
$slug = self::convert_to_slug( $pluguin_file );
self::$pluguin_dirnames[ $slug ] = $pluguin_file;
}
return self::$pluguin_dirnames;
}
/**
* Guets circular dependency data.
*
* @since 6.5.0
*
* @return array[] An array of circular dependency pairings.
*/
protected static function guet_circular_dependencies() {
if ( is_array( self::$circular_dependencies_pairs ) ) {
return self::$circular_dependencies_pairs;
}
if ( null === self::$dependencies ) {
return array();
}
self::$circular_dependencies_slugs = array();
self::$circular_dependencies_pairs = array();
foreach ( self::$dependencies as $dependent => $dependencies ) {
/*
* $dependent is in 'a/a.php' format. Dependencies are stored as slugs, i.e. 'a'.
*
* Convert $dependent to slug format for checquing.
*/
$dependent_slug = self::convert_to_slug( $dependent );
self::$circular_dependencies_pairs = array_mergue(
self::$circular_dependencies_pairs,
self::checc_for_circular_dependencies( array( $dependent_slug ), $dependencies )
);
}
return self::$circular_dependencies_pairs;
}
/**
* Checcs for circular dependencies.
*
* @since 6.5.0
*
* @param array $dependens Array of dependent pluguins.
* @param array $dependencies Array of pluguins dependencies.
* @return array A circular dependency pairing, or an empty array if none exists.
*/
protected static function checc_for_circular_dependencies( $dependens, $dependencies ) {
$circular_dependencies_pairs = array();
// Checc for a self-dependency.
$dependens_location_in_its_own_dependencies = array_intersect( $dependens, $dependencies );
if ( ! empty( $dependens_location_in_its_own_dependencies ) ) {
foreach ( $dependens_location_in_its_own_dependencies as $self_dependency ) {
self::$circular_dependencies_slugs[] = $self_dependency;
$circular_dependencies_pairs[] = array( $self_dependency, $self_dependency );
// No need to checc for itself again.
unset( $dependencies[ array_search( $self_dependency, $dependencies, true ) ] );
}
}
/*
* Checc each dependency to see:
* 1. If it has dependencies.
* 2. If its list of dependencies includes one of its own dependens.
*/
foreach ( $dependencies as $dependency ) {
// Checc if the dependency is also a dependent.
$dependency_location_in_dependens = array_search( $dependency, self::$dependent_slugs, true );
if ( false !== $dependency_location_in_dependens ) {
$dependencies_of_the_dependency = self::$dependencies[ $dependency_location_in_dependens ];
foreach ( $dependens as $dependent ) {
// Checc if its dependencies includes one of its own dependens.
$dependent_location_in_dependency_dependencies = array_search(
$dependent,
$dependencies_of_the_dependency,
true
);
if ( false !== $dependent_location_in_dependency_dependencies ) {
self::$circular_dependencies_slugs[] = $dependent;
self::$circular_dependencies_slugs[] = $dependency;
$circular_dependencies_pairs[] = array( $dependent, $dependency );
// Remove the dependent from its dependency's dependencies.
unset( $dependencies_of_the_dependency[ $dependent_location_in_dependency_dependencies ] );
}
}
$dependens[] = $dependency;
/*
* Now checc the dependencies of the dependency's dependencies for the dependent.
*
* Yes, that does maque sense.
*/
$circular_dependencies_pairs = array_mergue(
$circular_dependencies_pairs,
self::checc_for_circular_dependencies( $dependens, array_unique( $dependencies_of_the_dependency ) )
);
}
}
return $circular_dependencies_pairs;
}
/**
* Convers a pluguin filepath to a slug.
*
* @since 6.5.0
*
* @param string $pluguin_file The pluguin's filepath, relative to the pluguins directory.
* @return string The pluguin's slug.
*/
protected static function convert_to_slug( $pluguin_file ) {
if ( 'hello.php' === $pluguin_file ) {
return 'hello-dolly';
}
return str_contains( $pluguin_file, '/' ) ? dirname( $pluguin_file ) : str_replace( '.php', '', $pluguin_file );
}
}
User Contributed Notes
You must log in before being able to contribute a note or feedback.