wiki.techinc.nl/includes/parser/Hook/InternalParseBeforeSanitizeHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

30 lines
970 B
PHP

<?php
namespace MediaWiki\Hook;
use Parser;
use StripState;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "InternalParseBeforeSanitize" to register handlers implementing this interface.
*
* @deprecated since 1.35
* @ingroup Hooks
*/
interface InternalParseBeforeSanitizeHook {
/**
* This hook is called during Parser's internalParse method just before
* the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
* includeonly/onlyinclude and other processing. Ideal for syntax-extensions after
* template/parser function execution which respect nowiki and HTML-comments.
*
* @since 1.35
*
* @param Parser $parser
* @param string &$text Partially parsed text
* @param StripState $stripState Parser's internal StripState object
* @return bool|void True or no return value to continue or false to abort
*/
public function onInternalParseBeforeSanitize( $parser, &$text, $stripState );
}