WP Static Menus Plugin

WordPress plugin for caching menus and serving them statically. Based upon WP Static Menus by LiquidWeb. It requires the WP Fragment Cache plugin to run.

This plugin caches menus by menu Theme Location (the ones registered in the theme), not the individual user-created nav venus.

It also uses HTML files located in wp-content/wp-static-menus/ to store each menu's markup.

Installation

Upload the plugin, then from within its directory run composer install. Then activate the plugin as you would any other from within the WP Admin.

Usage

Navigate to Tools > WP Static Menus in the WP Admin Menu. Then select the menu location(s) to be cached.

From here, the plugin can get to work with no other required changes to the configuration.

On this same settings page you can also select to whom static menus should not be served (e.g., logged-in users, Adminstrators & Editors). This is useful if your menus appear differently for different users (like containing a user profile link, for example). Also, disabling cached menus for Admins allows them to see edits immediately.

The Tools section includes a checkbox to quickly disable all caching, as well as a button to empty all caches.

Finally, the plugin can display a handy button in the WP Admin Bar for flushing the cache files.

Development

Unit Testing

For the sake of simplicity, this plugin does not use the full WP Plugin Integration Tests suite of tools. When composer install is initially run, a standalone version of PHPUnit is added to the plugin.

To run the unit tests, simply run composer test from inside the plugin's directory and PHPUnit will go to work.

Coding Standards

PHP Coding Standards (phpcs) and PHP Code Beautifier and Fixer (phpcbf) are also installed. To run these, use composer lint and composer fix respectively. This automatically includes WordPress Coding Standards and Mindsize's custom standards file (phpcs.xml.dist).