Set options of the Parser. More...

Collaboration diagram for ParserOptions:

[legend]

Public Member Functions
	__construct ( $user=null, $lang=null)

	addExtraKey ( $key)
	Extra key that should be present in the parser cache key. More...

	getEditSection ()
	Create "edit section" links? More...

	getRedirectTarget ()
	Get the previously-set redirect target. More...

	getTimestamp ()
	Timestamp used for {{CURRENTDAY}} etc. More...

	getUser ()
	Current user. More...

	isSafeToCache ()
	Test whether these options are safe to cache. More...

	matches (ParserOptions $other)
	Check if these options match that of another options set. More...

	optionsHash ( $forOptions, $title=null)
	Generate a hash string with the values set on these ParserOptions for the keys given in the array. More...

	optionUsed ( $optionName)
	Called when an option is accessed. More...

	registerWatcher ( $callback)
	Registers a callback for tracking which ParserOptions which are used. More...

	setEditSection ( $x)
	Create "edit section" links? More...

	setRedirectTarget ( $title)
	Set the redirect target. More...

	setTimestamp ( $x)
	Timestamp used for {{CURRENTDAY}} etc. More...

	setupFakeRevision ( $title, $content, $user)
	Sets a hook to force that a page exists, and sets a current revision callback to return a revision with custom content when the current revision of the page is requested. More...

Static Public Member Functions
static	allCacheVaryingOptions ()
	Return all option keys that vary the options hash. More...

static	newCanonical ( $context=null, $userLang=null)
	Creates a "canonical" ParserOptions object. More...

static	newFromAnon ()
	Get a ParserOptions object for an anonymous user. More...

static	newFromContext (IContextSource $context)
	Get a ParserOptions object from a IContextSource object. More...

static	newFromUser ( $user)
	Get a ParserOptions object from a given user. More...

static	newFromUserAndLang (User $user, Language $lang)
	Get a ParserOptions object from a given user and language. More...

Public Attributes
const	HAS_NEWCANONICAL_FROM_CONTEXT = 1
	Flag indicating that newCanonical() accepts an IContextSource or the string 'canonical', for back-compat checks from extensions. More...

Private Member Functions
	initialiseFromUser ( $user, $lang)
	Get user options. More...

	optionToString ( $value)
	Convert an option to a string value. More...

Static Private Member Functions
static	getCanonicalOverrides ()
	Get "canonical" non-default option values. More...

static	getDefaults ()
	Get default option values. More...

Private Attributes
	$mExtraKey = ''
	Appended to the options hash. More...

string null	$mTimestamp
	Timestamp used for {{CURRENTDAY}} etc. More...

User	$mUser
	Stored user object. More...

callable null	$onAccessCallback = null
	Function to be called when an option is accessed. More...

array	$options
	Current values for all options that are relevant for caching. More...

Title null	$redirectTarget = null
	If the page being parsed is a redirect, this should hold the redirect target. More...

Static Private Attributes
static array null	$defaults = null
	Default values for all options that are relevant for caching. More...

static array	$inCacheKey
	Specify options that are included in the cache key. More...

static callable[]	$lazyOptions
	Lazy-loaded options. More...

