Skip to content

Add new plugin hooks documentation#170

Open
cconard96 wants to merge 3 commits intoglpi-project:masterfrom
cconard96:enhance/hooks
Open

Add new plugin hooks documentation#170
cconard96 wants to merge 3 commits intoglpi-project:masterfrom
cconard96:enhance/hooks

Conversation

@cconard96
Copy link
Copy Markdown
Contributor

WIP adding documentation from glpi-project/glpi#19450 to enhance the plugin hook documenation. This is all to add the documentation for the missing hooks, improve the overall quality of the documentation, document the new Hooks and HookManager classes, and make it less likely that the hook documentation becomes out of date again.

@cconard96 cconard96 self-assigned this May 17, 2025
@cconard96 cconard96 added the WIP label May 17, 2025
@cedric-anne cedric-anne force-pushed the develop branch 2 times, most recently from 07919b0 to 6d023c0 Compare May 19, 2025 08:46
Copy link
Copy Markdown
Member

@cedric-anne cedric-anne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hook names should probably be clarified. Developers may try to use the documented name as a string.
Maybe the FQCN should be added, like this: \Glpi\Plugins\Hooks::ADD_CSS_ANONYMOUS_PAGE.

@trasher
Copy link
Copy Markdown
Collaborator

trasher commented Jun 2, 2025

Diff is too huge, branch must be rebased

@cedric-anne cedric-anne mentioned this pull request Jun 2, 2025
@trasher trasher deleted the branch glpi-project:master June 2, 2025 13:14
@trasher trasher closed this Jun 2, 2025
@trasher trasher reopened this Jun 2, 2025
@trasher trasher changed the base branch from develop to master June 2, 2025 13:15
@cconard96
Copy link
Copy Markdown
Contributor Author

Rebased. The documentation here, apart from the description at the very top, was automatically generated by the tools:generate_hooks_documentation CLI command in GLPI core. Any issues with the actual hooks documentation need fixed in the command or in the PHPDoc of the Hooks constants which are the source of this info.

@cconard96 cconard96 marked this pull request as ready for review March 30, 2026 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants