File: TempUserCreatedRedirectHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (44 lines) | stat: -rw-r--r-- 1,341 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?php

namespace MediaWiki\Hook;

use MediaWiki\Session\Session;
use MediaWiki\User\UserIdentity;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "TempUserCreatedRedirect" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface TempUserCreatedRedirectHook {
	/**
	 * This hook is called after an action causes a temporary user to be
	 * created or after the first successful edit for a temporary account.
	 * The handler may modify the redirect URL.
	 *
	 * To differentiate between invocations of this hook where a) the account
	 * was created in the current request and b) the account existed, but made
	 * a first successful edit, one can examine the registration date of the
	 * account.
	 *
	 * @since 1.39
	 *
	 * @param Session $session
	 * @param UserIdentity $user
	 * @param string $returnTo The prefixed DB key of the title to redirect to
	 * @param string $returnToQuery An extra query part
	 * @param string $returnToAnchor Either an empty string or a fragment beginning with "#"
	 * @param string &$redirectUrl The URL to redirect to
	 * @return bool|null
	 */
	public function onTempUserCreatedRedirect(
		Session $session,
		UserIdentity $user,
		string $returnTo,
		string $returnToQuery,
		string $returnToAnchor,
		&$redirectUrl
	);
}