View Issue Details

IDProjectCategoryView StatusLast Update
5905Composrcorepublic2024-08-23 20:54
ReporterPDStig Assigned ToGuest  
PrioritynormalSeverityfeature 
Status newResolutionopen 
Summary5905: Add example files to each hook subtype folder
DescriptionAssist 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.
Additional InformationThis 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.
TagsRoadmap: Sponsorship
Attach Tags
Time estimation (hours)10
Sponsorship openOpen

Sponsor

Date Added Member Amount Sponsored

Activities

There are no notes attached to this issue.

Add Note

View Status
Note
Upload Files
Maximum size: 32,768 KiB

Attach files by dragging & dropping, selecting or pasting them.
You are not logged in You are not logged in. This means you will not get any e-mail notifications. And if you reply, we will not know for sure you are the original poster of the issue.

Issue History

Date Modified Username Field Change
2024-08-22 12:39 PDStig New Issue
2024-08-22 12:39 PDStig Tag Attached: Roadmap: Sponsorship
2024-08-22 12:40 PDStig Additional Information Updated
2024-08-22 12:40 PDStig Sponsorship open Open => Open
2024-08-22 12:40 PDStig Additional Information Updated
2024-08-22 12:40 PDStig Sponsorship open Open => Open
2024-08-22 12:41 PDStig Time estimation (hours) 5 => 10
2024-08-22 12:41 PDStig Sponsorship open Open => Open