File: ProtectionForm__saveHook.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 (28 lines) | stat: -rw-r--r-- 861 bytes parent folder | download | duplicates (3)
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
<?php

namespace MediaWiki\Hook;

// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
use Article;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ProtectionForm::save" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ProtectionForm__saveHook {
	/**
	 * This hook is called when a protection form is submitted.
	 *
	 * @since 1.35
	 *
	 * @param Article $article Page being (un)protected
	 * @param string|array &$errorMsg HTML message string of an error or an array of message name and
	 *   its parameters
	 * @param string $reasonstr String describing the reason page protection level is altered
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onProtectionForm__save( $article, &$errorMsg, $reasonstr );
}