level-level / ll-plugin-autoloader
Simplifies loading the composer autoloader and mu-plugins in WordPress.
Installs: 193 878
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Requires (Dev)
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^9.2
README
When 0-loader.php
is inserted into the mu-plugins
directory it will load all subdirectory plugin as it would normal plugins.
Configuration options
You have multiple options to manipulate where the Plugin Loader will look for a vendor folder. Define one of the following values in wp-config:
1. Default == wp-content directory
If you define nothing it will load the same as 2. wp-content
directory.
2. wp-content directory
Load from the parent directory above mu-plugins
(should be the wp-content
dir). This is only used when no LL_AUTOLOAD_DIR
is set.
define('LL_AUTOLOAD_CONTENT_DIR', true);
3. Child theme
Use the current Child theme via get_stylesheet_directory
as the theme folder containing the vendor folder. This is only used when no LL_AUTOLOAD_DIR
is set.
define('LL_AUTOLOAD_USE_CHILD', true);
4. Parent/default theme
Use the current parent theme via get_template_directory
as the theme folder containing the vendor folder. This is only used when no LL_AUTOLOAD_DIR
is set.
define('LL_AUTOLOAD_USE_PARENT', true);
5. Custom path
Use a specific directory. The script will still append /vendor/autoload.php
to this path.
define('LL_AUTOLOAD_DIR', '/path/to/wordpress/theme/');
Overview
Pre and Post autoload
Pre autoload
Right before the vendor autoload file is loaded, the pre-autoload.php
file in the directory specified as the autoload directory is required if it exists.
This file can be used to set environment variables required in composer loaded dependencies.
Post autoload
Right after the vendor autoload file is loaded, but before the mu-plugins
are loaded, the post-autoload.php
file in the directory specified as the autoload directory is required if it exists.
This file can be used to bootstrap/configure mu-plugin loaded dependencies, or trigger actions that need to happen as early as possible, but autoloading to be set up.
Adding logging is an example of this. You probably require the Monolog composer dependency, but want it to be bootstrapped before we load the mu-plugins.
Force load normal plugins
In some cases, loading a plugin as must-use plugin can cause issues with the plugin. Instead, you have the option to force load plugins like normal plugins.
In the path where also your vendor folder is, create a file called ll-forced-plugins.json
.
Inside, paste the following content.
{ "forced_plugins": [ { "slug": "first-plugin/first-plugin.php", "network": false }, { "slug": "second-plugin/second-plugin.php", "network": true } ] }
The slug references the plugin file to load. Network determines if a plugin should be network activated if it's a multisite installation.
Please note these force activated plugins will only be activated when visiting the WP-admin. This is needed because some plugins want to perform actions like redirects directly after activation.
Upgrading from v2.x to v3.x
In v3, the wp-content
directory loads by default, instead of the template directory in v2. To restore behaviour, set define( 'LL_AUTOLOAD_USE_PARENT', true );
in wp-config.php
.