TemplateStylesStylesheetSanitizerHook.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

TemplateStylesStylesheetSanitizerHook.php
View Options

	<?php

	namespace MediaWiki\Extension\TemplateStyles\Hooks;

	use Wikimedia\CSS\Grammar\MatcherFactory;
	use Wikimedia\CSS\Sanitizer\StylePropertySanitizer;
	use Wikimedia\CSS\Sanitizer\StylesheetSanitizer;

	/**
	* This is a hook handler interface, see docs/Hooks.md in core.
	* Use the hook name "TemplateStylesStylesheetSanitizer" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface TemplateStylesStylesheetSanitizerHook {
	/**
	* Allows for adjusting or replacing the StylesheetSanitizer.
	* For example, you might add, remove, or redefine at-rule sanitizers
	*
	* @param StylesheetSanitizer &$sanitizer StylesheetSanitizer to be used for sanitization.
	* The array returned by `$sanitizer->getRuleSanitizers()` will use the at-rule names (including the '@') as keys.
	* The style rule sanitizer has key 'styles'
	* @param StylePropertySanitizer $propertySanitizer StylePropertySanitizer being used for sanitization,
	* for use in adding or redefining rule sanitizers
	* @param MatcherFactory $matcherFactory MatcherFactory being used, for use in adding or redefining rule sanitizers
	* @return bool\|void True or no return value to continue or false to abort
	*/
	public function onTemplateStylesStylesheetSanitizer(
	StylesheetSanitizer &$sanitizer,
	StylePropertySanitizer $propertySanitizer,
	MatcherFactory $matcherFactory
	);
	}