⭐️ An API documentation generator for your WordPress actions and filters.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


WordPress HookDoc

Automate documentation of Actions and Filters in WordPress. This npm module needs the JSDoc3 module as dependency. It uses JSDoc3 as comment parser and generates a documentation with the power of JSDoc.

Getting started

Simply install via:

$ npm install jsdoc -g
$ npm install wp-hookdoc --save-dev

In your JSDoc configuration file hookdoc-conf.json the following options are essential (create a seperate configuration file if you already use JSDoc):

    "opts": {
        "template": "node_modules/wp-hookdoc/template"
    "source": {
        "includePattern": ".+\\.(php|inc)?$"
    "plugins": [

Run your jsdoc command with the input files and -c hookdoc-conf.json.

Define Action Docblock

Define @hook attribute with the name of the action:

 * Enqueue scripts for all admin pages.
 * @since 2.8.0
 * @hook admin_enqueue_scripts
 * @param {string} $hook_suffix The current admin page.
do_action( 'admin_enqueue_scripts', $hook_suffix );

Define Filter Docblock

Define @hook attribute with the name of the filter and a @returns attribute:

 * Filters the title tag content for an admin page.
 * @since 3.1.0
 * @hook admin_title
 * @param {string} $admin_title The page title, with extra context added.
 * @param {string} $title       The original page title.
 * @returns {string} The title
$admin_title = apply_filters( 'admin_title', $admin_title, $title );

Generate example documentation

To generate an example documentation change to the node_modules/wp-hookdoc folder and run:

npm run example

You will find the output in node_modules/wp-hookdoc/example/out: example output


This module is MIT licensed.