PHPackages                             solvebeam/wp-hooks-documentor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. solvebeam/wp-hooks-documentor

ActiveLibrary[CLI & Console](/categories/cli)

solvebeam/wp-hooks-documentor
=============================

Documentation Generator for WordPress.

v1.5.0(2mo ago)2121GPL-2.0-or-laterPHPPHP >=8.2CI failing

Since Apr 14Pushed 2mo agoCompare

[ Source](https://github.com/solvebeam/wp-hooks-documentor)[ Packagist](https://packagist.org/packages/solvebeam/wp-hooks-documentor)[ RSS](/packages/solvebeam-wp-hooks-documentor/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (14)Versions (10)Used By (1)

 [ ![SolveBeam WordPress Hooks Documentor](logos/solvebeam-wp-hooks-documentor.svgo-min.svg) ](https://github.com/solvebeam/wp-hooks-documentor)

SolveBeam WordPress Hooks Documentor
====================================

[](#solvebeam-wordpress-hooks-documentor)

 SolveBeam WordPress Hooks Documentor is a tool to automatically extract data about the **actions** and **filters** of your WordPress theme or plugin.

[![Latest Stable Version](https://camo.githubusercontent.com/270602381beea9340a005f143e6330f2b1e7ed5555b2c955a86f59a5119b7600/68747470733a2f2f706f7365722e707567782e6f72672f736f6c76656265616d2f77702d686f6f6b732d646f63756d656e746f722f76)](//packagist.org/packages/solvebeam/wp-hooks-documentor)[![Total Downloads](https://camo.githubusercontent.com/b06daaa20c3c001a03e597e2a028e147e01fe8e721e7188c00f087e23af74e40/68747470733a2f2f706f7365722e707567782e6f72672f736f6c76656265616d2f77702d686f6f6b732d646f63756d656e746f722f646f776e6c6f616473)](//packagist.org/packages/solvebeam/wp-hooks-documentor)[![Latest Unstable Version](https://camo.githubusercontent.com/7c4165d85a00d8a845beb530a6e6bdbf220048c9bead826dff50ef3ef28318e9/68747470733a2f2f706f7365722e707567782e6f72672f736f6c76656265616d2f77702d686f6f6b732d646f63756d656e746f722f762f756e737461626c65)](//packagist.org/packages/solvebeam/wp-hooks-documentor)[![License](https://camo.githubusercontent.com/fafaa83532c5c772bca5e3a8f72d0b2d2061bdc165c121cc67b77ea21650e4d1/68747470733a2f2f706f7365722e707567782e6f72672f736f6c76656265616d2f77702d686f6f6b732d646f63756d656e746f722f6c6963656e7365)](//packagist.org/packages/solvebeam/wp-hooks-documentor)

Table of contents
-----------------

[](#table-of-contents)

- [Getting Started](#getting-started)
- [Command Line Usage](#command-line-usage)
    - [Examples](#examples)
- [Output Examples](#output-examples)
- [Alternatives](#alternatives)
- [Links](#links)

Getting Started
---------------

[](#getting-started)

### Installation

[](#installation)

To start documenting your WordPress filters and actions, require SolveBeam WordPress Hooks Documentor in Composer:

```
composer require solvebeam/wp-hooks-documentor --dev

```

### First Run

[](#first-run)

To let SolveBeam WordPress Hooks Documentor analyse your codebase, you have to use the `parse` command and point it to the right directory:

```
vendor/bin/wphd parse src

```

Command Line Usage
------------------

[](#command-line-usage)

### `--format=FORMAT`

[](#--formatformat)

The format in which you want to export the hooks.

FormatDescription`default`Symfony console table.`hookster`Hookster JSON.`markdown`Markdown.`phpdocumentor-rst`RestructuredText for phpDocumentor.Example: `--format=markdown`

### `--template=FILE`

[](#--templatefile)

Custom PHP template, see for examples the [`templates`](templates) folder.

Example: `--template=templates/markdown.php`

### `--type=TYPE`

[](#--typetype)

Specify whether you want to export `actions` or `filters`.

Example: `--type=actions` or `--type=filters`

### `--output=FILE`

[](#--outputfile)

Write output to file.

Example: `--output=docs/hooks.md`

### `--memory-limit=VALUE`

[](#--memory-limitvalue)

Specifies the memory limit in the same format `php.ini` accepts.

Example: `--memory-limit=-1`

### `--exclude=GLOB`

[](#--excludeglob)

Exclude the specified folders/files.

Example: `--exclude=vendor --exclude=wordpress`

### `--ignore-vcs-ignored`

[](#--ignore-vcs-ignored)

If the search directory contains a `.gitignore` file, you can reuse those rules to exclude files and directories from the results with this option.

Example: `--ignore-vcs-ignored`

### `--prefix=PREFIX`

[](#--prefixprefix)

Only parse hooks starting with the specified prefixes.

Example: `--prefix=my_theme --prefix=my_plugin`

### Examples

[](#examples)

```
vendor/bin/wphd parse ./tests/source

```

```
vendor/bin/wphd parse ./tests/source --format=hookster --type=actions --output=tests/docs/hookster-actions.json
vendor/bin/wphd parse ./tests/source --format=hookster --type=filters --output=tests/docs/hookster-filters.json

```

```
vendor/bin/wphd parse ./tests/source --format=markdown --output=tests/docs/hooks.md

```

```
vendor/bin/wphd parse ./tests/source --format=phpdocumentor-rst --type=actions --output=tests/docs/phpdocumentor-actions.rst
vendor/bin/wphd parse ./tests/source --format=phpdocumentor-rst --type=filters --output=tests/docs/phpdocumentor-filters.rst

```

Ouput Examples
--------------

[](#ouput-examples)

- [tests/docs/hooks.md](tests/docs/hooks.md)
- [tests/docs/hookster-actions.json](tests/docs/hookster-actions.json)
- [tests/docs/hookster-filters.json](tests/docs/hookster-filters.json)
-
-
-
-
-

Alternatives
------------

[](#alternatives)

Here is a list of alternatives that we found. However, none of these satisfied our requirements.

*If you know other similar projects, feel free to edit this section!*

- [WP Parser](https://github.com/WordPress/phpdoc-parser) by [WordPress](https://github.com/WordPress)
- [Hookster](https://github.com/themeblvd/hookster) by [Theme Blvd](https://github.com/themeblvd)
- [WordPress HookDoc](https://github.com/matzeeable/wp-hookdoc) by [Matthias Günter](https://github.com/matzeeable)
- [GitHub Actions for WordPress](https://github.com/10up/actions-wordpress/blob/stable/hookdocs-workflow.md) by [10up](https://github.com/10up)
- [Yoast Parser](https://github.com/Yoast/code-documentation-extractor) by [Yoast](https://github.com/Yoast)
- [WooCommerce Code Reference Generator](https://github.com/woocommerce/code-reference) by [WooCommerce](https://github.com/woocommerce)
- [WordPress Hooks Reference](https://github.com/johnbillion/wp-hooks) by [John Blackbourn](https://github.com/johnbillion) / [Human Made](https://github.com/humanmade)
- [wp-hooks-generator](https://github.com/johnbillion/wp-hooks-generator) by [John Blackbourn](https://github.com/johnbillion) / [Human Made](https://github.com/humanmade)

*Inspiration from *

Links
-----

[](#links)

-
-
- [https://developer.wordpress.org/reference/functions/do\_action/](https://developer.wordpress.org/reference/functions/do_action/)
- [https://developer.wordpress.org/reference/functions/add\_action/](https://developer.wordpress.org/reference/functions/add_action/)
-
- [https://developer.wordpress.org/reference/functions/apply\_filters/](https://developer.wordpress.org/reference/functions/apply_filters/)
- [https://developer.wordpress.org/reference/functions/add\_filter/](https://developer.wordpress.org/reference/functions/add_filter/)
-
-
-
-
-
-
-
-
-
- [pronamic/wp-pay-core#45](https://github.com/pronamic/wp-pay-core/issues/45)
- [phpDocumentor/phpDocumentor#2865](https://github.com/phpDocumentor/phpDocumentor/issues/2865)
-

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance84

Actively maintained with recent releases

Popularity10

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 98.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~222 days

Recently: every ~330 days

Total

9

Last Release

80d ago

PHP version history (2 changes)v1.4.0PHP >=8.0

v1.5.0PHP >=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/869674?v=4)[Remco Tolsma](/maintainers/remcotolsma)[@remcotolsma](https://github.com/remcotolsma)

---

Top Contributors

[![remcotolsma](https://avatars.githubusercontent.com/u/869674?v=4)](https://github.com/remcotolsma "remcotolsma (174 commits)")[![jmslbam](https://avatars.githubusercontent.com/u/145887?v=4)](https://github.com/jmslbam "jmslbam (1 commits)")[![LuigiPulcini](https://avatars.githubusercontent.com/u/7178054?v=4)](https://github.com/LuigiPulcini "LuigiPulcini (1 commits)")

---

Tags

actionsclidocblockdocblocksdocumentationfiltershooksphpphpdocphpdocumentorwordpressapiphpdocwordpressdocumentationapplicationdga

###  Code Quality

Static AnalysisRector

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/solvebeam-wp-hooks-documentor/health.svg)

```
[![Health](https://phpackages.com/badges/solvebeam-wp-hooks-documentor/health.svg)](https://phpackages.com/packages/solvebeam-wp-hooks-documentor)
```

###  Alternatives

[phpdocumentor/phpdocumentor

Documentation Generator for PHP

4.4k3.1M878](/packages/phpdocumentor-phpdocumentor)[pronamic/wp-documentor

Documentation Generator for WordPress.

6529.8k5](/packages/pronamic-wp-documentor)[nelmio/api-doc-bundle

Generates documentation for your REST API from attributes

2.3k63.6M233](/packages/nelmio-api-doc-bundle)[humbug/php-scoper

Prefixes all PHP namespaces in a file or directory.

7963.0M35](/packages/humbug-php-scoper)[apigen/apigen

PHP source code API generator.

2.2k627.9k225](/packages/apigen-apigen)[ssch/typo3-rector

Instant fixes for your TYPO3 PHP code by using Rector.

2592.8M263](/packages/ssch-typo3-rector)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)