MediaWiki
master
|
Set options of the Parser. More...
Public Member Functions | |
__construct (UserIdentity $user, $lang=null) | |
addExtraKey ( $key) | |
Extra key that should be present in the parser cache key. More... | |
disableContentConversion ( $x=true) | |
Whether content conversion should be disabled. More... | |
disableTitleConversion ( $x=true) | |
Whether title conversion should be disabled. More... | |
enableLimitReport ( $x=true) | |
getAllowExternalImages () | |
Allow all external images inline? More... | |
getAllowExternalImagesFrom () | |
External images to allow. More... | |
getAllowSpecialInclusion () | |
Allow inclusion of special pages? 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... | |
getCleanSignatures () | |
Clean up signature texts? More... | |
getCurrentRevisionRecordCallback () | |
Callback for current revision fetching; first argument to call_user_func(). More... | |
getDateFormat () | |
Date format index. More... | |
getDisableContentConversion () | |
Whether content conversion should be disabled. More... | |
getDisableTitleConversion () | |
Whether title conversion should be disabled. More... | |
getEnableImageWhitelist () | |
Use the on-wiki external image whitelist? More... | |
getEnableLimitReport () | |
getExpensiveParserFunctionLimit () | |
Maximum number of calls per parse to expensive parser functions. More... | |
getExternalLinkTarget () | |
Target attribute for external links. More... | |
getInterfaceMessage () | |
Parsing an interface message? More... | |
getInterwikiMagic () | |
Whether to extract interlanguage links. More... | |
getIsPreview () | |
Parsing the page for a "preview" operation? More... | |
getIsPrintable () | |
Parsing the printable version of the page? More... | |
getIsSectionPreview () | |
Parsing the page for a "preview" operation on a single section? More... | |
getMagicISBNLinks () | |
Are magic ISBN links enabled? More... | |
getMagicPMIDLinks () | |
Are magic PMID links enabled? More... | |
getMagicRFCLinks () | |
Are magic RFC links enabled? More... | |
getMaxIncludeSize () | |
Maximum size of template expansions, in bytes. More... | |
getMaxPPExpandDepth () | |
Maximum recursion depth in PPFrame::expand() More... | |
getMaxPPNodeCount () | |
Maximum number of nodes touched by PPFrame::expand() More... | |
getMaxTemplateDepth () | |
Maximum recursion depth for templates within templates. More... | |
getOption ( $name) | |
Fetch an option and track that is was accessed. More... | |
getPreSaveTransform () | |
Transform wiki markup when saving the page? More... | |
getRedirectTarget () | |
Get the previously-set redirect target. More... | |
getRemoveComments () | |
Remove HTML comments. More... | |
getRenderReason () | |
Returns reason for rendering the content. More... | |
getSpeculativePageId () | |
A guess for {{PAGEID}}, calculated using the callback provided via setSpeculativeRevPageCallback(). More... | |
getSpeculativeRevId () | |
A guess for {{REVISIONID}}, calculated using the callback provided via setSpeculativeRevIdCallback(). More... | |
getSuppressTOC () | |
Should the table of contents be suppressed? Used when parsing "code" pages (like JavaScript) as wikitext for backlink support and categories, but where we don't want other metadata generated (like the table of contents). More... | |
getTargetLanguage () | |
Target language for the parse. More... | |
getTemplateCallback () | |
Callback for template fetching; first argument to call_user_func(). More... | |
getThumbSize () | |
Thumb size preferred by the user. More... | |
getTimestamp () | |
Timestamp used for {{CURRENTDAY}} etc. More... | |
getUseParsoid () | |
Parsoid-format HTML output, or legacy wikitext parser HTML? More... | |
getUserIdentity () | |
Get the identity of the user for whom the parse is made. More... | |
getUserLang () | |
Same as getUserLangObj() but returns a string instead. More... | |
getUserLangObj () | |
Get the user language used by the parser for this page and split the parser cache. More... | |
getWrapOutputClass () | |
Class to use to wrap output from Parser::parse() More... | |
isSafeToCache (array $usedOptions=null) | |
Test whether these options are safe to cache. More... | |
matches (ParserOptions $other) | |
Check if these options match that of another options set. More... | |
matchesForCacheKey (ParserOptions $other) | |
optionsHash ( $forOptions, $title=null) | |
Generate a hash string with the values set on these ParserOptions for the keys given in the array. More... | |
registerWatcher ( $callback) | |
Registers a callback for tracking which ParserOptions which are used. More... | |
setAllowExternalImages ( $x) | |
Allow all external images inline? More... | |
setAllowExternalImagesFrom ( $x) | |
External images to allow. More... | |
setAllowSpecialInclusion ( $x) | |
Allow inclusion of special pages? 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... | |
setCleanSignatures ( $x) | |
Clean up signature texts? More... | |
setCurrentRevisionRecordCallback ( $x) | |
Callback for current revision fetching; first argument to call_user_func(). More... | |
setDateFormat ( $x) | |
Date format index. More... | |
setEnableImageWhitelist ( $x) | |
Use the on-wiki external image whitelist? More... | |
setExpensiveParserFunctionLimit ( $x) | |
Maximum number of calls per parse to expensive parser functions. More... | |
setExternalLinkTarget ( $x) | |
Target attribute for external links. More... | |
setInterfaceMessage ( $x) | |
Parsing an interface message? More... | |
setInterwikiMagic ( $x) | |
Specify whether to extract interlanguage links. More... | |
setIsPreview ( $x) | |
Parsing the page for a "preview" operation? More... | |
setIsPrintable ( $x) | |
Parsing the printable version of the page? More... | |
setIsSectionPreview ( $x) | |
Parsing the page for a "preview" operation on a single section? More... | |
setMaxIncludeSize ( $x) | |
Maximum size of template expansions, in bytes. More... | |
setMaxPPNodeCount ( $x) | |
Maximum number of nodes touched by PPFrame::expand() More... | |
setMaxTemplateDepth ( $x) | |
Maximum recursion depth for templates within templates. More... | |
setOption ( $name, $value) | |
Set an option, generically. More... | |
setPreSaveTransform ( $x) | |
Transform wiki markup when saving the page? More... | |
setRedirectTarget ( $title) | |
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. More... | |
setRemoveComments ( $x) | |
Remove HTML comments. More... | |
setRenderReason (string $renderReason) | |
Sets reason for rendering the content. More... | |
setSpeculativePageIdCallback ( $x) | |
Callback to generate a guess for {{PAGEID}}. More... | |
setSpeculativeRevIdCallback ( $x) | |
Callback to generate a guess for {{REVISIONID}}. More... | |
setSuppressTOC () | |
Suppress generation of the table of contents. More... | |
setTargetLanguage ( $x) | |
Target language for the parse. More... | |
setTemplateCallback ( $x) | |
Callback for template fetching; first argument to call_user_func(). More... | |
setThumbSize ( $x) | |
Thumb size preferred by the user. 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... | |
setUseParsoid () | |
Request Parsoid-format HTML output. More... | |
setUserLang ( $x) | |
Set the user language used by the parser for this page and split the parser cache. More... | |
setWrapOutputClass ( $className) | |
CSS class to use to wrap output from Parser::parse() More... | |
Static Public Member Functions | |
static | allCacheVaryingOptions () |
Return all option keys that vary the options hash. More... | |
static | clearStaticCache () |
Reset static caches. More... | |
static | getLazyOptions () |
Get lazy-loaded options. More... | |
static | newCanonical ( $context, $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 (UserIdentity $user, Language $lang) |
Get a ParserOptions object from a given user and language. More... | |
Protected Member Functions | |
setOptionLegacy ( $name, $value) | |
Legacy implementation. More... | |
Set options of the Parser.
How to add an option in core:
How to add an option in an extension:
Definition at line 49 of file ParserOptions.php.
ParserOptions::__construct | ( | UserIdentity | $user, |
$lang = null |
|||
) |
UserIdentity | $user | |
Language | null | $lang |
Definition at line 1058 of file ParserOptions.php.
ParserOptions::addExtraKey | ( | $key | ) |
Extra key that should be present in the parser cache key.
string | $key |
Definition at line 1041 of file ParserOptions.php.
|
static |
Return all option keys that vary the options hash.
Definition at line 1371 of file ParserOptions.php.
|
static |
ParserOptions::disableContentConversion | ( | $x = true | ) |
Whether content conversion should be disabled.
bool | null | $x | New value (null is no change) |
Definition at line 565 of file ParserOptions.php.
ParserOptions::disableTitleConversion | ( | $x = true | ) |
Whether title conversion should be disabled.
bool | null | $x | New value (null is no change) |
Definition at line 582 of file ParserOptions.php.
ParserOptions::enableLimitReport | ( | $x = true | ) |
This does nothing now, to control limit reporting please provide 'includeDebugInfo' option to ParserOutput::getText.
Enable limit report in an HTML comment on output
bool | null | $x | New value (null is no change) |
Definition at line 510 of file ParserOptions.php.
ParserOptions::getAllowExternalImages | ( | ) |
ParserOptions::getAllowExternalImagesFrom | ( | ) |
External images to allow.
When self::getAllowExternalImages() is false
Definition at line 302 of file ParserOptions.php.
ParserOptions::getAllowSpecialInclusion | ( | ) |
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.
Definition at line 835 of file ParserOptions.php.
ParserOptions::getCleanSignatures | ( | ) |
Clean up signature texts?
Definition at line 519 of file ParserOptions.php.
ParserOptions::getCurrentRevisionRecordCallback | ( | ) |
Callback for current revision fetching; first argument to call_user_func().
Definition at line 883 of file ParserOptions.php.
ParserOptions::getDateFormat | ( | ) |
ParserOptions::getDisableContentConversion | ( | ) |
Whether content conversion should be disabled.
Definition at line 556 of file ParserOptions.php.
ParserOptions::getDisableTitleConversion | ( | ) |
Whether title conversion should be disabled.
Definition at line 573 of file ParserOptions.php.
Referenced by Parser\parse().
ParserOptions::getEnableImageWhitelist | ( | ) |
Use the on-wiki external image whitelist?
Definition at line 325 of file ParserOptions.php.
ParserOptions::getEnableLimitReport | ( | ) |
This does nothing now, to control limit reporting please provide 'includeDebugInfo' option to ParserOutput::getText.
Enable limit report in an HTML comment on output
Definition at line 498 of file ParserOptions.php.
ParserOptions::getExpensiveParserFunctionLimit | ( | ) |
Maximum number of calls per parse to expensive parser functions.
Definition at line 458 of file ParserOptions.php.
ParserOptions::getExternalLinkTarget | ( | ) |
Target attribute for external links.
Definition at line 538 of file ParserOptions.php.
ParserOptions::getInterfaceMessage | ( | ) |
ParserOptions::getInterwikiMagic | ( | ) |
Whether to extract interlanguage links.
When true, interlanguage links will be returned by ParserOutput::getLanguageLinks() instead of generating link HTML.
Definition at line 262 of file ParserOptions.php.
ParserOptions::getIsPreview | ( | ) |
Parsing the page for a "preview" operation?
Definition at line 607 of file ParserOptions.php.
ParserOptions::getIsPrintable | ( | ) |
Parsing the printable version of the page?
Definition at line 641 of file ParserOptions.php.
ParserOptions::getIsSectionPreview | ( | ) |
Parsing the page for a "preview" operation on a single section?
Definition at line 624 of file ParserOptions.php.
|
static |
Get lazy-loaded options.
This array should be initialised by the constructor. The return type hint is used as an assertion to ensure this has happened and to coerce the type for static analysis.
Definition at line 196 of file ParserOptions.php.
ParserOptions::getMagicISBNLinks | ( | ) |
Are magic ISBN links enabled?
Definition at line 774 of file ParserOptions.php.
ParserOptions::getMagicPMIDLinks | ( | ) |
Are magic PMID links enabled?
Definition at line 783 of file ParserOptions.php.
ParserOptions::getMagicRFCLinks | ( | ) |
Are magic RFC links enabled?
Definition at line 792 of file ParserOptions.php.
ParserOptions::getMaxIncludeSize | ( | ) |
Maximum size of template expansions, in bytes.
Definition at line 396 of file ParserOptions.php.
Referenced by Parser\Parsoid\ParsoidParser\makeLimitReport().
ParserOptions::getMaxPPExpandDepth | ( | ) |
Maximum recursion depth in PPFrame::expand()
Definition at line 430 of file ParserOptions.php.
ParserOptions::getMaxPPNodeCount | ( | ) |
Maximum number of nodes touched by PPFrame::expand()
Definition at line 413 of file ParserOptions.php.
ParserOptions::getMaxTemplateDepth | ( | ) |
Maximum recursion depth for templates within templates.
Definition at line 439 of file ParserOptions.php.
ParserOptions::getOption | ( | $name | ) |
Fetch an option and track that is was accessed.
string | $name | Option name |
Definition at line 156 of file ParserOptions.php.
ParserOptions::getPreSaveTransform | ( | ) |
Transform wiki markup when saving the page?
Definition at line 658 of file ParserOptions.php.
Referenced by Parser\preSaveTransform().
ParserOptions::getRedirectTarget | ( | ) |
Get the previously-set redirect target.
Definition at line 1031 of file ParserOptions.php.
ParserOptions::getRemoveComments | ( | ) |
Remove HTML comments.
Definition at line 477 of file ParserOptions.php.
ParserOptions::getRenderReason | ( | ) |
Returns reason for rendering the content.
This human-readable, intended for logging and debugging only. Expected values include "edit", "view", "purge", "LinksUpdate", etc.
Definition at line 1543 of file ParserOptions.php.
ParserOptions::getSpeculativePageId | ( | ) |
A guess for {{PAGEID}}, calculated using the callback provided via setSpeculativeRevPageCallback().
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 setSpeculativePageIdCallback(), this method will return false.
Definition at line 939 of file ParserOptions.php.
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.
Definition at line 925 of file ParserOptions.php.
ParserOptions::getSuppressTOC | ( | ) |
Should the table of contents be suppressed? Used when parsing "code" pages (like JavaScript) as wikitext for backlink support and categories, but where we don't want other metadata generated (like the table of contents).
Definition at line 805 of file ParserOptions.php.
ParserOptions::getTargetLanguage | ( | ) |
Target language for the parse.
Definition at line 379 of file ParserOptions.php.
ParserOptions::getTemplateCallback | ( | ) |
Callback for template fetching; first argument to call_user_func().
Definition at line 902 of file ParserOptions.php.
ParserOptions::getThumbSize | ( | ) |
ParserOptions::getTimestamp | ( | ) |
Timestamp used for {{CURRENTDAY}} etc.
Definition at line 997 of file ParserOptions.php.
References wfTimestampNow().
ParserOptions::getUseParsoid | ( | ) |
Parsoid-format HTML output, or legacy wikitext parser HTML?
Definition at line 678 of file ParserOptions.php.
ParserOptions::getUserIdentity | ( | ) |
Get the identity of the user for whom the parse is made.
Definition at line 1050 of file ParserOptions.php.
ParserOptions::getUserLang | ( | ) |
Same as getUserLangObj() but returns a string instead.
Definition at line 752 of file ParserOptions.php.
ParserOptions::getUserLangObj | ( | ) |
Get the user language used by the parser for this page and split the parser cache.
Definition at line 736 of file ParserOptions.php.
ParserOptions::getWrapOutputClass | ( | ) |
Class to use to wrap output from Parser::parse()
Definition at line 856 of file ParserOptions.php.
ParserOptions::isSafeToCache | ( | array | $usedOptions = null | ) |
Test whether these options are safe to cache.
string[] | null | $usedOptions | the list of options actually used in the parse. Defaults to all options. |
Definition at line 1473 of file ParserOptions.php.
Referenced by Parser\RevisionOutputCache\save().
ParserOptions::matches | ( | ParserOptions | $other | ) |
Check if these options match that of another options set.
This ignores report limit settings that only affect HTML comments
ParserOptions | $other |
Definition at line 1280 of file ParserOptions.php.
ParserOptions::matchesForCacheKey | ( | ParserOptions | $other | ) |
ParserOptions | $other |
Definition at line 1325 of file ParserOptions.php.
|
static |
Creates a "canonical" ParserOptions object.
For historical reasons, certain options have default values that are different from the canonical values used for caching.
IContextSource | string | UserIdentity | $context |
|
Language | StubObject | null | $userLang | (see above) |
Definition at line 1129 of file ParserOptions.php.
Referenced by WikiPage\makeParserOptionsFromTitleAndModel().
|
static |
Get a ParserOptions object for an anonymous user.
Definition at line 1072 of file ParserOptions.php.
Referenced by MediaWiki\Content\Renderer\ContentParseParams\__construct(), FormatInstallDoc\execute(), WikiPage\getParserOutput(), AbstractContent\getParserOutput(), MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), CLIParser\parse(), and OutputPage\parserOptions().
|
static |
Get a ParserOptions object from a IContextSource object.
IContextSource | $context |
Definition at line 1105 of file ParserOptions.php.
References IContextSource\getLanguage(), and IContextSource\getUser().
Referenced by MediaWiki\Specials\SpecialExpandTemplates\execute(), ApiExpandTemplates\execute(), ApiParse\execute(), LocalFile\getDescriptionText(), RawAction\getRawText(), OutputPage\parserOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().
|
static |
Get a ParserOptions object from a given user.
Language will be taken from $wgLang.
UserIdentity | $user |
Definition at line 1084 of file ParserOptions.php.
Referenced by CompareParsers\checkOptions(), Parser\cleanSig(), Parser\getFlatSectionInfo(), MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), and DumpRenderer\handleRevision().
|
static |
Get a ParserOptions object from a given user and language.
UserIdentity | $user | |
Language | $lang |
Definition at line 1095 of file ParserOptions.php.
References $lang.
Referenced by MediaWiki\EditPage\EditPage\getContentObject(), LocalFile\getDescriptionText(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\EditPage\EditPage\showDiff().
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.
string[] | $forOptions | |
Title | null | $title | Used to get the content language of the page (since r97636) |
Definition at line 1408 of file ParserOptions.php.
Referenced by Parser\ParserObserver\notifyParse().
ParserOptions::registerWatcher | ( | $callback | ) |
Registers a callback for tracking which ParserOptions which are used.
callable | null | $callback |
Definition at line 1347 of file ParserOptions.php.
ParserOptions::setAllowExternalImages | ( | $x | ) |
Allow all external images inline?
bool | null | $x | New value (null is no change) |
Definition at line 290 of file ParserOptions.php.
References wfDeprecated().
ParserOptions::setAllowExternalImagesFrom | ( | $x | ) |
External images to allow.
When self::getAllowExternalImages() is false
string | string[] | null | $x | New value (null is no change) |
Definition at line 316 of file ParserOptions.php.
References wfDeprecated().
ParserOptions::setAllowSpecialInclusion | ( | $x | ) |
Allow inclusion of special pages?
bool | null | $x | New value (null is no change) |
Definition at line 354 of file ParserOptions.php.
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.
bool | null | $x | Value to set or null to get current value |
Definition at line 847 of file ParserOptions.php.
ParserOptions::setCleanSignatures | ( | $x | ) |
Clean up signature texts?
bool | null | $x | New value (null is no change) |
Definition at line 529 of file ParserOptions.php.
ParserOptions::setCurrentRevisionRecordCallback | ( | $x | ) |
Callback for current revision fetching; first argument to call_user_func().
callable | null | $x | New value |
Definition at line 894 of file ParserOptions.php.
ParserOptions::setDateFormat | ( | $x | ) |
Date format index.
string | null | $x | New value (null is no change) |
Definition at line 715 of file ParserOptions.php.
ParserOptions::setEnableImageWhitelist | ( | $x | ) |
Use the on-wiki external image whitelist?
bool | null | $x | New value (null is no change) |
Definition at line 336 of file ParserOptions.php.
References wfDeprecated().
ParserOptions::setExpensiveParserFunctionLimit | ( | $x | ) |
Maximum number of calls per parse to expensive parser functions.
int | null | $x | New value (null is no change) |
Definition at line 468 of file ParserOptions.php.
ParserOptions::setExternalLinkTarget | ( | $x | ) |
Target attribute for external links.
string | false | null | $x | New value (null is no change) |
Definition at line 548 of file ParserOptions.php.
ParserOptions::setInterfaceMessage | ( | $x | ) |
Parsing an interface message?
bool | null | $x | New value (null is no change) |
Definition at line 371 of file ParserOptions.php.
ParserOptions::setInterwikiMagic | ( | $x | ) |
Specify whether to extract interlanguage links.
bool | null | $x | New value (null is no change) |
Definition at line 271 of file ParserOptions.php.
ParserOptions::setIsPreview | ( | $x | ) |
Parsing the page for a "preview" operation?
bool | null | $x | New value (null is no change) |
Definition at line 616 of file ParserOptions.php.
ParserOptions::setIsPrintable | ( | $x | ) |
Parsing the printable version of the page?
bool | null | $x | New value (null is no change) |
Definition at line 650 of file ParserOptions.php.
ParserOptions::setIsSectionPreview | ( | $x | ) |
Parsing the page for a "preview" operation on a single section?
bool | null | $x | New value (null is no change) |
Definition at line 633 of file ParserOptions.php.
ParserOptions::setMaxIncludeSize | ( | $x | ) |
Maximum size of template expansions, in bytes.
int | null | $x | New value (null is no change) |
Definition at line 405 of file ParserOptions.php.
ParserOptions::setMaxPPNodeCount | ( | $x | ) |
Maximum number of nodes touched by PPFrame::expand()
int | null | $x | New value (null is no change) |
Definition at line 422 of file ParserOptions.php.
ParserOptions::setMaxTemplateDepth | ( | $x | ) |
Maximum recursion depth for templates within templates.
int | null | $x | New value (null is no change) |
Definition at line 449 of file ParserOptions.php.
ParserOptions::setOption | ( | $name, | |
$value | |||
) |
Set an option, generically.
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. |
Definition at line 230 of file ParserOptions.php.
|
protected |
Legacy implementation.
string | $name | Option name |
mixed | $value | New value. Passing null does not set the value. |
Definition at line 247 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setPreSaveTransform | ( | $x | ) |
Transform wiki markup when saving the page?
bool | null | $x | New value (null is no change) |
Definition at line 667 of file ParserOptions.php.
ParserOptions::setRedirectTarget | ( | $title | ) |
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.
Title | null | $title |
Definition at line 1021 of file ParserOptions.php.
References $title.
ParserOptions::setRemoveComments | ( | $x | ) |
Remove HTML comments.
bool | null | $x | New value (null is no change) |
Definition at line 487 of file ParserOptions.php.
ParserOptions::setRenderReason | ( | string | $renderReason | ) |
Sets reason for rendering the content.
This human-readable, intended for logging and debugging only. Expected values include "edit", "view", "purge", "LinksUpdate", etc.
string | $renderReason |
Definition at line 1552 of file ParserOptions.php.
Referenced by Article\getParserOptions(), and Article\getParserOutput().
ParserOptions::setSpeculativePageIdCallback | ( | $x | ) |
Callback to generate a guess for {{PAGEID}}.
callable | null | $x | New value |
Definition at line 988 of file ParserOptions.php.
ParserOptions::setSpeculativeRevIdCallback | ( | $x | ) |
Callback to generate a guess for {{REVISIONID}}.
callable | null | $x | New value |
Definition at line 977 of file ParserOptions.php.
ParserOptions::setSuppressTOC | ( | ) |
Suppress generation of the table of contents.
Used when parsing "code" pages (like JavaScript) as wikitext for backlink support and categories, but where we don't want other metadata generated (like the table of contents).
Definition at line 817 of file ParserOptions.php.
ParserOptions::setTargetLanguage | ( | $x | ) |
Target language for the parse.
Language | null | $x | New value |
Definition at line 388 of file ParserOptions.php.
ParserOptions::setTemplateCallback | ( | $x | ) |
Callback for template fetching; first argument to call_user_func().
callable | null | $x | New value (null is no change) |
Definition at line 911 of file ParserOptions.php.
ParserOptions::setThumbSize | ( | $x | ) |
Thumb size preferred by the user.
int | null | $x | New value (null is no change) |
Definition at line 599 of file ParserOptions.php.
ParserOptions::setTimestamp | ( | $x | ) |
Timestamp used for {{CURRENTDAY}} etc.
string | null | $x | New value (null is no change) |
Definition at line 1009 of file ParserOptions.php.
References wfSetVar().
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.
Title | $title | |
Content | $content | |
UserIdentity | $user | The user that the fake revision is attributed to |
Definition at line 1499 of file ParserOptions.php.
ParserOptions::setUseParsoid | ( | ) |
Request Parsoid-format HTML output.
Definition at line 688 of file ParserOptions.php.
ParserOptions::setUserLang | ( | $x | ) |
Set the user language used by the parser for this page and split the parser cache.
string | Language | $x | New value |
Definition at line 761 of file ParserOptions.php.
ParserOptions::setWrapOutputClass | ( | $className | ) |
CSS class to use to wrap output from Parser::parse()
string | $className | Class name to use for wrapping. Passing false to indicate "no wrapping" was deprecated in MediaWiki 1.31. |
Definition at line 867 of file ParserOptions.php.
References wfDeprecated().