aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/GetDefaultSortkeyHook.php
diff options
context:
space:
mode:
authorapaskulin <apaskulin@wikimedia.org>2020-03-16 16:31:05 -0700
committerTim Starling <tstarling@wikimedia.org>2020-04-21 09:10:08 +1000
commitc44488f72549331733ef261b90058fd73d7badde (patch)
tree91ac013c191dbab31525b506083ccb0b37ce3a57 /includes/Hook/GetDefaultSortkeyHook.php
parentf5aaf75ad15813bfeb93dcb4e5fbaaa52b23c7fe (diff)
downloadmediawikicore-c44488f72549331733ef261b90058fd73d7badde.tar.gz
mediawikicore-c44488f72549331733ef261b90058fd73d7badde.zip
docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
Diffstat (limited to 'includes/Hook/GetDefaultSortkeyHook.php')
-rw-r--r--includes/Hook/GetDefaultSortkeyHook.php8
1 files changed, 5 insertions, 3 deletions
diff --git a/includes/Hook/GetDefaultSortkeyHook.php b/includes/Hook/GetDefaultSortkeyHook.php
index 450b4f2f40e8..8743ec3d837f 100644
--- a/includes/Hook/GetDefaultSortkeyHook.php
+++ b/includes/Hook/GetDefaultSortkeyHook.php
@@ -2,18 +2,20 @@
namespace MediaWiki\Hook;
+use Title;
+
/**
* @stable for implementation
* @ingroup Hooks
*/
interface GetDefaultSortkeyHook {
/**
- * Override the default sortkey for a page.
+ * Use this hook to override the default sortkey for a page.
*
* @since 1.35
*
- * @param ?mixed $title Title object that we need to get a sortkey for
- * @param ?mixed &$sortkey Sortkey to use.
+ * @param Title $title Title object that we need to get a sortkey for
+ * @param string &$sortkey Sortkey to use
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetDefaultSortkey( $title, &$sortkey );