- Contributors: Andy Fragen, Matt Gibbs, Raruto, contributors
- Tags: plugin, dependency, install
- Requires at least: 5.1
- Requires PHP: 5.6
- Stable tag: master
- Donate link: https://thefragens.com/wp-dependency-installer-donate
- License: MIT
This is a drop in class for developers to optionally or automatically install plugin dependencies for their own plugins or themes. It can install a plugin from wp.org, GitHub, Bitbucket, GitLab, Gitea, or a direct URL.
Comprehensive information regarding WP Dependency Installer is available on the wiki.
See also: example plugin.
You can use composer to install this package within your WordPress plugin / theme.
- Within your plugin or theme root folder, run the following command:
composer require afragen/wp-dependency-installer- Then create a sample
wp-dependencies.jsonfile
[
{
"name": "GitHub Updater",
"host": "github",
"slug": "github-updater/github-updater.php",
"uri": "afragen/github-updater",
"branch": "develop",
"required": true,
"token": null
},
{
"name": "Query Monitor",
"host": "wordpress",
"slug": "query-monitor/query-monitor.php",
"uri": "https://wordpress.org/plugins/query-monitor/",
"optional": true
},
{
"name": "Local Development",
"host": "WordPress",
"slug": "local-development/local-development.php",
"uri": "https://wordpress.org/plugins/local-development/",
"required": true
}
]You will then need to update wp-dependencies.json to suit your requirements.
- Finally add the following lines to your plugin or theme's
functions.phpfile:
require_once __DIR__ . '/vendor/autoload.php';
WP_Dependency_Installer::instance( __DIR__ )->run();
// Needed in theme's functions.php file.
add_filter( 'pand_theme_loader', '__return_true' );- (optional) Take a look at some of built in Hooks and Functions to further customize your plugin look and behaviour:
/**
* Display your plugin or theme name in dismissable notices.
*/
add_filter(
'wp_dependency_dismiss_label',
function( $label, $source ) {
$label = basename( __DIR__ ) !== $source ? $label : __( 'Group Plugin Installer', 'group-plugin-installer' );
return $label;
}, 10, 2
);- Sanity Check
// Sanity check for WPDI v3.0.0.
if ( ! method_exists( 'WP_Dependency_Installer', 'json_file_decode' ) ) {
add_action(
'admin_notices',
function() {
$class = 'notice notice-error is-dismissible';
$label = __( 'Your Plugin Name', 'your-plugin' );
$file = ( new ReflectionClass( 'WP_Dependency_Installer' ) )->getFilename();
$message = __( 'Another theme or plugin is using a previous version of the WP Dependency Installer library, please update this file and try again:', 'group-plugin-installer' );
printf( '<div class="%1$s"><p><strong>[%2$s]</strong> %3$s</p><pre>%4$s</pre></div>', esc_attr( $class ), esc_html( $label ), esc_html( $message ), esc_html( $file ) );
},
1
);
return false; // Exit early.
}That's it, happy blogging!
PRs are welcome against the develop branch.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent