File: ApiDeprecationHelpHook.php

package info (click to toggle)
mediawiki 1%3A1.35.13-1%2Bdeb11u2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 274,932 kB
  • sloc: php: 677,563; javascript: 572,709; sql: 11,565; python: 4,447; xml: 3,145; sh: 892; perl: 788; ruby: 496; pascal: 365; makefile: 128
file content (23 lines) | stat: -rw-r--r-- 525 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
<?php

namespace MediaWiki\Api\Hook;

use Message;

/**
 * @stable to implement
 * @ingroup Hooks
 */
interface ApiDeprecationHelpHook {
	/**
	 * Use this hook to add messages to the 'deprecation-help' warning generated
	 * from ApiBase::addDeprecation().
	 *
	 * @since 1.35
	 *
	 * @param Message[] &$msgs Messages to include in the help. Multiple messages will be
	 *   joined with spaces.
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onApiDeprecationHelp( &$msgs );
}