PHPackages                             pentatonicfunk/wp-phpdoc-markdown - 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. pentatonicfunk/wp-phpdoc-markdown

ActiveWordpress-plugin

pentatonicfunk/wp-phpdoc-markdown
=================================

Create markdown from WordPress phpdoc, focused on hooks (action/filter). Forked from https://github.com/WordPress/phpdoc-parser

00[4 issues](https://github.com/pentatonicfunk/wp-phpdoc-markdown/issues)PHP

Since May 11Pushed 8y ago1 watchersCompare

[ Source](https://github.com/pentatonicfunk/wp-phpdoc-markdown)[ Packagist](https://packagist.org/packages/pentatonicfunk/wp-phpdoc-markdown)[ RSS](/packages/pentatonicfunk-wp-phpdoc-markdown/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

WP phpDoc Markdown
==================

[](#wp-phpdoc-markdown)

Create Markdown documentations for WordPress Code. Currently its only creating docs for `hooks`. `Functions` and `Classes` not included yet.

History and Credits
-------------------

[](#history-and-credits)

This project is based on [WordPress/phpdoc-parser](https://github.com/WordPress/phpdoc-parser).

Inline documentation should follow [WordPress Best Practices](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/)

Sample Output : [example.md](examples/example.md)
-------------------------------------------------

[](#sample-output--examplemd)

Requirements
------------

[](#requirements)

- PHP 5.4+
- [Composer](https://getcomposer.org/)
- [WP CLI](http://wp-cli.org/)

Clone the repository into your WordPress plugins directory:

```
git clone git@github.com:pentatonicfunk/wp-phpdoc-markdown.git
```

After that install the dependencies using composer in the parser directory:

```
composer install
```

Running
-------

[](#running)

Activate the plugin first:

```
wp plugin activate wp-phpdoc-markdown

```

In your site's directory / `wp-phpdoc-markdown` directory:

```
wp wparser mdhooks   [--json_doc=]
wp wparser mdhooks ../forminator/ ./../forminator/docs

```

Customization
-------------

[](#customization)

All default used templates are placed in [templates](templates)

To Customize it define this constant in your `wp-config.php`

```
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_TOC', '/path/to/toc.md' );
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK', __DIR__ . '/path/to/hook.md' );
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_PARAMETERS', '/path/to/hook.parameters.md' );
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_PARAMETER', '/path/to/hook.parameter.md' );
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_CHANGELOGS', '/path/to/hook.changelogs.md' );
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_CHANGELOG', '/path/to/hook.changelog.md' );
```

Usage Help
----------

[](#usage-help)

### NAME

[](#name)

```
wp wparser mdhooks

```

### DESCRIPTION

[](#description)

```
Generate a JSON file containing the PHPDoc markup, and create markdown docs of hooks on .

```

### SYNOPSIS

[](#synopsis)

```
wp wparser mdhooks   [--json_doc=]

```

### OPTIONS

[](#options)

```

    Source code directory

    Desired Output directory of markdown documents

[--json_doc=]
    Where temporary generated json phpdoc will be created, default is /tmp/phpdoc.json

```

### EXAMPLES

[](#examples)

```
wp wparser mdhooks   [--json_doc=]
wp wparser mdhooks ../forminator/ ./../forminator/docs --json_doc=/tmp/phpdoc.json

```

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/982a007870785260477d62996e47359757b8ec0b06ba08ea55b8ceef9705507c?d=identicon)[pentatonicfunk](/maintainers/pentatonicfunk)

---

Top Contributors

[![pentatonicfunk](https://avatars.githubusercontent.com/u/831674?v=4)](https://github.com/pentatonicfunk "pentatonicfunk (16 commits)")

### Embed Badge

![Health badge](/badges/pentatonicfunk-wp-phpdoc-markdown/health.svg)

```
[![Health](https://phpackages.com/badges/pentatonicfunk-wp-phpdoc-markdown/health.svg)](https://phpackages.com/packages/pentatonicfunk-wp-phpdoc-markdown)
```

PHPackages © 2026

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