core\hook\described_hook Interface Reference

Interface for a hook to provide a description of itself for administrator information. More...

Inheritance diagram for core\hook\described_hook:

Static Public Member Functions
static	get_hook_description ()
	Hook purpose description in Markdown format used on Hooks overview page.
static	get_hook_tags ()
	List of tags that describe this hook.

Detailed Description

Interface for a hook to provide a description of itself for administrator information.

Author

Petr Skoda

Copyright

2022 Open LMS

License

https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_hook_description()

static core\hook\described_hook::get_hook_description ( )

static

Hook purpose description in Markdown format used on Hooks overview page.

It should include description of callback priority setting rules if applicable.

Return values

string

Implemented in core\hook\navigation\primary_extend, core_user\hook\after_login_completed, and tool_mfa\hook\after_user_passed_mfa.

get_hook_tags()

static core\hook\described_hook::get_hook_tags ( )

static

List of tags that describe this hook.

Return values

string[]

Implemented in core\hook\navigation\primary_extend, core_user\hook\after_login_completed, and tool_mfa\hook\after_user_passed_mfa.

---

The documentation for this interface was generated from the following file:

• lib/classes/hook/described_hook.php