base || 'themes' == $screen->base ) ) {
return;
}
// Return early if the theme as not declared any plugin enhancements.
if ( ! $this->theme_has_enhancements() ) {
return;
}
// Get the plugin enhancements information declared by the theme.
$this->plugins = $this->get_theme_plugin_enhancements();
// Return if no plugin enhancements have been declared by the theme.
if ( ! $this->plugins ) {
return;
}
/* Set the status of each of these enhancements and determine if a
* notice is needed.
*/
$this->set_plugin_status();
// Output the corresponding notices in the admin.
if ( $this->display_notice && current_user_can( 'install_plugins' ) ) {
add_action( 'admin_notices', array( $this, 'admin_notices' ) );
}
}
/**
* Checks whether the theme has declared any plugin enhancements.
*/
function theme_has_enhancements() {
return current_theme_supports( 'theme-plugin-enhancements' );
}
/**
* Returns the plugin enhancements declared by the theme.
*/
function get_theme_plugin_enhancements() {
$enhancements = get_theme_support( 'theme-plugin-enhancements' );
if ( ! is_array( $enhancements ) ) {
return false;
} else {
return $enhancements[0];
}
}
/**
* Determine the status of each of the plugins declared as a dependency
* by the theme and whether an admin notice is needed or not.
*/
function set_plugin_status() {
// Get the names of the installed plugins.
$installed_plugin_names = wp_list_pluck( get_plugins(), 'Name' );
foreach ( $this->plugins as $key => $plugin ) {
// Determine whether a plugin is installed.
if ( in_array( $plugin['name'], $installed_plugin_names ) ) {
/* Determine whether the plugin is active. If yes, remove if from
* the array containing the plugin enhancements.
*/
if ( is_plugin_active( array_search( $plugin['name'], $installed_plugin_names ) ) ) {
unset( $this->plugins[$key] );
}
// Set the plugin status as to-activate.
else {
$this->plugins[$key]['status'] = 'to-activate';
$this->display_notice = true;
}
// Set the plugin status as to-install.
} else {
$this->plugins[$key]['status'] = 'to-install';
$this->display_notice = true;
}
}
}
/**
* Display the admin notice for the plugin enhancements.
*/
function admin_notices() {
$notice = '';
// Loop through the plugins and print the message and the download or active links.
foreach( $this->plugins as $key => $plugin ) {
$notice .= '';
// Custom message provided by the theme.
if ( isset( $plugin['message'] ) ) {
$notice .= esc_html( $plugin['message'] );
}
// Activation message
if ( 'to-activate' == $plugin['status'] ) {
$activate_url = $this->plugin_activate_url( $plugin['slug'] );
$notice .= sprintf(
__( ' Please activate %1$s. %2$s', 'canard' ),
esc_html( $plugin['name'] ),
( $activate_url ) ? '' . __( 'Activate', 'canard' ) . '' : ''
);
}
// Download message
if ( 'to-install' == $plugin['status'] ) {
$install_url = $this->plugin_install_url( $plugin['slug'] );
$notice .= sprintf(
__( ' Please install %1$s. %2$s', 'canard' ),
esc_html( $plugin['name'] ),
( $install_url ) ? '' . __( 'Install', 'canard' ) . '' : ''
);
}
$notice .= '
';
}
// Output notice HTML.
printf(
'%s
',
$notice
);
}
/**
* Helper function to return the URL for activating a plugin.
*
* Uses the plugin slug to determine what plugin to activate.
*/
function plugin_activate_url( $slug ) {
// Find the path to the plugin.
$plugin_paths = array_keys( get_plugins() );
$plugin_path = false;
foreach ( $plugin_paths as $path ) {
if ( preg_match( '|^' . $slug .'|', $path ) ) {
$plugin_path = $path;
}
}
if ( ! $plugin_path ) {
return false;
} else {
return wp_nonce_url(
self_admin_url( 'plugins.php?action=activate&plugin=' . $plugin_path ),
'activate-plugin_' . $plugin_path
);
}
}
/**
* Helper function to return the URL for installing a plugin.
*
* Uses the plugin slug to determine what plugin to install.
*/
function plugin_install_url( $slug ) {
/* Include Plugin Install Administration API to get access to the
* plugins_api() function
*/
include_once ABSPATH . 'wp-admin/includes/plugin-install.php';
$plugin_information = plugins_api( 'plugin_information', array( 'slug' => $slug ) );
if ( is_wp_error( $plugin_information ) ) {
return false;
} else {
return wp_nonce_url(
self_admin_url( 'update.php?action=install-plugin&plugin=' . $slug ),
'install-plugin_' . $slug
);
}
}
}
add_action( 'admin_head', array( 'Theme_Plugin_Enhancements', 'init' ) );