Option accessors
	getOption ( $name)
	Fetch an option, generically. More...

	setOption ( $name, $value)
	Set an option, generically. More...

	getInterwikiMagic ()
	Whether to extract interlanguage links. More...

	setInterwikiMagic ( $x)
	Specify whether to extract interlanguage links. More...

	getAllowExternalImages ()
	Allow all external images inline? More...

	setAllowExternalImages ( $x)
	Allow all external images inline? More...

	getAllowExternalImagesFrom ()
	External images to allow. More...

	setAllowExternalImagesFrom ( $x)
	External images to allow. More...

	getEnableImageWhitelist ()
	Use the on-wiki external image whitelist? More...

	setEnableImageWhitelist ( $x)
	Use the on-wiki external image whitelist? More...

	getNumberHeadings ()
	Automatically number headings? More...

	setNumberHeadings ( $x)
	Automatically number headings? More...

	getAllowSpecialInclusion ()
	Allow inclusion of special pages? More...

	setAllowSpecialInclusion ( $x)
	Allow inclusion of special pages? More...

	getTidy ()
	Use tidy to cleanup output HTML? More...

	setTidy ( $x)
	Use tidy to cleanup output HTML? More...

	getInterfaceMessage ()
	Parsing an interface message? More...

	setInterfaceMessage ( $x)
	Parsing an interface message? More...

	getTargetLanguage ()
	Target language for the parse. More...

	setTargetLanguage ( $x)
	Target language for the parse. More...

	getMaxIncludeSize ()
	Maximum size of template expansions, in bytes. More...

	setMaxIncludeSize ( $x)
	Maximum size of template expansions, in bytes. More...

	getMaxPPNodeCount ()
	Maximum number of nodes touched by PPFrame::expand() More...

	setMaxPPNodeCount ( $x)
	Maximum number of nodes touched by PPFrame::expand() More...

	getMaxGeneratedPPNodeCount ()
	Maximum number of nodes generated by Preprocessor::preprocessToObj() More...

	setMaxGeneratedPPNodeCount ( $x)
	Maximum number of nodes generated by Preprocessor::preprocessToObj() More...

	getMaxPPExpandDepth ()
	Maximum recursion depth in PPFrame::expand() More...

	getMaxTemplateDepth ()
	Maximum recursion depth for templates within templates. More...

	setMaxTemplateDepth ( $x)
	Maximum recursion depth for templates within templates. More...

	getExpensiveParserFunctionLimit ()
	Maximum number of calls per parse to expensive parser functions. More...

	setExpensiveParserFunctionLimit ( $x)
	Maximum number of calls per parse to expensive parser functions. More...

	getRemoveComments ()
	Remove HTML comments. More...

	setRemoveComments ( $x)
	Remove HTML comments. More...

	getEnableLimitReport ()
	Enable limit report in an HTML comment on output. More...

	enableLimitReport ( $x=true)
	Enable limit report in an HTML comment on output. More...

	getCleanSignatures ()
	Clean up signature texts? More...

	setCleanSignatures ( $x)
	Clean up signature texts? More...

	getExternalLinkTarget ()
	Target attribute for external links. More...

	setExternalLinkTarget ( $x)
	Target attribute for external links. More...

	getDisableContentConversion ()
	Whether content conversion should be disabled. More...

	disableContentConversion ( $x=true)
	Whether content conversion should be disabled. More...

	getDisableTitleConversion ()
	Whether title conversion should be disabled. More...

	disableTitleConversion ( $x=true)
	Whether title conversion should be disabled. More...

	getThumbSize ()
	Thumb size preferred by the user. More...

	setThumbSize ( $x)
	Thumb size preferred by the user. More...

	getStubThreshold ()
	Thumb size preferred by the user. More...

	setStubThreshold ( $x)
	Thumb size preferred by the user. More...

	getIsPreview ()
	Parsing the page for a "preview" operation? More...

	setIsPreview ( $x)
	Parsing the page for a "preview" operation? More...

	getIsSectionPreview ()
	Parsing the page for a "preview" operation on a single section? More...

	setIsSectionPreview ( $x)
	Parsing the page for a "preview" operation on a single section? More...

	getIsPrintable ()
	Parsing the printable version of the page? More...

	setIsPrintable ( $x)
	Parsing the printable version of the page? More...

	getPreSaveTransform ()
	Transform wiki markup when saving the page? More...

	setPreSaveTransform ( $x)
	Transform wiki markup when saving the page? More...

	getDateFormat ()
	Date format index. More...

	setDateFormat ( $x)
	Date format index. More...

	getUserLangObj ()
	Get the user language used by the parser for this page and split the parser cache. More...

	getUserLang ()
	Same as getUserLangObj() but returns a string instead. More...

	setUserLang ( $x)
	Set the user language used by the parser for this page and split the parser cache. More...

	getMagicISBNLinks ()
	Are magic ISBN links enabled? More...

	getMagicPMIDLinks ()
	Are magic PMID links enabled? More...

	getMagicRFCLinks ()
	Are magic RFC links enabled? More...

	getAllowUnsafeRawHtml ()
	If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page. More...

	setAllowUnsafeRawHtml ( $x)
	If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page. More...

	getWrapOutputClass ()
	Class to use to wrap output from Parser::parse() More...

	setWrapOutputClass ( $className)
	CSS class to use to wrap output from Parser::parse() More...

	getCurrentRevisionCallback ()
	Callback for current revision fetching; first argument to call_user_func(). More...

	setCurrentRevisionCallback ( $x)
	Callback for current revision fetching; first argument to call_user_func(). More...

	getTemplateCallback ()
	Callback for template fetching; first argument to call_user_func(). More...

	setTemplateCallback ( $x)
	Callback for template fetching; first argument to call_user_func(). More...

	getSpeculativeRevId ()
	A guess for {{REVISIONID}}, calculated using the callback provided via setSpeculativeRevIdCallback(). More...

	getSpeculativeRevIdCallback ()
	Callback to generate a guess for {{REVISIONID}}. More...

	setSpeculativeRevIdCallback ( $x)
	Callback to generate a guess for {{REVISIONID}}. More...

	setOptionLegacy ( $name, $value)
	Legacy implementation. More...

static	initDateFormat (ParserOptions $popt)
	Lazy initializer for dateFormat. More...

static	initSpeculativeRevId (ParserOptions $popt)
	Callback registered with ParserOptions::$lazyOptions, triggered by getSpeculativeRevId(). More...

Detailed Description

Set options of the Parser.

How to add an option in core:

Add it to one of the arrays in ParserOptions::setDefaults()
If necessary, add an entry to ParserOptions::$inCacheKey
Add a getter and setter in the section for that.

How to add an option in an extension:

Use the 'ParserOptionsRegister' hook to register it.
Where necessary, use $popt->getOption() and $popt->setOption() to access it.

Definition at line 42 of file ParserOptions.php.

Constructor & Destructor Documentation

◆ __construct()

ParserOptions::__construct	(	$user = `null`,
		$lang = `null`
	)

Warning: For interaction with the parser cache, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Parameters

User \| null	$user
Language \| null	$lang

Definition at line 978 of file ParserOptions.php.

References $lang, $user, $wgLang, initialiseFromUser(), StubObject\isRealObject(), and User.

Member Function Documentation

◆ addExtraKey()

ParserOptions::addExtraKey ( $key )

Extra key that should be present in the parser cache key.

Warning: Consider registering your additional options with the ParserOptionsRegister hook instead of using this method.

Parameters

string $key

Definition at line 960 of file ParserOptions.php.

◆ allCacheVaryingOptions()

static ParserOptions::allCacheVaryingOptions ( )

static

Return all option keys that vary the options hash.

Since: 1.30

Returns: string[]

Definition at line 1269 of file ParserOptions.php.

References getDefaults().

Referenced by WikitextContent\fillParserOutput(), ParserCache\getETag(), ParserCache\getKey(), optionsHash(), and ParserOptionsTest\testAllCacheVaryingOptions().

◆ disableContentConversion()

ParserOptions::disableContentConversion ( $x = true )

Whether content conversion should be disabled.

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 520 of file ParserOptions.php.

References setOptionLegacy().

◆ disableTitleConversion()

ParserOptions::disableTitleConversion ( $x = true )

Whether title conversion should be disabled.

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 537 of file ParserOptions.php.

References setOptionLegacy().

◆ enableLimitReport()

ParserOptions::enableLimitReport ( $x = true )

Enable limit report in an HTML comment on output.

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 467 of file ParserOptions.php.

References setOptionLegacy().

Referenced by ParserMethodsTest\testRevisionAccess().

◆ getAllowExternalImages()

ParserOptions::getAllowExternalImages ( )

Allow all external images inline?

