aboutsummaryrefslogtreecommitdiffstats
path: root/includes/content/Hook/ContentHandlerForModelIDHook.php
blob: d996f79f9d476fd2fccd245a5e7787f4914349d2 (plain) (blame)
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
<?php

namespace MediaWiki\Content\Hook;

use MediaWiki\Content\ContentHandler;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ContentHandlerForModelID" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ContentHandlerForModelIDHook {
	/**
	 * This hook is called when a ContentHandler is requested for a given content model name,
	 * but no entry for that model exists in $wgContentHandlers. Note: if your extension implements
	 * additional models via this hook, please use GetContentModels hook to make them known to core.
	 *
	 * @since 1.35
	 *
	 * @param string $modelName Requested content model name
	 * @param ContentHandler &$handler Set this to a ContentHandler object, if desired
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onContentHandlerForModelID( $modelName, &$handler );
}