akirk/Extract WordPress Hooks

Extract WordPress hooks from your repository and generate wiki documentation

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jun 3, 2026
License
GPL 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: akirk/extract-wp-hooks@c0b59d9607347a0390627756c095c52d5f98016a # 1.4.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
config-filePath to the extract-wp-hooks.json configuration file (optional if other config inputs are provided)no.extract-wp-hooks.json
namespacePHP Namespace that's used.no
base-dirBase directory to scan for hooks (default: current directory)no.
wiki-directoryDirectory to store wiki filesnowiki
github-blob-urlGitHub blob URL for source linksno
exclude-dirsComma-separated list of directories to excludenovendor,node_modules
ignore-filtersComma-separated list of filter names to ignoreno""
ignore-regexRegex pattern to ignore filter namesno
sectionHow to group hooks in documentation: 'file' or 'dir'nofile
wiki-repoWiki repository URL (e.g., username/repo.wiki.git)no""
example-styleStyle for the auto-generated example code: 'default' or 'prefixed'nodefault
top-headlineWrite a headline for each markdown documentnofalse
namedescription
hooks-foundNumber of hooks found and processed
wiki-filesNumber of wiki files generated