Returns: bool

Definition at line 202 of file ParserOptions.php.

References getOption().

◆ getAllowExternalImagesFrom()

ParserOptions::getAllowExternalImagesFrom ( )

External images to allow.

When self::getAllowExternalImages() is false

Returns: string|string[] URLs to allow

Definition at line 222 of file ParserOptions.php.

References getOption().

◆ getAllowSpecialInclusion()

ParserOptions::getAllowSpecialInclusion ( )

Allow inclusion of special pages?

Returns: bool

Definition at line 276 of file ParserOptions.php.

References getOption().

◆ getAllowUnsafeRawHtml()

ParserOptions::getAllowUnsafeRawHtml ( )

If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page.

This is meant to disable unsafe parser tags in cases where a malicious user may control the input to the parser.

Note: This is expected to be true for normal pages even if the wiki has $wgRawHtml disabled in general. The setting only signifies that raw html would be unsafe in the current context provided that raw html is allowed at all.

Since: 1.29

Returns: bool

Definition at line 760 of file ParserOptions.php.

References getOption().

◆ getCanonicalOverrides()

static ParserOptions::getCanonicalOverrides ( )

staticprivate

Get "canonical" non-default option values.

See also: self::newCanonical

Warning: If you change the override for an existing option, all existing parser cache entries will be invalid. To avoid bugs, you'll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you.

Returns: array

Definition at line 1166 of file ParserOptions.php.

References $wgEnableParserLimitReporting.

Referenced by isSafeToCache(), and optionsHash().

◆ getCleanSignatures()

ParserOptions::getCleanSignatures ( )

Clean up signature texts?

See also: Parser::cleanSig

Returns: bool

Definition at line 476 of file ParserOptions.php.

References getOption().

◆ getCurrentRevisionCallback()

ParserOptions::getCurrentRevisionCallback ( )

Callback for current revision fetching; first argument to call_user_func().

Since: 1.24

Returns: callable

Definition at line 807 of file ParserOptions.php.

References getOption().

◆ getDateFormat()

ParserOptions::getDateFormat ( )

Date format index.

Returns: string

Definition at line 647 of file ParserOptions.php.

References getOption().

◆ getDefaults()

static ParserOptions::getDefaults ( )

staticprivate

Get default option values.

