aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/BadImageHook.php
blob: 727abe76f006bba6caa67629458c464c1f384a34 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?php

namespace MediaWiki\Hook;

/**
 * @stable for implementation
 * @ingroup Hooks
 */
interface BadImageHook {
	/**
	 * This hook is called when checking against the bad image list. If an image is "bad",
	 * it is not rendered inline in wiki pages or galleries in category pages.
	 *
	 * @since 1.35
	 *
	 * @param string $name Image name being checked
	 * @param bool &$bad Whether or not the image is "bad"
	 * @return bool|void True or no return value to continue, or false and change $bad
	 *   to override
	 */
	public function onBadImage( $name, &$bad );
}