From eff2e6c7950df6a08fceb1eb0b9ab737e600763a Mon Sep 17 00:00:00 2001 From: redmatrix Date: Tue, 27 Sep 2016 18:11:04 -0700 Subject: make the fetching of the default profile photo hookable, and document the hook --- doc/hook/get_profile_photo.bb | 18 ++++++++++++++++++ doc/hooklist.bb | 3 +++ 2 files changed, 21 insertions(+) create mode 100644 doc/hook/get_profile_photo.bb (limited to 'doc') diff --git a/doc/hook/get_profile_photo.bb b/doc/hook/get_profile_photo.bb new file mode 100644 index 000000000..ab07179ae --- /dev/null +++ b/doc/hook/get_profile_photo.bb @@ -0,0 +1,18 @@ +[h2]get_profile_photo[/h2] + +Called when fetching the content of the default profile photo for a local channel in mod_photo. + + +Hook arguments: + +'imgscale' => integer resolution requested (4, 5, or 6) +'channel_id' => channel_id of requested profile photo +'default' => filename of default profile photo of this imgscale +'data' => empty string +'mimetype' => empty string + + +If 'data' is set, this data will be used instead of the data obtained from the database search for the profile photo. +If 'mimetype' is set, this mimetype will be used instead of the mimetype obtained from the database or the default profile photo mimetype. + + diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 858a7d021..e48fbee7c 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -236,6 +236,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/get_features]get_features[/zrl] Called when get_features() is called +[zrl=[baseurl]/help/hook/get_profile_photo]get_profile_photo[/zrl] + Called when local profile photo content is fetched in mod_photo + [zrl=[baseurl]/help/hook/get_role_perms]get_role_perms[/zrl] Called when get_role_perms() is called to obtain permissions for named permission roles -- cgit v1.2.3