Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/vapvarun/wp-cli-hook-docs/archive/refs/heads/main.zipNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
WP-CLI Comprehensive Documentation Generator
Description
The WP-CLI Comprehensive Documentation Generator is a powerful tool that allows developers to automatically generate detailed documentation for their WordPress plugins and themes. This plugin focuses on capturing key components such as hooks, filters, actions, shortcodes, custom post types, and more.
Features
- doaction Hooks: Extract and document all doaction hooks.
- applyfilters Hooks: Extract and document all applyfilters hooks.
- addaction Hooks: Extract and document all addaction hooks.
- Shortcodes: Document shortcodes, including their callback functions and attributes.
- Custom Post Types: Document custom post types and associated meta fields.
Installation
1. Upload the plugin files to the /wp-content/plugins/wp-cli-comprehensive-doc-gen directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Ensure WP-CLI is installed and available on your server.
Usage
Once the plugin is installed and activated, you can use the following WP-CLI commands to generate documentation:
Command: wp doc-gen generate
This command generates