Add the Hooks Documentation in the Wiki #86
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.