wporg-mu-plugins

Over time, this is intended to become the canonical source repository for all mu-plugins on the WordPress.org network. At the moment, it only includes a few.

Usage

1. Add entries to the repositories and require-dev sections of composer.json. See wporg-news-2021 composer.json as an example.
2. Run composer update to install it
3. require_once the files that you want. e.g.,

   require_once WPMU_PLUGIN_DIR . '/wporg-mu-plugins/mu-plugins/blocks/global-header-footer/blocks.php';

4. See individual plugin readmes for specific instructions

Development

Use Node.js 24 (nvm use) and run npm run setup:tools to install dependencies.

• npm run start during development, only builds style.css
• npm run build before commit/sync/deploy, builds style.css and style-rtl.css.

PHP coding standards

Run composer install to install the lint tools. composer run lint reports PHP coding-standard errors and warnings and checks compatibility with PHP 8.4 and later.

CI runs the full PHP scan on pull requests and before building trunk. PHP errors and warnings fail the build. The host tooling runs on PHP 8.4; WordPress unit tests remain on PHP 8.2.

The tracked PHPCS configuration extends the wporg standard supplied by wporg/wporg-repo-tools, with this repository's text domain and direct-database-query exclusion. The shared standard supplies the PHP 8.4 compatibility target. Alpha allowances are limited to the three PHPCompatibility packages, without lowering the project's global Composer stability setting.

ESLint, Stylelint, and Prettier also use tracked wrappers around the shared configurations. ESLint uses the flat configuration supported by @wordpress/scripts 35. Stylelint uses the CSS preset for the PostCSS sources, preserving the existing line-length and duplicate-selector exceptions. The tracked .stylelintrc points to stylelint.config.js for both CLI and editor discovery. npm run setup:tools installs dependencies and npm run update:tools updates Composer dependencies without regenerating configuration files. Treat update-configs as an explicit configuration migration.

Sync/Deploy

The built here are synced to dotorg.svn so they can be deployed. The aren't synced to meta.svn, since they're already open.

The other mu-plugins in meta.svn are not synced here. Over time, they can be removed from meta.svn and added here.

To sync these to dotorg.svn, run bin/sync/wporg-mu-plugins.sh on a w.org sandbox. Once they're committed, you can deploy like normal.