Warning: If you change the default for an existing option (unless it's being overridden by self::getCanonicalOverrides()), all existing parser cache entries will be invalid. To avoid bugs, you'll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you.

Returns: array

Definition at line 1092 of file ParserOptions.php.

References $wgAllowExternalImages, $wgAllowExternalImagesFrom, $wgAllowSpecialInclusion, $wgCleanSignatures, $wgDisableLangConversion, $wgDisableTitleConversion, $wgEnableImageWhitelist, $wgEnableMagicLinks, $wgExpensiveParserFunctionLimit, $wgExternalLinkTarget, $wgInterwikiMagic, $wgMaxArticleSize, $wgMaxGeneratedPPNodeCount, $wgMaxPPExpandDepth, $wgMaxPPNodeCount, $wgMaxTemplateDepth, class, User\getDefaultOption(), and Hooks\run().

Referenced by allCacheVaryingOptions(), initialiseFromUser(), isSafeToCache(), and optionsHash().

◆ getDisableContentConversion()

ParserOptions::getDisableContentConversion ( )

Whether content conversion should be disabled.

Returns: bool

Definition at line 511 of file ParserOptions.php.

References getOption().

◆ getDisableTitleConversion()

ParserOptions::getDisableTitleConversion ( )

Whether title conversion should be disabled.

Returns: bool

Definition at line 528 of file ParserOptions.php.

References getOption().

◆ getEditSection()

ParserOptions::getEditSection ( )

Create "edit section" links?

Deprecated:: since 1.31, use ParserOutput::getText() options instead.

Returns: bool

Definition at line 914 of file ParserOptions.php.

References wfDeprecated().

◆ getEnableImageWhitelist()

ParserOptions::getEnableImageWhitelist ( )

Use the on-wiki external image whitelist?

Returns: bool

Definition at line 242 of file ParserOptions.php.

References getOption().

◆ getEnableLimitReport()

ParserOptions::getEnableLimitReport ( )

Enable limit report in an HTML comment on output.

Returns: bool

Definition at line 458 of file ParserOptions.php.

References getOption().

◆ getExpensiveParserFunctionLimit()

ParserOptions::getExpensiveParserFunctionLimit ( )

Maximum number of calls per parse to expensive parser functions.

Since: 1.20

Returns: int

Definition at line 421 of file ParserOptions.php.

References getOption().

◆ getExternalLinkTarget()

ParserOptions::getExternalLinkTarget ( )

Target attribute for external links.

Returns: string

Definition at line 494 of file ParserOptions.php.

References getOption().

◆ getInterfaceMessage()

ParserOptions::getInterfaceMessage ( )

Parsing an interface message?

Returns: bool

Definition at line 310 of file ParserOptions.php.

References getOption().

◆ getInterwikiMagic()

ParserOptions::getInterwikiMagic ( )

Whether to extract interlanguage links.

When true, interlanguage links will be returned by ParserOutput::getLanguageLinks() instead of generating link HTML.

Returns: bool

Definition at line 185 of file ParserOptions.php.

References getOption().

◆ getIsPreview()

ParserOptions::getIsPreview ( )

Parsing the page for a "preview" operation?

Returns: bool

Definition at line 579 of file ParserOptions.php.

References getOption().

◆ getIsPrintable()

ParserOptions::getIsPrintable ( )

Parsing the printable version of the page?

Returns: bool

Definition at line 613 of file ParserOptions.php.

References getOption().

◆ getIsSectionPreview()

ParserOptions::getIsSectionPreview ( )

Parsing the page for a "preview" operation on a single section?

Returns: bool

Definition at line 596 of file ParserOptions.php.

References getOption().

◆ getMagicISBNLinks()

ParserOptions::getMagicISBNLinks ( )

Are magic ISBN links enabled?

Since: 1.28

Returns: bool

Definition at line 724 of file ParserOptions.php.

References getOption().

◆ getMagicPMIDLinks()

ParserOptions::getMagicPMIDLinks ( )

Are magic PMID links enabled?

Since: 1.28

Returns: bool

Definition at line 733 of file ParserOptions.php.

References getOption().

◆ getMagicRFCLinks()

ParserOptions::getMagicRFCLinks ( )

Are magic RFC links enabled?

Since: 1.28

Returns: bool

Definition at line 742 of file ParserOptions.php.

References getOption().

◆ getMaxGeneratedPPNodeCount()

ParserOptions::getMaxGeneratedPPNodeCount ( )

Maximum number of nodes generated by Preprocessor::preprocessToObj()

Returns: int

Definition at line 378 of file ParserOptions.php.

References getOption().

◆ getMaxIncludeSize()

ParserOptions::getMaxIncludeSize ( )

Maximum size of template expansions, in bytes.

Returns: int

Definition at line 344 of file ParserOptions.php.

References getOption().

◆ getMaxPPExpandDepth()

ParserOptions::getMaxPPExpandDepth ( )

Maximum recursion depth in PPFrame::expand()

Returns: int

Definition at line 395 of file ParserOptions.php.

References getOption().

◆ getMaxPPNodeCount()

ParserOptions::getMaxPPNodeCount ( )

Maximum number of nodes touched by PPFrame::expand()

Returns: int

Definition at line 361 of file ParserOptions.php.

References getOption().

◆ getMaxTemplateDepth()

ParserOptions::getMaxTemplateDepth ( )

Maximum recursion depth for templates within templates.

Returns: int

Definition at line 403 of file ParserOptions.php.

References getOption().

◆ getNumberHeadings()

ParserOptions::getNumberHeadings ( )

Automatically number headings?

Returns: bool

Definition at line 259 of file ParserOptions.php.

References getOption().

◆ getOption()

ParserOptions::getOption ( $name )

Fetch an option, generically.

Since: 1.30

Parameters

string $name Option name

Returns: mixed

Definition at line 131 of file ParserOptions.php.

References $name, options(), and optionUsed().

Referenced by getAllowExternalImages(), getAllowExternalImagesFrom(), getAllowSpecialInclusion(), getAllowUnsafeRawHtml(), getCleanSignatures(), getCurrentRevisionCallback(), getDateFormat(), getDisableContentConversion(), getDisableTitleConversion(), getEnableImageWhitelist(), getEnableLimitReport(), getExpensiveParserFunctionLimit(), getExternalLinkTarget(), getInterfaceMessage(), getInterwikiMagic(), getIsPreview(), getIsPrintable(), getIsSectionPreview(), getMagicISBNLinks(), getMagicPMIDLinks(), getMagicRFCLinks(), getMaxGeneratedPPNodeCount(), getMaxIncludeSize(), getMaxPPExpandDepth(), getMaxPPNodeCount(), getMaxTemplateDepth(), getNumberHeadings(), getPreSaveTransform(), getRemoveComments(), getSpeculativeRevId(), getSpeculativeRevIdCallback(), getStubThreshold(), getTargetLanguage(), getTemplateCallback(), getThumbSize(), getTidy(), getUserLangObj(), getWrapOutputClass(), and initSpeculativeRevId().

◆ getPreSaveTransform()

ParserOptions::getPreSaveTransform ( )

Transform wiki markup when saving the page?

Returns: bool

Definition at line 630 of file ParserOptions.php.

References getOption().

◆ getRedirectTarget()

ParserOptions::getRedirectTarget ( )

Get the previously-set redirect target.

Since: 1.24

Returns: Title|null

Definition at line 950 of file ParserOptions.php.

References $redirectTarget.

◆ getRemoveComments()

ParserOptions::getRemoveComments ( )

Remove HTML comments.

Warning: Only applies to preprocess operations

Returns: bool

Definition at line 440 of file ParserOptions.php.

References getOption().

◆ getSpeculativeRevId()

ParserOptions::getSpeculativeRevId ( )

A guess for {{REVISIONID}}, calculated using the callback provided via setSpeculativeRevIdCallback().

For consistency, the value will be calculated upon the first call of this method, and re-used for subsequent calls.

If no callback was defined via setSpeculativeRevIdCallback(), this method will return false.

Since: 1.32

Returns: int|false

Definition at line 848 of file ParserOptions.php.

References getOption().

◆ getSpeculativeRevIdCallback()

ParserOptions::getSpeculativeRevIdCallback ( )

Callback to generate a guess for {{REVISIONID}}.

Since: 1.28

Deprecated:: since 1.32, use getSpeculativeRevId() instead!

Returns: callable|null

Definition at line 872 of file ParserOptions.php.

References getOption().

◆ getStubThreshold()

ParserOptions::getStubThreshold ( )

Thumb size preferred by the user.

Returns: int

Definition at line 562 of file ParserOptions.php.

References getOption().

Referenced by WikiPage\getParserOutput(), and WikiPage\shouldCheckParserCache().

◆ getTargetLanguage()

ParserOptions::getTargetLanguage ( )

Target language for the parse.

Returns: Language|null

Definition at line 327 of file ParserOptions.php.

References getOption().

◆ getTemplateCallback()

ParserOptions::getTemplateCallback ( )

Callback for template fetching; first argument to call_user_func().

Returns: callable

Definition at line 825 of file ParserOptions.php.

References getOption().

◆ getThumbSize()

ParserOptions::getThumbSize ( )

Thumb size preferred by the user.

Returns: int

Definition at line 545 of file ParserOptions.php.

References getOption().

◆ getTidy()

ParserOptions::getTidy ( )

Use tidy to cleanup output HTML?

Returns: bool

Definition at line 293 of file ParserOptions.php.

References getOption().

◆ getTimestamp()

ParserOptions::getTimestamp ( )

Timestamp used for {{CURRENTDAY}} etc.

Returns: string

Definition at line 893 of file ParserOptions.php.

References $mTimestamp, and wfTimestampNow().

◆ getUser()

ParserOptions::getUser ( )

Current user.

Returns: User

Definition at line 968 of file ParserOptions.php.

References $mUser.

Referenced by optionsHash(), and ParserMethodsTest\testRevisionAccess().

◆ getUserLang()

ParserOptions::getUserLang ( )

Same as getUserLangObj() but returns a string instead.

Warning: Calling this causes the parser cache to be fragmented by user language! To avoid cache fragmentation, output should not depend on the user language. Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!

See also: getUserLangObj()

Returns: string Language code

Since: 1.17

Definition at line 702 of file ParserOptions.php.

References getUserLangObj().

◆ getUserLangObj()

ParserOptions::getUserLangObj ( )

Get the user language used by the parser for this page and split the parser cache.

Warning: Calling this causes the parser cache to be fragmented by user language! To avoid cache fragmentation, output should not depend on the user language. Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!

Note: This function will trigger a cache fragmentation by recording the 'userlang' option, see optionUsed(). This is done to avoid cache pollution when the page is rendered based on the language of the user.; When saving, this will return the default language instead of the user's. {{int: }} uses this which used to produce inconsistent link tables (T16404).

Returns: Language

Since: 1.19

Definition at line 686 of file ParserOptions.php.

References getOption().

Referenced by getUserLang().

◆ getWrapOutputClass()

ParserOptions::getWrapOutputClass ( )

Class to use to wrap output from Parser::parse()

Since: 1.30

Returns: string|bool

Definition at line 781 of file ParserOptions.php.

References getOption().

◆ initDateFormat()

static ParserOptions::initDateFormat ( ParserOptions $popt )

staticprivate

Lazy initializer for dateFormat.

Parameters

ParserOptions $popt

Returns: string

Definition at line 656 of file ParserOptions.php.

◆ initialiseFromUser()

ParserOptions::initialiseFromUser	(	$user,
		$lang
	)

private

Get user options.

Parameters

User	$user
Language	$lang

Definition at line 1180 of file ParserOptions.php.

References $lang, $user, getDefaults(), and options().

Referenced by __construct().

◆ initSpeculativeRevId()

static ParserOptions::initSpeculativeRevId ( ParserOptions $popt )

staticprivate

Callback registered with ParserOptions::$lazyOptions, triggered by getSpeculativeRevId().

Parameters

ParserOptions $popt

Returns: bool|false

Definition at line 858 of file ParserOptions.php.

References getOption().

◆ isSafeToCache()

ParserOptions::isSafeToCache ( )

Test whether these options are safe to cache.

Since: 1.30

Returns: bool

Definition at line 1372 of file ParserOptions.php.

References $defaults, $value, as, getCanonicalOverrides(), getDefaults(), options(), and optionToString().

Referenced by WikiPage\getParserOutput().

◆ matches()

ParserOptions::matches ( ParserOptions $other )

Check if these options match that of another options set.

This ignores report limit settings that only affect HTML comments

Parameters

ParserOptions $other

Returns: bool

Since: 1.25

Definition at line 1199 of file ParserOptions.php.

References $name, $options, as, options(), and optionToString().

◆ newCanonical()

static ParserOptions::newCanonical	(	$context = `null`,
		$userLang = `null`
	)

static

Creates a "canonical" ParserOptions object.

For historical reasons, certain options have default values that are different from the canonical values used for caching.

Since: 1.30; 1.32 Added string and IContextSource as options for the first parameter

Parameters

IContextSource \| string \| User \| null	$context	If an IContextSource, the options are initialized based on the source's User and Language. If the string 'canonical', the options are initialized with an anonymous user and the content language. If a User or null, the options are initialized for that User (or $wgUser if null). 'userlang' is taken from the $userLang parameter, defaulting to $wgLang if that is null.
Language \| StubObject \| null	$userLang	(see above)

Returns: ParserOptions

Definition at line 1064 of file ParserOptions.php.

References $context, $ret, as, newFromAnon(), and newFromContext().

◆ newFromAnon()

static ParserOptions::newFromAnon ( )

static

Get a ParserOptions object for an anonymous user.

Warning: For interaction with the parser cache, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Since: 1.27

Returns: ParserOptions

Definition at line 1004 of file ParserOptions.php.

Referenced by MessageCache\getParserOptions(), and newCanonical().

◆ newFromContext()

static ParserOptions::newFromContext ( IContextSource $context )

static

Get a ParserOptions object from a IContextSource object.

Warning: For interaction with the parser cache, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Parameters

IContextSource $context

Returns: ParserOptions

Definition at line 1043 of file ParserOptions.php.

References $context.

Referenced by ApiExpandTemplates\execute(), SpecialExpandTemplates\execute(), ApiQueryRevisionsBase\extractDeprecatedContent(), SpecialExpandTemplates\generateHtml(), ApiComparePages\getDiffRevision(), RawAction\getRawText(), newCanonical(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ newFromUser()

static ParserOptions::newFromUser ( $user )

static

Get a ParserOptions object from a given user.

Language will be taken from $wgLang.

Warning: For interaction with the parser cache, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Parameters

User $user

Returns: ParserOptions

Definition at line 1018 of file ParserOptions.php.

References $user.

Referenced by CompareParsers\checkOptions(), PPFuzzTest\execute(), ParserFuzzTest\fuzzTest(), ParserCache\getKey(), SpecialCiteThisPage\getParserOptions(), EditPage\getPreloadedContent(), DumpRenderer\handleRevision(), ExtraParserTest\testLongNumericLinesDontKillTheParser(), ParserMethodsTest\testPreSaveTransform(), and ExtraParserTest\testSpecialPageTransclusionRestoresGlobalState().

◆ newFromUserAndLang()

static ParserOptions::newFromUserAndLang	(	User	$user,
		Language	$lang
	)

static

Get a ParserOptions object from a given user and language.

Warning: For interaction with the parser cache, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Parameters

User	$user
Language	$lang

Returns: ParserOptions

Definition at line 1031 of file ParserOptions.php.

References $lang, and $user.

Referenced by EditPage\getContentObject(), TagHooksTest\getParserOptions(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), ExtraParserTest\setUp(), MagicVariableTest\setUp(), PreprocessorTest\setUp(), ParserPreloadTest\setUp(), EditPage\showDiff(), TextContentTest\testPreloadTransform(), and TextContentTest\testPreSaveTransform().

◆ optionsHash()

ParserOptions::optionsHash	(	$forOptions,
		$title = `null`
	)

Generate a hash string with the values set on these ParserOptions for the keys given in the array.

This will be used as part of the hash key for the parser cache, so users sharing the options with vary for the same page share the same cached data safely.

Since: 1.17

Parameters

string[]	$forOptions
Title \| null	$title	Used to get the content language of the page (since r97636)

Returns: string Page rendering hash

Definition at line 1311 of file ParserOptions.php.

References $defaults, $inCacheKey, $mExtraKey, $options, $title, $wgRenderHashAppend, allCacheVaryingOptions(), as, getCanonicalOverrides(), getDefaults(), getUser(), options(), optionToString(), and Hooks\run().

◆ optionToString()

ParserOptions::optionToString ( $value )

private

Convert an option to a string value.

Parameters

mixed $value

Returns: string

Definition at line 1283 of file ParserOptions.php.

References $value.

Referenced by isSafeToCache(), matches(), and optionsHash().

◆ optionUsed()

ParserOptions::optionUsed ( $optionName )

Called when an option is accessed.

Calls the watcher that was set using registerWatcher(). Typically, the watcher callback is ParserOutput::registerOption(). The information registered that way will be used by ParserCache::save().

Parameters

string $optionName Name of the option

Definition at line 1258 of file ParserOptions.php.

Referenced by getOption().

◆ registerWatcher()

ParserOptions::registerWatcher ( $callback )

Registers a callback for tracking which ParserOptions which are used.

This is a private API with the parser.

Parameters

callable $callback

Definition at line 1246 of file ParserOptions.php.

◆ setAllowExternalImages()

ParserOptions::setAllowExternalImages ( $x )

Allow all external images inline?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 211 of file ParserOptions.php.

References setOptionLegacy().

◆ setAllowExternalImagesFrom()

ParserOptions::setAllowExternalImagesFrom ( $x )

External images to allow.

When self::getAllowExternalImages() is false

Parameters

string | string[] | null $x New value (null is no change)

Returns: string|string[] Old value

Definition at line 234 of file ParserOptions.php.

References setOptionLegacy().

◆ setAllowSpecialInclusion()

ParserOptions::setAllowSpecialInclusion ( $x )

Allow inclusion of special pages?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 285 of file ParserOptions.php.

References setOptionLegacy().

◆ setAllowUnsafeRawHtml()

ParserOptions::setAllowUnsafeRawHtml ( $x )

If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page.

See also: self::getAllowUnsafeRawHtml()

Since: 1.29

Parameters

bool | null $x Value to set or null to get current value

Returns: bool Current value for allowUnsafeRawHtml

Definition at line 772 of file ParserOptions.php.

References setOptionLegacy().

Referenced by MessageCache\getParserOptions().

◆ setCleanSignatures()

ParserOptions::setCleanSignatures ( $x )

Clean up signature texts?

See also: Parser::cleanSig

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 486 of file ParserOptions.php.

References setOptionLegacy().

◆ setCurrentRevisionCallback()

ParserOptions::setCurrentRevisionCallback ( $x )

Callback for current revision fetching; first argument to call_user_func().

Since: 1.24

Parameters

callable | null $x New value (null is no change)

Returns: callable Old value

Definition at line 817 of file ParserOptions.php.

References setOptionLegacy().

Referenced by setupFakeRevision().

◆ setDateFormat()

ParserOptions::setDateFormat ( $x )

Date format index.

Parameters

string | null $x New value (null is no change)

Returns: string Old value

Definition at line 665 of file ParserOptions.php.

References setOptionLegacy().

◆ setEditSection()

ParserOptions::setEditSection ( $x )

Create "edit section" links?

Deprecated:: since 1.31, use ParserOutput::getText() options instead.

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 925 of file ParserOptions.php.

References wfDeprecated().

◆ setEnableImageWhitelist()

ParserOptions::setEnableImageWhitelist ( $x )

Use the on-wiki external image whitelist?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 251 of file ParserOptions.php.

References setOptionLegacy().

◆ setExpensiveParserFunctionLimit()

ParserOptions::setExpensiveParserFunctionLimit ( $x )

Maximum number of calls per parse to expensive parser functions.

Since: 1.20

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 431 of file ParserOptions.php.

References setOptionLegacy().

◆ setExternalLinkTarget()

ParserOptions::setExternalLinkTarget ( $x )

Target attribute for external links.

Parameters

string | null $x New value (null is no change)

Returns: string Old value

Definition at line 503 of file ParserOptions.php.

References setOptionLegacy().

◆ setInterfaceMessage()

ParserOptions::setInterfaceMessage ( $x )

Parsing an interface message?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 319 of file ParserOptions.php.

References setOptionLegacy().

◆ setInterwikiMagic()

ParserOptions::setInterwikiMagic ( $x )

Specify whether to extract interlanguage links.

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 194 of file ParserOptions.php.

References setOptionLegacy().

◆ setIsPreview()

ParserOptions::setIsPreview ( $x )

Parsing the page for a "preview" operation?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 588 of file ParserOptions.php.

References setOptionLegacy().

◆ setIsPrintable()

ParserOptions::setIsPrintable ( $x )

Parsing the printable version of the page?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 622 of file ParserOptions.php.

References setOptionLegacy().

◆ setIsSectionPreview()

ParserOptions::setIsSectionPreview ( $x )

Parsing the page for a "preview" operation on a single section?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 605 of file ParserOptions.php.

References setOptionLegacy().

◆ setMaxGeneratedPPNodeCount()

ParserOptions::setMaxGeneratedPPNodeCount ( $x )

Maximum number of nodes generated by Preprocessor::preprocessToObj()

Parameters

int | null $x New value (null is no change)

Returns: int

Definition at line 387 of file ParserOptions.php.

References setOptionLegacy().

◆ setMaxIncludeSize()

ParserOptions::setMaxIncludeSize ( $x )

Maximum size of template expansions, in bytes.

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 353 of file ParserOptions.php.

References setOptionLegacy().

◆ setMaxPPNodeCount()

ParserOptions::setMaxPPNodeCount ( $x )

Maximum number of nodes touched by PPFrame::expand()

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 370 of file ParserOptions.php.

References setOptionLegacy().

◆ setMaxTemplateDepth()

ParserOptions::setMaxTemplateDepth ( $x )

Maximum recursion depth for templates within templates.

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 412 of file ParserOptions.php.

References setOptionLegacy().

◆ setNumberHeadings()

ParserOptions::setNumberHeadings ( $x )

Automatically number headings?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 268 of file ParserOptions.php.

References setOptionLegacy().

◆ setOption()

ParserOptions::setOption	(	$name,
		$value
	)

Set an option, generically.

Since: 1.30

Parameters

string	$name	Option name
mixed	$value	New value. Passing null will set null, unlike many of the existing accessors which ignore null for historical reasons.

Returns: mixed Old value

Definition at line 153 of file ParserOptions.php.

References $name, $value, and options().

Referenced by setSpeculativeRevIdCallback(), setTargetLanguage(), and setWrapOutputClass().

◆ setOptionLegacy()

ParserOptions::setOptionLegacy	(	$name,
		$value
	)

protected

Legacy implementation.

Since: 1.30 For implementing legacy setters only. Don't use this in new code.

Deprecated:: since 1.30

Parameters

string	$name	Option name
mixed	$value	New value. Passing null does not set the value.

Returns: mixed Old value

Definition at line 170 of file ParserOptions.php.

References $name, $value, options(), and wfSetVar().

Referenced by disableContentConversion(), disableTitleConversion(), enableLimitReport(), setAllowExternalImages(), setAllowExternalImagesFrom(), setAllowSpecialInclusion(), setAllowUnsafeRawHtml(), setCleanSignatures(), setCurrentRevisionCallback(), setDateFormat(), setEnableImageWhitelist(), setExpensiveParserFunctionLimit(), setExternalLinkTarget(), setInterfaceMessage(), setInterwikiMagic(), setIsPreview(), setIsPrintable(), setIsSectionPreview(), setMaxGeneratedPPNodeCount(), setMaxIncludeSize(), setMaxPPNodeCount(), setMaxTemplateDepth(), setNumberHeadings(), setPreSaveTransform(), setRemoveComments(), setSpeculativeRevIdCallback(), setStubThreshold(), setTemplateCallback(), setThumbSize(), setTidy(), and setUserLang().

◆ setPreSaveTransform()

ParserOptions::setPreSaveTransform ( $x )

Transform wiki markup when saving the page?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 639 of file ParserOptions.php.

References setOptionLegacy().

◆ setRedirectTarget()

ParserOptions::setRedirectTarget ( $title )

Set the redirect target.

Note that setting or changing this does not make the page a redirect or change its target, it merely records the information for reference during the parse.

Since: 1.24

Parameters

Title | null $title

Definition at line 940 of file ParserOptions.php.

References $title.

◆ setRemoveComments()

ParserOptions::setRemoveComments ( $x )

Remove HTML comments.

Warning: Only applies to preprocess operations

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 450 of file ParserOptions.php.

References setOptionLegacy().

◆ setSpeculativeRevIdCallback()

ParserOptions::setSpeculativeRevIdCallback ( $x )

Callback to generate a guess for {{REVISIONID}}.

Since: 1.28

Parameters

callable | null $x New value (null is no change)

Returns: callable|null Old value

Definition at line 882 of file ParserOptions.php.

References setOption(), and setOptionLegacy().

◆ setStubThreshold()

ParserOptions::setStubThreshold ( $x )

Thumb size preferred by the user.

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 571 of file ParserOptions.php.

References setOptionLegacy().

◆ setTargetLanguage()

ParserOptions::setTargetLanguage ( $x )

Target language for the parse.

Parameters

Language | null $x New value

Returns: Language|null Old value

Definition at line 336 of file ParserOptions.php.

References setOption().

◆ setTemplateCallback()

ParserOptions::setTemplateCallback ( $x )

Callback for template fetching; first argument to call_user_func().

Parameters

callable | null $x New value (null is no change)

Returns: callable Old value

Definition at line 834 of file ParserOptions.php.

References setOptionLegacy().

◆ setThumbSize()

ParserOptions::setThumbSize ( $x )

Thumb size preferred by the user.

Parameters

int | null $x New value (null is no change)

Returns: int Old value

Definition at line 554 of file ParserOptions.php.

References setOptionLegacy().

◆ setTidy()

ParserOptions::setTidy ( $x )

Use tidy to cleanup output HTML?

Parameters

bool | null $x New value (null is no change)

Returns: bool Old value

Definition at line 302 of file ParserOptions.php.

References setOptionLegacy().

◆ setTimestamp()

ParserOptions::setTimestamp ( $x )

Timestamp used for {{CURRENTDAY}} etc.

Parameters

string | null $x New value (null is no change)

Returns: string Old value

Definition at line 905 of file ParserOptions.php.

References wfSetVar().

◆ setupFakeRevision()

ParserOptions::setupFakeRevision	(	$title,
		$content,
		$user
	)

Sets a hook to force that a page exists, and sets a current revision callback to return a revision with custom content when the current revision of the page is requested.

Since: 1.25

Parameters

Title	$title
Content	$content
User	$user	The user that the fake revision is attributed to

Returns: ScopedCallback to unset the hook

Definition at line 1396 of file ParserOptions.php.

References $content, $parser, $title, $user, $wgHooks, key, setCurrentRevisionCallback(), and use.

◆ setUserLang()

ParserOptions::setUserLang ( $x )

Set the user language used by the parser for this page and split the parser cache.

Parameters

string | Language $x New value

Returns: Language Old value

Definition at line 711 of file ParserOptions.php.

References Language\factory(), and setOptionLegacy().

◆ setWrapOutputClass()

ParserOptions::setWrapOutputClass ( $className )

CSS class to use to wrap output from Parser::parse()

Since: 1.30

Parameters

string $className Class name to use for wrapping. Passing false to indicate "no wrapping" was deprecated in MediaWiki 1.31.

Returns: string|bool Current value

Definition at line 792 of file ParserOptions.php.

References setOption(), and wfDeprecated().

Member Data Documentation

◆ $defaults

array null ParserOptions::$defaults = null

staticprivate

Default values for all options that are relevant for caching.

See also: self::getDefaults()

Definition at line 56 of file ParserOptions.php.

Referenced by isSafeToCache(), and optionsHash().

◆ $inCacheKey

array ParserOptions::$inCacheKey

staticprivate

Initial value:

= [
        'dateformat' => true,
        'numberheadings' => true,
        'thumbsize' => true,
        'stubthreshold' => true,
        'printable' => true,
        'userlang' => true,
    ]

Specify options that are included in the cache key.

Definition at line 71 of file ParserOptions.php.

Referenced by optionsHash().

◆ $lazyOptions

callable [] ParserOptions::$lazyOptions

staticprivate

Initial value:

= [
        'dateformat' => [ __CLASS__, 'initDateFormat' ],
        'speculativeRevId' => [ __CLASS__, 'initSpeculativeRevId' ],
    ]

Lazy-loaded options.

Definition at line 62 of file ParserOptions.php.

◆ $mExtraKey

ParserOptions::$mExtraKey = ''

private

Appended to the options hash.

Definition at line 118 of file ParserOptions.php.

Referenced by optionsHash().

◆ $mTimestamp

string null ParserOptions::$mTimestamp

private

Timestamp used for {{CURRENTDAY}} etc.

Note: Caching based on parse time is handled externally

Definition at line 91 of file ParserOptions.php.

Referenced by getTimestamp().

◆ $mUser

User ParserOptions::$mUser

private

Stored user object.

Todo:: Track this for caching somehow without fragmenting the cache insanely

Definition at line 98 of file ParserOptions.php.

Referenced by getUser().

◆ $onAccessCallback

callable null ParserOptions::$onAccessCallback = null

private

Function to be called when an option is accessed.

Note: Used for collecting used options, does not affect caching

Definition at line 105 of file ParserOptions.php.

◆ $options

array ParserOptions::$options

private

Current values for all options that are relevant for caching.

Definition at line 84 of file ParserOptions.php.

Referenced by matches(), and optionsHash().

◆ $redirectTarget

Title null ParserOptions::$redirectTarget = null

private

If the page being parsed is a redirect, this should hold the redirect target.

Todo:: Track this for caching somehow

Definition at line 113 of file ParserOptions.php.

Referenced by getRedirectTarget().

◆ HAS_NEWCANONICAL_FROM_CONTEXT

const ParserOptions::HAS_NEWCANONICAL_FROM_CONTEXT = 1

Flag indicating that newCanonical() accepts an IContextSource or the string 'canonical', for back-compat checks from extensions.

Since: 1.32

Definition at line 49 of file ParserOptions.php.

The documentation for this class was generated from the following file:

includes/parser/ParserOptions.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Option accessors

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExtraKey()

◆ allCacheVaryingOptions()

◆ disableContentConversion()

◆ disableTitleConversion()

◆ enableLimitReport()

◆ getAllowExternalImages()

◆ getAllowExternalImagesFrom()

◆ getAllowSpecialInclusion()

◆ getAllowUnsafeRawHtml()

◆ getCanonicalOverrides()

◆ getCleanSignatures()

◆ getCurrentRevisionCallback()

◆ getDateFormat()

◆ getDefaults()

◆ getDisableContentConversion()

◆ getDisableTitleConversion()

◆ getEditSection()

◆ getEnableImageWhitelist()

◆ getEnableLimitReport()

◆ getExpensiveParserFunctionLimit()

◆ getExternalLinkTarget()

◆ getInterfaceMessage()

◆ getInterwikiMagic()

◆ getIsPreview()

◆ getIsPrintable()

◆ getIsSectionPreview()

◆ getMagicISBNLinks()

◆ getMagicPMIDLinks()

◆ getMagicRFCLinks()

◆ getMaxGeneratedPPNodeCount()

◆ getMaxIncludeSize()

◆ getMaxPPExpandDepth()

◆ getMaxPPNodeCount()

◆ getMaxTemplateDepth()

◆ getNumberHeadings()

◆ getOption()

◆ getPreSaveTransform()

◆ getRedirectTarget()

◆ getRemoveComments()

◆ getSpeculativeRevId()

◆ getSpeculativeRevIdCallback()

◆ getStubThreshold()

◆ getTargetLanguage()

◆ getTemplateCallback()

◆ getThumbSize()

◆ getTidy()

◆ getTimestamp()

◆ getUser()

◆ getUserLang()

◆ getUserLangObj()

◆ getWrapOutputClass()

◆ initDateFormat()

◆ initialiseFromUser()

◆ initSpeculativeRevId()

◆ isSafeToCache()

◆ matches()

◆ newCanonical()

◆ newFromAnon()

◆ newFromContext()

◆ newFromUser()

◆ newFromUserAndLang()

◆ optionsHash()

◆ optionToString()

◆ optionUsed()

◆ registerWatcher()

◆ setAllowExternalImages()

◆ setAllowExternalImagesFrom()

◆ setAllowSpecialInclusion()