Add new plugin hooks documentation#170
Draft
cconard96 wants to merge 26 commits intoglpi-project:masterfrom
Draft
Add new plugin hooks documentation#170cconard96 wants to merge 26 commits intoglpi-project:masterfrom
cconard96 wants to merge 26 commits intoglpi-project:masterfrom
Conversation
* start documenting HL API * remove x-default-contexts
* Array syntax is now enforced * A word about criteria unicity * Warning about raw queries
* Add more upgrade instructions for GLPI 11.0 * Apply suggestions from code review Co-authored-by: Curtis Conard <cconard96@gmail.com> --------- Co-authored-by: Curtis Conard <cconard96@gmail.com>
Added 'to be' where needed
…ript_module_anonymous_page, add_css_anonymous_page, add_header_tag_anonymous_page (glpi-project#160) * add doc * fix comment
* -B option doesn't exist anymore * langage specified to avoid warning. * fix path to glpi logo --------- Co-authored-by: Sebastien Monterisi <smonterisi@teclib.com>
* Update sourcecode testing section * Update linting section * nfo about launching tests "as in ci" + note about phpunit * Update source/sourcecode.rst Co-authored-by: Johan Cwiklinski <trasher@x-tnd.be> --------- Co-authored-by: Sebastien Monterisi <smonterisi@teclib.com> Co-authored-by: Johan Cwiklinski <trasher@x-tnd.be>
* Fix tests documentation * Update source/sourcecode.rst --------- Co-authored-by: Cédric Anne <cedric.anne@gmail.com>
* tutorial for developping a plugin * update doc * Fix syntax * clean php snippets * clean use * clean use * Few fixes * Fix doc links * Translate titles * Rework main title * Translation * Dead ref * Translate * Remove metabase part * Translate * Fix internal links * Apply suggestions from code review Co-authored-by: Curtis Conard <cconard96@gmail.com> * Work on translations * Maybe should not we use logDebug. * Translation, minor fix * Fix syntax * Translate * Translate * Translate * No direct querying * End translation * Typo * Typos, misssed translations * Apply suggestions from code review Thanks Curtis! Co-authored-by: Curtis Conard <cconard96@gmail.com> * Update source/plugins/tutorial.rst Co-authored-by: Curtis Conard <cconard96@gmail.com> * A word about npm. Precision: composer and npm are not mandatory * Apply suggestions from code review Co-authored-by: Curtis Conard <cconard96@gmail.com> * Add download_url and a note on plugin submission URL * Apply suggestions from code review Co-authored-by: Alexandre Delaunay <delaunay.alexandre@gmail.com> * Replace old links --------- Co-authored-by: Johan Cwiklinski <johan@x-tnd.be> Co-authored-by: Curtis Conard <cconard96@gmail.com>
cedric-anne
reviewed
Jun 2, 2025
Member
cedric-anne
left a comment
cedric-anne
left a comment
There was a problem hiding this comment.
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.
Comment on lines
+11
to
+12
| ##### | ||
| ADD_CSS |
Member
There was a problem hiding this comment.
There is a missing empty line here.
Comment on lines
+16
to
+18
|
|
||
|
|
||
|
|
Member
There was a problem hiding this comment.
There are too many empty lines here.
Collaborator
|
Diff is too huge, branch must be rebased |
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
11 participants
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.
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
HooksandHookManagerclasses, and make it less likely that the hook documentation becomes out of date again.