#5905 - Add example files to each hook subtype folder
-
By PDStig
- Added
- 5 views
| Identifier | #5905 |
|---|---|
| Issue type | Feature request or suggestion |
| Title | Add example files to each hook subtype folder |
| Status | Open |
| Tags |
Roadmap: Sponsorship (custom) |
| Handling member | Deleted |
| Addon | core |
| Description | Assist developers with understanding how to develop hooks for each subtype by creating an example.php.template file in each subtype folder.
The file should contain PHP code template outlining the expected structure of hooks in that subtype (functions / their parameters and whether they are optional functions, PHPDoc). Additionally, if any info is used (e.g. content_meta_aware), put comments explaining each property so developers know how to use them or what to put in them. Add a test in the test suite to ensure every hook subtype has this file. |
| Steps to reproduce | |
| Additional information | This is not something I will do without someone sponsoring it (except to a very limited / slow degree in my spare time), so if you'd like to see this as a form of more documentation for hooks, and you want to see it quickly and thoroughly, please contact me to discuss how to fund this issue. |
| Funded? | No |
The system will post a comment when this issue is modified (e.g., status changes). To be notified of this, click "Enable comment notifications".
Comments
There have been no comments yet