From 383e9013f6567614fe000073fab8270c5e84ef17 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Thiemo=20M=C3=A4ttig?= Date: Thu, 11 Jan 2018 14:21:58 +0100 Subject: [PATCH] Update UserSaveOptions/UserSaveSettings hook descriptions I already updated https://www.mediawiki.org/wiki/Manual:Hooks/UserSaveOptions https://www.mediawiki.org/wiki/Manual:Hooks/UserSaveSettings accordingly. Change-Id: I492f83aa8acb6521f3e175fdbf507a7e44491ca2 --- docs/hooks.txt | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/hooks.txt b/docs/hooks.txt index c5bccaf3bf..d497884236 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -3809,12 +3809,16 @@ After a user's group memberships are changed. $add: Array of strings corresponding to groups added $remove: Array of strings corresponding to groups removed -'UserSaveOptions': Called just before saving user preferences/options. -$user: User object -&$options: Options, modifiable - -'UserSaveSettings': Called when saving user settings. -$user: User object +'UserSaveOptions': Called just before saving user preferences. Hook handlers can either add or +manipulate options, or reset one back to it's default to block changing it. Hook handlers are also +allowed to abort the process by returning false, e.g. to save to a global profile instead. Compare +to the UserSaveSettings hook, which is called after the preferences have been saved. +$user: The User for which the options are going to be saved +&$options: The users options as an associative array, modifiable + +'UserSaveSettings': Called directly after user preferences (user_properties in the database) have +been saved. Compare to the UserSaveOptions hook, which is called before. +$user: The User for which the options have been saved 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider -- 2.20.1