File: ConvertContentHook.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 (31 lines) | stat: -rw-r--r-- 1,097 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
<?php

namespace MediaWiki\Content\Hook;

use MediaWiki\Content\Content;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ConvertContent" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ConvertContentHook {
	/**
	 * This hook is called by AbstractContent::convert when a conversion to another content model
	 * is requested. Handler functions that modify $result should generally return false to disable
	 * further attempts at conversion.
	 *
	 * @since 1.35
	 *
	 * @param Content $content Content object to be converted
	 * @param string $toModel ID of the content model to convert to
	 * @param bool $lossy Whether lossy conversion is allowed
	 * @param Content|false &$result Output parameter, in case the handler function wants to
	 *   provide a converted Content object. Note that $result->getContentModel() must return
	 *   $toModel.
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onConvertContent( $content, $toModel, $lossy, &$result );
}