Closed akirk closed 4 months ago
This adds a script that extracts the hooks offered by the Enable Mastodon Apps plugin and writes to the Enable Mastodon Apps Wiki Hooks Documentation.
This is a screenshot of the mastodon_api_account page.
mastodon_api_account
In this PR you can also see how hooks can be documented:
Add a comment block before the apply_filters or do_action function call. The first line will be the text displayed in the hooks list:
apply_filters
do_action
Other lines appear on the documentation page (Example: mastodon_api_account).
Add example code by writing:
* Example: * ```php * apply_filters( 'hook_name', function ( $params ) { * // modify params * return $params; * } ); * ```
git clone git@github.com:akirk/enable-mastodon-apps.wiki.git
php bin/extract-hooks.php
enable-mastodon-apps.wiki
git commit
git push
This adds a script that extracts the hooks offered by the Enable Mastodon Apps plugin and writes to the Enable Mastodon Apps Wiki Hooks Documentation.
This is a screenshot of the
mastodon_api_account
page.Adding Hook Documentation
In this PR you can also see how hooks can be documented:
Add a comment block before the
apply_filters
ordo_action
function call. The first line will be the text displayed in the hooks list:Other lines appear on the documentation page (Example:
mastodon_api_account
).Add example code by writing:
Extraction process
git clone git@github.com:akirk/enable-mastodon-apps.wiki.git
.php bin/extract-hooks.php
script via CLI.enable-mastodon-apps.wiki
directory and observe the new or changed files.git commit
andgit push
the changes.