MediaWiki REL1_39
OutputPage Class Reference

This is one of the Core classes and should be read at least once by any new developers. More...

Inheritance diagram for OutputPage:
Collaboration diagram for OutputPage:

Public Member Functions

 __construct (IContextSource $context)
 Constructor for OutputPage.
 
 adaptCdnTTL ( $mtime, $minTTL=0, $maxTTL=0)
 Get TTL in [$minTTL,$maxTTL] and pass it to lowerCdnMaxage()
 
 addBacklinkSubtitle (PageReference $title, $query=[])
 Add a subtitle containing a backlink to a page.
 
 addBodyClasses ( $classes)
 Add a class to the <body> element.
 
 addCategoryLinks (array $categories)
 Add an array of categories, with names in the keys.
 
 addContentOverride ( $target, Content $content)
 Force the given Content object for the given page, for things like page preview.
 
 addContentOverrideCallback (callable $callback)
 Add a callback for mapping from a Title to a Content object, for things like page preview.
 
 addElement ( $element, array $attribs=[], $contents='')
 Shortcut for adding an Html::element via addHTML.
 
 addFeedLink ( $format, $href)
 Add a feed link to the page header.
 
 addHeadItem ( $name, $value)
 Add or replace a head item to the output.
 
 addHeadItems ( $values)
 Add one or more head items to the output.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 addHTML ( $text)
 Append $text to the body HTML.
 
 addHtmlClasses ( $classes)
 Add a class to the <html> element.
 
 addInlineScript ( $script)
 Add a self-contained script tag with the given contents Internal use only.
 
 addInlineStyle ( $style_css, $flip='noflip')
 Adds inline CSS styles Internal use only.
 
 addJsConfigVars ( $keys, $value=null)
 Add one or more variables to be set in mw.config in JavaScript.
 
 addLanguageLinks (array $newLinkArray)
 Add new language links.
 
 addLink (array $linkarr)
 Add a new \<link\> tag to the page header.
 
 addLinkHeader ( $header)
 Add an HTTP Link: header.
 
 addMeta ( $name, $val)
 Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:".
 
 addModules ( $modules)
 Load one or more ResourceLoader modules on this page.
 
 addModuleStyles ( $modules)
 Load the styles of one or more style-only ResourceLoader modules on this page.
 
 addParserOutput (ParserOutput $parserOutput, $poOptions=[])
 Add everything from a ParserOutput object.
 
 addParserOutputContent (ParserOutput $parserOutput, $poOptions=[])
 Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput object, without any other metadata.
 
 addParserOutputMetadata (ParserOutput $parserOutput)
 Add all metadata associated with a ParserOutput object, but without the actual HTML.
 
 addParserOutputText (ParserOutput $parserOutput, $poOptions=[])
 Add the HTML associated with a ParserOutput object, without any metadata.
 
 addReturnTo ( $title, array $query=[], $text=null, $options=[])
 Add a "return to" link pointing to a specified title.
 
 addScript ( $script)
 Add raw HTML to the list of scripts (including \<script\> tag, etc.) Internal use only.
 
 addScriptFile ( $file, $unused=null)
 Add a JavaScript file to be loaded as <script> on this page.
 
 addStyle ( $style, $media='', $condition='', $dir='')
 Add a local or specified stylesheet, with the given media options.
 
 addSubtitle ( $str)
 Add $str to the subtitle.
 
 addTemplate (&$template)
 Add the output of a QuickTemplate to the output buffer.
 
 addVaryHeader ( $header, array $option=null)
 Add an HTTP header that will influence on the cache.
 
 addWikiMsg (... $args)
 Add a wikitext-formatted message to the output.
 
 addWikiMsgArray ( $name, $args)
 Add a wikitext-formatted message to the output.
 
 addWikiTextAsContent ( $text, $linestart=true, PageReference $title=null)
 Convert wikitext in the page content language to HTML and add it to the buffer.
 
 addWikiTextAsInterface ( $text, $linestart=true, PageReference $title=null)
 Convert wikitext in the user interface language to HTML and add it to the buffer.
 
 allowClickjacking ()
 Turn off frame-breaking.
 
 buildCssLinksArray ()
 
 checkLastModified ( $timestamp)
 checkLastModified tells the client to use the client-cached page if possible.
 
 clearHTML ()
 Clear the body HTML.
 
 clearSubtitle ()
 Clear the subtitles.
 
 considerCacheSettingsFinal ()
 Set the expectation that cache control will not change after this point.
 
 couldBePublicCached ()
 Whether the output might become publicly cached.
 
 disable ()
 Disable output completely, i.e.
 
 disableClientCache ()
 Force the page to send nocache headers.
 
 disallowUserJs ()
 Do not allow scripts which can be modified by wiki users to load on this page; only allow scripts bundled with, or generated by, the software.
 
 enableClientCache ( $state)
 Use enableClientCache(false) to force it to send nocache headers.
 
 enableOOUI ()
 Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with MediaWiki and this OutputPage instance.
 
 forceHideNewSectionLink ()
 Forcibly hide the new section link?
 
 formatPermissionsErrorMessage (array $errors, $action=null)
 Format a list of error messages.
 
 formatPermissionStatus (PermissionStatus $status, string $action=null)
 Format permission $status obtained from Authority for display.
 
 getAllowedModules ( $type)
 Show what level of JavaScript / CSS untrustworthiness is allowed on this page.
 
 getArticleBodyOnly ()
 Return whether the output will contain only the body of the article.
 
 getBottomScripts ()
 JS stuff to put at the bottom of the <body>.
 
 getCacheVaryCookies ()
 Get the list of cookie names that will influence the cache.
 
 getCanonicalUrl ()
 Returns the URL to be used for the <link rel=canonical>> if one is set.
 
 getCategories ( $type='all')
 Get the list of category names this page belongs to.
 
 getCategoryLinks ()
 Get the list of category links, in a 2-D array with the following format: $arr[$type][] = $link, where $type is either "normal" or "hidden" (for hidden categories) and $link a HTML fragment with a link to the category page.
 
 getCSP ()
 Get the ContentSecurityPolicy object.
 
 getCSPNonce ()
 Get (and set if not yet set) the CSP nonce.
 
 getDisplayTitle ()
 Returns page display title.
 
 getFeedAppendQuery ()
 Will currently always return null.
 
 getFileSearchOptions ()
 Get the files used on this page.
 
 getFileVersion ()
 Get the displayed file version.
 
 getFollowPolicy ()
 Get the current follow policy for the page as a string.
 
 getFrameOptions ()
 Get the X-Frame-Options header value (without the name part), or false if there isn't one.
 
 getHeadItemsArray ()
 Get an array of head items.
 
 getHeadLinksArray ()
 
 getHTML ()
 Get the body HTML.
 
 getHTMLTitle ()
 Return the "HTML title", i.e.
 
 getIndexPolicy ()
 Get the current index policy for the page as a string.
 
 getIndicators ()
 Get the indicators associated with this page.
 
 getJsConfigVars ()
 Get the javascript config vars to include on this page.
 
 getJSVars ()
 Get an array containing the variables to be set in mw.config in JavaScript.
 
 getLanguageLinks ()
 Get the list of language links.
 
 getLinkHeader ()
 Return a Link: header.
 
 getLinkTags ()
 Returns the current <link> tags.
 
 getMetaTags ()
 Returns the current <meta> tags.
 
 getModules ( $filter=false, $position=null, $param='mModules', $type=RL\Module::TYPE_COMBINED)
 Get the list of modules to include on this page.
 
 getModuleStyles ( $filter=false, $position=null)
 Get the list of style-only modules to load on this page.
 
 getPageTitle ()
 Return the "page title", i.e.
 
 getPreventClickjacking ()
 Get the prevent-clickjacking flag.
 
 getProperty ( $name)
 Get an additional output property.
 
 getRedirect ()
 Get the URL to redirect to, or an empty string if not redirect URL set.
 
 getResourceLoader ()
 Get a ResourceLoader object associated with this OutputPage.
 
 getRevisionId ()
 Get the displayed revision ID.
 
 getRevisionTimestamp ()
 Get the timestamp of displayed revision.
 
 getRlClient ()
 Call this to freeze the module queue and JS config and create a formatter.
 
 getRobotPolicy ()
 Get the current robot policy for the page as a string in the form <index policy>,<follow policy>.
 
 getSections ()
 
 getSubtitle ()
 
 getSyndicationLinks ()
 Return URLs for each supported syndication format for this page.
 
 getTarget ()
 
 getTemplateIds ()
 Get the templates used on this page.
 
 getUnprefixedDisplayTitle ()
 Returns page display title without namespace prefix if possible.
 
 getVaryHeader ()
 Return a Vary: header on which to vary caches.
 
 hasHeadItem ( $name)
 Check if the header item $name is already set.
 
 haveCacheVaryCookies ()
 Check if the request has a cache-varying cookie header If it does, it's very important that we don't allow public caching.
 
 headElement (Skin $sk, $includeStyle=true)
 
 isArticle ()
 Return whether the content displayed page is related to the source of the corresponding article on the wiki.
 
 isArticleRelated ()
 Return whether this page is related an article on the wiki.
 
 isDisabled ()
 Return whether the output will be completely disabled.
 
 isPrintable ()
 Return whether the page is "printable".
 
 isRevisionCurrent ()
 Whether the revision displayed is the latest revision of the page.
 
 isSyndicated ()
 Should we output feed links for this page?
 
 isTOCEnabled ()
 Whether the output has a table of contents.
 
 loadSkinModules ( $sk)
 Transfer styles and JavaScript modules from skin.
 
 lowerCdnMaxage ( $maxage)
 Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is lower than the current s-maxage.
 
 makeResourceLoaderLink ( $modules, $only, array $extraQuery=[])
 Explicitly load or embed modules on a page.
 
 output ( $return=false)
 Finally, all the text has been munged and accumulated into the object, let's actually output it:
 
 parseAsContent ( $text, $linestart=true)
 Parse wikitext in the page content language and return the HTML.
 
 parseAsInterface ( $text, $linestart=true)
 Parse wikitext in the user interface language and return the HTML.
 
 parseInlineAsInterface ( $text, $linestart=true)
 Parse wikitext in the user interface language, strip paragraph wrapper, and return the HTML.
 
 parserOptions ()
 Get/set the ParserOptions object to use for wikitext parsing.
 
 prepareErrorPage ( $pageTitle, $htmlTitle=false)
 Prepare this object to display an error page; disable caching and indexing, clear the current text and redirect, set the page's title and optionally an custom HTML title (content of the "<title>" tag).
 
 prependHTML ( $text)
 Prepend $text to the body HTML.
 
 preventClickjacking ( $enable=true)
 Set a flag which will cause an X-Frame-Options header appropriate for edit pages to be sent.
 
 redirect ( $url, $responsecode='302')
 Redirect to $url rather than displaying the normal page.
 
 reduceAllowedModules ( $type, $level)
 Limit the highest level of CSS/JS untrustworthiness allowed.
 
 returnToMain ( $unused=null, $returnto=null, $returntoquery=null)
 Add a "return to" link pointing to a specified title, or the title indicated in the request, or else the main page.
 
 sendCacheControl ()
 Send cache control HTTP headers.
 
 setArticleBodyOnly ( $only)
 Set whether the output should only contain the body of the article, without any skin, sidebar, etc.
 
 setArticleFlag ( $newVal)
 Set whether the displayed content is related to the source of the corresponding article on the wiki Setting true will cause the change "article related" toggle to true.
 
 setArticleRelated ( $newVal)
 Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false.
 
 setCanonicalUrl ( $url)
 Set the URL to be used for the <link rel=canonical>>.
 
 setCategoryLinks (array $categories)
 Reset the category links (but not the category list) and add $categories.
 
 setCdnMaxage ( $maxage)
 Set the value of the "s-maxage" part of the "Cache-control" HTTP header.
 
 setCopyright ( $hasCopyright)
 Set whether the standard copyright should be shown for the current page.
 
 setCopyrightUrl ( $url)
 Set the copyright URL to send with the output.
 
 setDisplayTitle ( $html)
 Same as page title but only contains name of the page, not any other text.
 
 setFeedAppendQuery ( $val)
 Add default feeds to the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.
 
 setFileVersion ( $file)
 Set the displayed file version.
 
 setFollowPolicy ( $policy)
 Set the follow policy for the page, but leave the index policy un- touched.
 
 setHTMLTitle ( $name)
 "HTML title" means the contents of "<title>".
 
 setIndexPolicy ( $policy)
 Set the index policy for the page, but leave the follow policy un- touched.
 
 setIndicators (array $indicators)
 Add an array of indicators, with their identifiers as array keys and HTML contents as values.
 
 setLanguageLinks (array $newLinkArray)
 Reset the language links and add new language links.
 
 setLastModified ( $timestamp)
 Override the last modified timestamp.
 
 setPageTitle ( $name)
 "Page title" means the contents of \<h1\>.
 
 setPreventClickjacking (bool $enable)
 Set the prevent-clickjacking flag.
 
 setPrintable ()
 Set the page as printable, i.e.
 
 setProperty ( $name, $value)
 Set an additional output property.
 
 setRedirectedFrom (PageReference $t)
 Set $mRedirectedFrom, the page which redirected us to the current page.
 
 setRevisionId ( $revid)
 Set the revision ID which will be seen by the wiki text parser for things such as embedded {{REVISIONID}} variable use.
 
 setRevisionIsCurrent (bool $isCurrent)
 Set whether the revision displayed (as set in ::setRevisionId()) is the latest revision of the page.
 
 setRevisionTimestamp ( $timestamp)
 Set the timestamp of the revision which will be displayed.
 
 setRobotPolicy ( $policy)
 Set the robot policy for the page: http://www.robotstxt.org/meta.html
 
 setRobotsOptions (array $options=[])
 Set the robots policy with options for the page.
 
 setSections (array $sections)
 Adds sections to OutputPage from ParserOutput.
 
 setStatusCode ( $statusCode)
 Set the HTTP status code to send with the output.
 
 setSubtitle ( $str)
 Replace the subtitle with $str.
 
 setSyndicated ( $show=true)
 Add or remove feed links in the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.
 
 setTarget ( $target)
 Sets ResourceLoader target for load.php links.
 
 setTitle (PageReference $t)
 Set the Title object to use.
 
 showErrorPage ( $title, $msg, $params=[], $returnto=null, $returntoquery=null)
 Output a standard error page.
 
 showFatalError ( $message)
 Output an error page.
 
 showLagWarning ( $lag)
 Show a warning about replica DB lag.
 
 showNewSectionLink ()
 Show an "add new section" link?
 
 showPermissionsErrorPage (array $errors, $action=null)
 Output a standard permission error page.
 
 showsCopyright ()
 Return whether the standard copyright should be shown for the current page.
 
 tailElement ( $skin)
 The final bits that go to the bottom of a page HTML document including the closing tags.
 
 userCanPreview ()
 To make it harder for someone to slip a user a fake JavaScript or CSS preview, a random token is associated with the login session.
 
 versionRequired ( $version)
 Display an error page indicating that a given version of MediaWiki is required to use it.
 
 wrapWikiMsg ( $wrap,... $msgSpecs)
 This function takes a number of message/argument specifications, wraps them in some overall structure, and then parses the result and adds it to the output.
 
 wrapWikiTextAsInterface ( $wrapperClass, $text)
 Convert wikitext in the user interface language to HTML and add it to the buffer with a <div class="$wrapperClass"> wrapper.
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Static Public Member Functions

static buildBacklinkSubtitle (PageReference $page, $query=[])
 Build message object for a subtitle containing a backlink to a page.
 
static setupOOUI ( $skinName='default', $dir='ltr')
 Helper function to setup the PHP implementation of OOUI to use in this request.
 
static transformCssMedia ( $media)
 Transform "media" attribute based on request parameters.
 
static transformFilePath ( $remotePathPrefix, $localPath, $file)
 Utility method for transformResourceFilePath().
 
static transformResourcePath (Config $config, $path)
 Transform path to web-accessible static resource.
 

Public Attributes

string $mBodytext = ''
 Contains all of the "<body>" content.
 
bool $mNoGallery = false
 Comes from the parser.
 
string $mPageLinkTitle = ''
 Used by skin template.
 
string $mRedirect = ''
 
string $mRedirectCode = ''
 

Protected Member Functions

 addCategoryLinksToLBAndGetResult (array $categories)
 
 buildExemptModules ()
 Build exempt modules and legacy non-ResourceLoader styles.
 
 filterModules (array $modules, $position=null, $type=RL\Module::TYPE_COMBINED)
 Filter an array of modules to remove insufficiently trustworthy members, and modules which are no longer registered (eg a page is cached before an extension is disabled)
 
 getAdvertisedFeedTypes ()
 Return effective list of advertised feed types.
 
 styleLink ( $style, array $options)
 Generate \<link\> tags for stylesheets.
 

Static Protected Member Functions

static combineWrappedStrings (array $chunks)
 Combine WrappedString chunks and filter out empty ones.
 

Protected Attributes

array $mAdditionalBodyClasses = []
 Additional <body> classes; there are also <body> classes from other sources.
 
array $mAdditionalHtmlClasses = []
 Additional <html> classes; This should be rarely modified; prefer mAdditionalBodyClasses.
 
array $mAllowedModules
 What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
 
string bool $mCanonicalUrl = false
 
string[][] $mCategories
 
string[][] $mCategoryLinks = []
 
int $mCdnMaxage = 0
 Cache stuff.
 
int $mCdnMaxageLimit = INF
 Upper limit on mCdnMaxage.
 
bool $mDoNothing = false
 Whether output is disabled.
 
bool $mEnableClientCache = true
 Set to false to send no-cache headers, disabling client-side caching.
 
 $mFeedLinksAppendQuery = null
 
array $mFileVersion = null
 
array $mHeadItems = []
 Array of elements in "<head>".
 
bool $mHideNewSectionLink = false
 
array $mImageTimeKeys = []
 
string[] $mIndicators = []
 
string $mInlineStyles = ''
 Inline CSS styles.
 
array $mJsConfigVars = []
 
string $mLastModified = ''
 Used for sending cache control.
 
array $mLinktags = []
 
string[][] $mMetatags = []
 Should be private.
 
array $mModules = []
 
array $mModuleStyles = []
 
bool $mNewSectionLink = false
 
ParserOptions $mParserOptions = null
 lazy initialised, use parserOptions()
 
bool $mPreventClickjacking = true
 Controls if anti-clickjacking / frame-breaking headers will be sent.
 
ResourceLoader $mResourceLoader
 
int $mStatusCode
 
array $mTemplateIds = []
 
array $styles = []
 An array of stylesheet filenames (relative from skins path), with options for CSS media, IE conditions, and RTL/LTR direction.
 

Detailed Description

This is one of the Core classes and should be read at least once by any new developers.

Also documented at https://www.mediawiki.org/wiki/Manual:Architectural_modules/OutputPage

This class is used to prepare the final rendering. A skin is then applied to the output parameters (links, javascript, html, categories ...).

Todo:
FIXME: Another class handles sending the whole page to the client.

Some comments comes from a pairing session between Zak Greant and Antoine Musso in November 2010.

Todo:
document

Definition at line 54 of file OutputPage.php.

Constructor & Destructor Documentation

◆ __construct()

OutputPage::__construct ( IContextSource  $context)

Constructor for OutputPage.

This should not be called directly. Instead a new RequestContext should be created and it will implicitly create a OutputPage tied to that context.

Parameters
IContextSource$context

Definition at line 400 of file OutputPage.php.

References IContextSource\getConfig(), IContextSource\getRequest(), and ContextSource\setContext().

Member Function Documentation

◆ adaptCdnTTL()

OutputPage::adaptCdnTTL (   $mtime,
  $minTTL = 0,
  $maxTTL = 0 
)

Get TTL in [$minTTL,$maxTTL] and pass it to lowerCdnMaxage()

This sets and returns $minTTL if $mtime is false or null. Otherwise, the TTL is higher the older the $mtime timestamp is. Essentially, the TTL is 90% of the age of the object, subject to the min and max.

Parameters
string | int | float | bool | null$mtimeLast-Modified timestamp
int$minTTLMinimum TTL in seconds [default: 1 minute]
int$maxTTLMaximum TTL in seconds [default: $wgCdnMaxAge]
Since
1.28

Definition at line 2373 of file OutputPage.php.

References wfTimestamp().

◆ addBacklinkSubtitle()

OutputPage::addBacklinkSubtitle ( PageReference  $title,
  $query = [] 
)

Add a subtitle containing a backlink to a page.

Parameters
PageReference$titleTitle to link to
array$queryArray of additional parameters to include in the link

Definition at line 1239 of file OutputPage.php.

References $title.

◆ addBodyClasses()

OutputPage::addBodyClasses (   $classes)

Add a class to the <body> element.

Since
1.30
Parameters
string | string[]$classesOne or more classes to add

Definition at line 751 of file OutputPage.php.

◆ addCategoryLinks()

OutputPage::addCategoryLinks ( array  $categories)

Add an array of categories, with names in the keys.

Parameters
array$categoriesMapping category name => sort key

Definition at line 1498 of file OutputPage.php.

References $res, $title, $type, and NS_CATEGORY.

◆ addCategoryLinksToLBAndGetResult()

OutputPage::addCategoryLinksToLBAndGetResult ( array  $categories)
protected
Parameters
array$categories
Returns
bool|IResultWrapper

Definition at line 1556 of file OutputPage.php.

References $dbr, $res, DB_REPLICA, NS_CATEGORY, and wfGetDB().

◆ addContentOverride()

OutputPage::addContentOverride (   $target,
Content  $content 
)

Force the given Content object for the given page, for things like page preview.

See also
self::addContentOverrideCallback()
Since
1.32
Parameters
LinkTarget | PageReference$target
Content$content

Definition at line 665 of file OutputPage.php.

References $content, and addContentOverrideCallback().

◆ addContentOverrideCallback()

OutputPage::addContentOverrideCallback ( callable  $callback)

Add a callback for mapping from a Title to a Content object, for things like page preview.

See also
RL\Context::getContentOverrideCallback()
Since
1.32
Parameters
callable$callback

Definition at line 685 of file OutputPage.php.

Referenced by addContentOverride().

◆ addElement()

OutputPage::addElement (   $element,
array  $attribs = [],
  $contents = '' 
)

Shortcut for adding an Html::element via addHTML.

Since
1.19
Parameters
string$element
array$attribs
string$contents

Definition at line 1790 of file OutputPage.php.

◆ addFeedLink()

OutputPage::addFeedLink (   $format,
  $href 
)

Add a feed link to the page header.

Parameters
string$formatFeed type, should be a key of $wgFeedClasses
string$hrefURL

Definition at line 1365 of file OutputPage.php.

◆ addHeadItem()

OutputPage::addHeadItem (   $name,
  $value 
)

Add or replace a head item to the output.

Whenever possible, use more specific options like ResourceLoader modules, OutputPage::addLink(), OutputPage::addMeta() and OutputPage::addFeedLink() Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(), OutputPage::addInlineScript() and OutputPage::addInlineStyle() This would be your very LAST fallback.

Parameters
string$nameItem name
string$valueRaw HTML

Definition at line 721 of file OutputPage.php.

◆ addHeadItems()

OutputPage::addHeadItems (   $values)

Add one or more head items to the output.

Since
1.28
Parameters
string | string[]$valuesRaw HTML

Definition at line 731 of file OutputPage.php.

◆ addHelpLink()

OutputPage::addHelpLink (   $to,
  $overrideBaseUrl = false 
)

Adds help link with an icon via page indicators.

Link target can be overridden by a local message containing a wikilink: the message key is: lowercase action or special page name + '-helppage'.

Parameters
string$toTarget MediaWiki.org page title or encoded URL.
bool$overrideBaseUrlWhether $url is a full URL, to avoid MW.o.
Since
1.25

Definition at line 1682 of file OutputPage.php.

References wfUrlencode().

◆ addHTML()

OutputPage::addHTML (   $text)

Append $text to the body HTML.

Parameters
string$textHTML

Definition at line 1777 of file OutputPage.php.

Referenced by Article\doDelete(), and Article\showPatrolFooter().

◆ addHtmlClasses()

OutputPage::addHtmlClasses (   $classes)

Add a class to the <html> element.

This should rarely be used. Instead use OutputPage::addBodyClasses() if possible.

Stability: unstable
Experimental since 1.35. Prefer OutputPage::addBodyClasses()
Parameters
string | string[]$classesOne or more classes to add

Definition at line 696 of file OutputPage.php.

◆ addInlineScript()

OutputPage::addInlineScript (   $script)

Add a self-contained script tag with the given contents Internal use only.

Use OutputPage::addModules() if possible.

Parameters
string$scriptJavaScript text, no script tags

Definition at line 542 of file OutputPage.php.

◆ addInlineStyle()

OutputPage::addInlineStyle (   $style_css,
  $flip = 'noflip' 
)

Adds inline CSS styles Internal use only.

Use OutputPage::addModuleStyles() if possible.

Parameters
mixed$style_cssInline CSS
string$flipSet to 'flip' to flip the CSS if needed

Definition at line 4078 of file OutputPage.php.

◆ addJsConfigVars()

OutputPage::addJsConfigVars (   $keys,
  $value = null 
)

Add one or more variables to be set in mw.config in JavaScript.

Parameters
string | array$keysKey or array of key/value pairs
mixed | null$value[optional] Value of the configuration variable

Definition at line 3522 of file OutputPage.php.

References $keys.

Referenced by Article\showRedirectedFromHeader().

◆ addLanguageLinks()

OutputPage::addLanguageLinks ( array  $newLinkArray)

Add new language links.

Parameters
string[]$newLinkArrayArray of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')

Definition at line 1470 of file OutputPage.php.

◆ addLink()

OutputPage::addLink ( array  $linkarr)

Add a new \<link\> tag to the page header.

Note: use setCanonicalUrl() for rel=canonical.

Parameters
array$linkarrAssociative array of attributes.

Definition at line 479 of file OutputPage.php.

◆ addLinkHeader()

OutputPage::addLinkHeader (   $header)

Add an HTTP Link: header.

Parameters
string$headerHeader value

Definition at line 2524 of file OutputPage.php.

References $header.

◆ addMeta()

OutputPage::addMeta (   $name,
  $val 
)

Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:".

Parameters
string$nameName of the meta tag
string$valValue of the meta tag

Definition at line 458 of file OutputPage.php.

Referenced by Skin\initPage().

◆ addModules()

OutputPage::addModules (   $modules)

Load one or more ResourceLoader modules on this page.

Parameters
string | array$modulesModule name (string) or array of module names

Definition at line 612 of file OutputPage.php.

References $modules.

Referenced by ListToggle\__construct(), MWDebug\addModules(), Article\showPatrolFooter(), and Article\showRedirectedFromHeader().

◆ addModuleStyles()

OutputPage::addModuleStyles (   $modules)

Load the styles of one or more style-only ResourceLoader modules on this page.

Module styles added through this function will be loaded as a stylesheet, using a standard <link rel=stylesheet> HTML tag, rather than as a combined Javascript and CSS package. Thus, they will even load when JavaScript is disabled.

Parameters
string | array$modulesModule name (string) or array of module names

Definition at line 638 of file OutputPage.php.

References $modules.

Referenced by ListToggle\__construct(), Article\setOldSubtitle(), and Article\showPatrolFooter().

◆ addParserOutput()

OutputPage::addParserOutput ( ParserOutput  $parserOutput,
  $poOptions = [] 
)

Add everything from a ParserOutput object.

Parameters
ParserOutput$parserOutput
array$poOptionsOptions to ParserOutput::getText()

Definition at line 2231 of file OutputPage.php.

◆ addParserOutputContent()

OutputPage::addParserOutputContent ( ParserOutput  $parserOutput,
  $poOptions = [] 
)

Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput object, without any other metadata.

Since
1.24
Parameters
ParserOutput$parserOutput
array$poOptionsOptions to ParserOutput::getText()

Definition at line 2203 of file OutputPage.php.

References ParserOutput\getJsConfigVars(), ParserOutput\getModules(), and ParserOutput\getModuleStyles().

◆ addParserOutputMetadata()

◆ addParserOutputText()

OutputPage::addParserOutputText ( ParserOutput  $parserOutput,
  $poOptions = [] 
)

Add the HTML associated with a ParserOutput object, without any metadata.

Since
1.24
Parameters
ParserOutput$parserOutput
array$poOptionsOptions to ParserOutput::getText()

Definition at line 2219 of file OutputPage.php.

References ParserOutput\getText().

◆ addReturnTo()

OutputPage::addReturnTo (   $title,
array  $query = [],
  $text = null,
  $options = [] 
)

Add a "return to" link pointing to a specified title.

Parameters
LinkTarget$titleTitle to link
array$queryQuery string parameters
string | null$textText of the link (input is not escaped)
array$optionsOptions array to pass to Linker

Definition at line 3155 of file OutputPage.php.

References $title.

◆ addScript()

OutputPage::addScript (   $script)

Add raw HTML to the list of scripts (including \<script\> tag, etc.) Internal use only.

Use OutputPage::addModules() or OutputPage::addJsConfigVars() if possible.

Parameters
string$scriptRaw HTML

Definition at line 520 of file OutputPage.php.

Referenced by addScriptFile().

◆ addScriptFile()

OutputPage::addScriptFile (   $file,
  $unused = null 
)

Add a JavaScript file to be loaded as <script> on this page.

Internal use only. Use OutputPage::addModules() if possible.

Parameters
string$fileURL to file (absolute path, protocol-relative, or full url)
string | null$unusedPreviously used to change the cache-busting query parameter

Definition at line 532 of file OutputPage.php.

References $file, and addScript().

◆ addStyle()

OutputPage::addStyle (   $style,
  $media = '',
  $condition = '',
  $dir = '' 
)

Add a local or specified stylesheet, with the given media options.

Internal use only. Use OutputPage::addModuleStyles() if possible.

Parameters
string$styleURL to the file
string$mediaTo specify a media type, 'screen', 'printable', 'handheld' or any.
string$conditionFor IE conditional comments, specifying an IE version
string$dirSet to 'rtl' or 'ltr' for direction-specific sheets

Definition at line 4057 of file OutputPage.php.

◆ addSubtitle()

OutputPage::addSubtitle (   $str)

Add $str to the subtitle.

Parameters
string | Message$strString or Message to add to the subtitle. String should be safe HTML.

Definition at line 1201 of file OutputPage.php.

References getContext().

Referenced by Article\setOldSubtitle(), and Article\showRedirectedFromHeader().

◆ addTemplate()

OutputPage::addTemplate ( $template)

Add the output of a QuickTemplate to the output buffer.

Parameters
QuickTemplate&$template

Definition at line 2241 of file OutputPage.php.

◆ addVaryHeader()

OutputPage::addVaryHeader (   $header,
array  $option = null 
)

Add an HTTP header that will influence on the cache.

Parameters
string$headerHeader name
string[] | null$optionDeprecated; formerly options for the Key header, deprecated in 1.32 and removed in 1.34. See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for the list of formerly-valid options.

Definition at line 2490 of file OutputPage.php.

References $header, and wfDeprecatedMsg().

◆ addWikiMsg()

OutputPage::addWikiMsg (   $args)

Add a wikitext-formatted message to the output.

This is equivalent to:

$wgOut->addWikiText( wfMessage( ... )->plain() )

Parameters
mixed...$args

Definition at line 4323 of file OutputPage.php.

References $args.

Referenced by Article\doDelete().

◆ addWikiMsgArray()

OutputPage::addWikiMsgArray (   $name,
  $args 
)

Add a wikitext-formatted message to the output.

Like addWikiMsg() except the parameters are taken as an array instead of a variable argument list.

Parameters
string$name
array$args

Definition at line 4336 of file OutputPage.php.

References $args.

◆ addWikiTextAsContent()

OutputPage::addWikiTextAsContent (   $text,
  $linestart = true,
PageReference  $title = null 
)

Convert wikitext in the page content language to HTML and add it to the buffer.

The result with be language-converted to the user's preferred variant. Assumes that the current page title will be used if optional $title is not provided. Output will be tidy.

Parameters
string$textWikitext in the page content language
bool$linestartIs this the start of a line? (Defaults to true)
PageReference | null$titleOptional title to use; default of null means use current page title.
Exceptions
MWExceptionif $title is not provided and OutputPage::getTitle() is null
Since
1.32

Definition at line 2008 of file OutputPage.php.

References $title, and getTitle().

Referenced by Article\showMissingArticle().

◆ addWikiTextAsInterface()

OutputPage::addWikiTextAsInterface (   $text,
  $linestart = true,
PageReference  $title = null 
)

Convert wikitext in the user interface language to HTML and add it to the buffer.

The result will not be language-converted, as user interface messages are already localized into a specific variant. Assumes that the current page title will be used if optional $title is not provided. Output will be tidy.

Parameters
string$textWikitext in the user interface language
bool$linestartIs this the start of a line? (Defaults to true)
PageReference | null$titleOptional title to use; default of null means use current page title.
Exceptions
MWExceptionif $title is not provided and OutputPage::getTitle() is null
Since
1.32

Definition at line 1958 of file OutputPage.php.

References $title, and getTitle().

Referenced by Article\showMissingArticle().

◆ allowClickjacking()

OutputPage::allowClickjacking ( )

Turn off frame-breaking.

Alias for $this->preventClickjacking(false). This can be called from pages which do not contain any CSRF-protected HTML form.

Deprecated:
since 1.38, use ::setPreventClickjacking( false )

Definition at line 2583 of file OutputPage.php.

◆ buildBacklinkSubtitle()

static OutputPage::buildBacklinkSubtitle ( PageReference  $page,
  $query = [] 
)
static

Build message object for a subtitle containing a backlink to a page.

Since
1.25
Parameters
PageReference$pageTitle to link to
array$queryArray of additional parameters to include in the link
Returns
Message

Definition at line 1217 of file OutputPage.php.

References MediaWiki\Page\PageReference\getNamespace(), NS_SPECIAL, and wfMessage().

◆ buildCssLinksArray()

OutputPage::buildCssLinksArray ( )
Returns
array

Definition at line 4146 of file OutputPage.php.

References $file.

◆ buildExemptModules()

OutputPage::buildExemptModules ( )
protected

Build exempt modules and legacy non-ResourceLoader styles.

Returns
string|WrappedStringList HTML

Definition at line 4091 of file OutputPage.php.

◆ checkLastModified()

OutputPage::checkLastModified (   $timestamp)

checkLastModified tells the client to use the client-cached page if possible.

If successful, the OutputPage is disabled so that any future call to OutputPage->output() have no effect.

Side effect: sets mLastModified for Last-Modified header

Parameters
string$timestamp
Returns
bool True if cache-ok headers was sent.

Definition at line 808 of file OutputPage.php.

References disable(), ContextSource\getConfig(), ContextSource\getRequest(), getUser(), sendCacheControl(), wfDebug(), wfResetOutputBuffers(), and wfTimestamp().

◆ clearHTML()

OutputPage::clearHTML ( )

Clear the body HTML.

Definition at line 1797 of file OutputPage.php.

◆ clearSubtitle()

OutputPage::clearSubtitle ( )

Clear the subtitles.

Definition at line 1246 of file OutputPage.php.

◆ combineWrappedStrings()

static OutputPage::combineWrappedStrings ( array  $chunks)
staticprotected

Combine WrappedString chunks and filter out empty ones.

Parameters
array$chunks
Returns
string|WrappedStringList HTML

Definition at line 3467 of file OutputPage.php.

◆ considerCacheSettingsFinal()

OutputPage::considerCacheSettingsFinal ( )

Set the expectation that cache control will not change after this point.

This should be called after the main processing logic has completed (e.g. Action::show or SpecialPage::execute), but may be called before Skin output has started (OutputPage::output).

Since
1.34

Definition at line 2439 of file OutputPage.php.

◆ couldBePublicCached()

OutputPage::couldBePublicCached ( )

Whether the output might become publicly cached.

Since
1.34
Returns
bool

Definition at line 2416 of file OutputPage.php.

◆ disable()

OutputPage::disable ( )

Disable output completely, i.e.

calling output() will have no effect

Definition at line 1277 of file OutputPage.php.

Referenced by checkLastModified().

◆ disableClientCache()

OutputPage::disableClientCache ( )

Force the page to send nocache headers.

Since
1.38

Definition at line 2406 of file OutputPage.php.

Referenced by SkinFallback\initPage().

◆ disallowUserJs()

OutputPage::disallowUserJs ( )

Do not allow scripts which can be modified by wiki users to load on this page; only allow scripts bundled with, or generated by, the software.

Site-wide styles are controlled by a config setting, since they can be used to create a custom skin/theme, but not user-specific ones.

Todo:
this should be given a more accurate name

Definition at line 1717 of file OutputPage.php.

◆ enableClientCache()

OutputPage::enableClientCache (   $state)

Use enableClientCache(false) to force it to send nocache headers.

Parameters
bool | null$stateNew value, or null to not set the value
Returns
bool Old value
Deprecated:
since 1.38; use disableClientCache() instead ($state is almost always false when this method is called)

Definition at line 2397 of file OutputPage.php.

References wfDeprecated(), and wfSetVar().

◆ enableOOUI()

OutputPage::enableOOUI ( )

Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with MediaWiki and this OutputPage instance.

Since
1.25

Definition at line 4412 of file OutputPage.php.

◆ filterModules()

OutputPage::filterModules ( array  $modules,
  $position = null,
  $type = RL\Module::TYPE_COMBINED 
)
protected

Filter an array of modules to remove insufficiently trustworthy members, and modules which are no longer registered (eg a page is cached before an extension is disabled)

Parameters
string[]$modules
string | null$positionUnused
string$type
Returns
string[]

Definition at line 554 of file OutputPage.php.

References $modules, $type, and getResourceLoader().

Referenced by getModules().

◆ forceHideNewSectionLink()

OutputPage::forceHideNewSectionLink ( )

Forcibly hide the new section link?

Returns
bool

Definition at line 1304 of file OutputPage.php.

◆ formatPermissionsErrorMessage()

OutputPage::formatPermissionsErrorMessage ( array  $errors,
  $action = null 
)

Format a list of error messages.

Deprecated:
since 1.36. Use ::formatPermissionStatus instead
Parameters
array$errorsArray of arrays returned by PermissionManager::getPermissionErrors
string | null$actionAction that was denied or null if unknown
Returns
string The wikitext error-messages, formatted into a list.

Definition at line 3082 of file OutputPage.php.

◆ formatPermissionStatus()

OutputPage::formatPermissionStatus ( PermissionStatus  $status,
string  $action = null 
)

Format permission $status obtained from Authority for display.

Parameters
PermissionStatus$status
string | null$actionthat was denied or null if unknown
Returns
string

Definition at line 3066 of file OutputPage.php.

◆ getAdvertisedFeedTypes()

OutputPage::getAdvertisedFeedTypes ( )
protected

Return effective list of advertised feed types.

See also
addFeedLink()
Returns
string[] Array of feed type names ( 'rss', 'atom' )

Definition at line 1330 of file OutputPage.php.

◆ getAllowedModules()

OutputPage::getAllowedModules (   $type)

Show what level of JavaScript / CSS untrustworthiness is allowed on this page.

See also
RL\Module::$origin
Parameters
string$typeRL\Module TYPE_ constant
Returns
int Module ORIGIN_ class constant

Definition at line 1742 of file OutputPage.php.

References $type.

◆ getArticleBodyOnly()

OutputPage::getArticleBodyOnly ( )

Return whether the output will contain only the body of the article.

Returns
bool

Definition at line 771 of file OutputPage.php.

◆ getBottomScripts()

OutputPage::getBottomScripts ( )

JS stuff to put at the bottom of the <body>.

These are legacy scripts ($this->mScripts), and user JS.

Returns
string|WrappedStringList HTML

Definition at line 3479 of file OutputPage.php.

◆ getCacheVaryCookies()

OutputPage::getCacheVaryCookies ( )

Get the list of cookie names that will influence the cache.

Returns
array

Definition at line 2448 of file OutputPage.php.

◆ getCanonicalUrl()

OutputPage::getCanonicalUrl ( )

Returns the URL to be used for the <link rel=canonical>> if one is set.

Since
1.25
Returns
bool|string

Definition at line 509 of file OutputPage.php.

◆ getCategories()

OutputPage::getCategories (   $type = 'all')

Get the list of category names this page belongs to.

Parameters
string$typeThe type of categories which should be returned. Possible values:
  • all: all categories of all types
  • hidden: only the hidden categories
  • normal: all categories, except hidden categories
Returns
string[]

Definition at line 1620 of file OutputPage.php.

References $type.

◆ getCategoryLinks()

OutputPage::getCategoryLinks ( )

Get the list of category links, in a 2-D array with the following format: $arr[$type][] = $link, where $type is either "normal" or "hidden" (for hidden categories) and $link a HTML fragment with a link to the category page.

Returns
string[][]
-taint none

Definition at line 1607 of file OutputPage.php.

◆ getCSP()

OutputPage::getCSP ( )

Get the ContentSecurityPolicy object.

Since
1.35
Returns
ContentSecurityPolicy

Definition at line 4445 of file OutputPage.php.

◆ getCSPNonce()

OutputPage::getCSPNonce ( )

Get (and set if not yet set) the CSP nonce.

This value needs to be included in any <script> tags on the page.

Returns
string|false Nonce or false to mean don't output nonce
Since
1.32
Deprecated:
Since 1.35 use getCSP()->getNonce() instead

Definition at line 4435 of file OutputPage.php.

◆ getDisplayTitle()

OutputPage::getDisplayTitle ( )

Returns page display title.

Performs some normalization, but this not as strict the magic word.

Since
1.32
Returns
string HTML

Definition at line 1129 of file OutputPage.php.

References getTitle().

◆ getFeedAppendQuery()

OutputPage::getFeedAppendQuery ( )

Will currently always return null.

Returns
null

Definition at line 1392 of file OutputPage.php.

◆ getFileSearchOptions()

OutputPage::getFileSearchOptions ( )

Get the files used on this page.

Returns
array [ dbKey => [ 'time' => MW timestamp or null, 'sha1' => sha1 or '' ] ]
Since
1.18

Definition at line 1938 of file OutputPage.php.

◆ getFileVersion()

OutputPage::getFileVersion ( )

Get the displayed file version.

Returns
array|null ('time' => MW timestamp, 'sha1' => sha1)

Definition at line 1918 of file OutputPage.php.

◆ getFollowPolicy()

OutputPage::getFollowPolicy ( )

Get the current follow policy for the page as a string.

Returns
string

Definition at line 1036 of file OutputPage.php.

◆ getFrameOptions()

OutputPage::getFrameOptions ( )

Get the X-Frame-Options header value (without the name part), or false if there isn't one.

This is used by Skin to determine whether to enable JavaScript frame-breaking, for clients that don't support X-Frame-Options.

Returns
string|false

Definition at line 2626 of file OutputPage.php.

◆ getHeadItemsArray()

OutputPage::getHeadItemsArray ( )

Get an array of head items.

Returns
array

Definition at line 705 of file OutputPage.php.

◆ getHeadLinksArray()

OutputPage::getHeadLinksArray ( )
Returns
array Array in format "link name or number => 'link html'".

Definition at line 3758 of file OutputPage.php.

References $lang, $type, getAuthority(), getContext(), getTitle(), SpecialPage\getTitleFor(), MW_VERSION, PROTO_CANONICAL, PROTO_RELATIVE, wfAppendQuery(), wfExpandUrl(), and wfScript().

◆ getHTML()

OutputPage::getHTML ( )

Get the body HTML.

Returns
string HTML

Definition at line 1806 of file OutputPage.php.

◆ getHTMLTitle()

OutputPage::getHTMLTitle ( )

Return the "HTML title", i.e.

the content of the "<title>" tag.

Returns
string

Definition at line 1059 of file OutputPage.php.

Referenced by Skin\initPage().

◆ getIndexPolicy()

OutputPage::getIndexPolicy ( )

Get the current index policy for the page as a string.

Returns
string

Definition at line 1014 of file OutputPage.php.

◆ getIndicators()

OutputPage::getIndicators ( )

Get the indicators associated with this page.

The array will be internally ordered by item keys.

Returns
string[] Keys: identifiers, values: HTML contents
Since
1.25

Definition at line 1661 of file OutputPage.php.

◆ getJsConfigVars()

OutputPage::getJsConfigVars ( )

Get the javascript config vars to include on this page.

Returns
array Array of javascript config vars
Since
1.23

Definition at line 3512 of file OutputPage.php.

◆ getJSVars()

OutputPage::getJSVars ( )

Get an array containing the variables to be set in mw.config in JavaScript.

Do not add things here which can be evaluated in RL\StartUpModule

  • in other words, page-independent/site-wide variables (without state). You will only be adding bloat to the html page and causing page caches to have to be purged on configuration changes.
    Returns
    array

Definition at line 3542 of file OutputPage.php.

References $lang, $title, $type, getAuthority(), getContext(), getTitle(), getUser(), NS_SPECIAL, and wfTimestamp().

◆ getLanguageLinks()

OutputPage::getLanguageLinks ( )

Get the list of language links.

Returns
string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')

Definition at line 1489 of file OutputPage.php.

◆ getLinkHeader()

OutputPage::getLinkHeader ( )

Return a Link: header.

Based on the values of $mLinkHeader.

Returns
string|false

Definition at line 2533 of file OutputPage.php.

◆ getLinkTags()

OutputPage::getLinkTags ( )

Returns the current <link> tags.

Since
1.25
Returns
array

Definition at line 489 of file OutputPage.php.

◆ getMetaTags()

OutputPage::getMetaTags ( )

Returns the current <meta> tags.

Since
1.25
Returns
array

Definition at line 468 of file OutputPage.php.

◆ getModules()

OutputPage::getModules (   $filter = false,
  $position = null,
  $param = 'mModules',
  $type = RL\Module::TYPE_COMBINED 
)

Get the list of modules to include on this page.

Parameters
bool$filterWhether to filter out insufficiently trustworthy modules
string | null$positionUnused
string$param
string$type
Returns
string[] Array of module names

Definition at line 598 of file OutputPage.php.

References $modules, $type, and filterModules().

Referenced by getModuleStyles().

◆ getModuleStyles()

OutputPage::getModuleStyles (   $filter = false,
  $position = null 
)

Get the list of style-only modules to load on this page.

Parameters
bool$filter
string | null$positionUnused
Returns
string[] Array of module names

Definition at line 623 of file OutputPage.php.

References getModules().

◆ getPageTitle()

OutputPage::getPageTitle ( )

Return the "page title", i.e.

the content of the \<h1\> tag.

Returns
string

Definition at line 1106 of file OutputPage.php.

◆ getPreventClickjacking()

OutputPage::getPreventClickjacking ( )

Get the prevent-clickjacking flag.

Since
1.24
Returns
bool

Definition at line 2615 of file OutputPage.php.

◆ getProperty()

OutputPage::getProperty (   $name)

Get an additional output property.

Since
1.21
Parameters
string$name
Returns
mixed Property value or null if not found

Definition at line 793 of file OutputPage.php.

◆ getRedirect()

OutputPage::getRedirect ( )

Get the URL to redirect to, or an empty string if not redirect URL set.

Returns
string

Definition at line 426 of file OutputPage.php.

◆ getResourceLoader()

OutputPage::getResourceLoader ( )

Get a ResourceLoader object associated with this OutputPage.

Returns
ResourceLoader

Definition at line 3432 of file OutputPage.php.

Referenced by filterModules().

◆ getRevisionId()

OutputPage::getRevisionId ( )

Get the displayed revision ID.

Returns
int|null

Definition at line 1850 of file OutputPage.php.

◆ getRevisionTimestamp()

OutputPage::getRevisionTimestamp ( )

Get the timestamp of displayed revision.

This will be null if not filled by setRevisionTimestamp().

Returns
string|null

Definition at line 1895 of file OutputPage.php.

◆ getRlClient()

OutputPage::getRlClient ( )

Call this to freeze the module queue and JS config and create a formatter.

Depending on the Skin, this may get lazy-initialised in either headElement() or getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may cause unexpected side-effects since disallowUserJs() may be called at any time to change the module filters retroactively. Skins and extension hooks may also add modules until very late in the request lifecycle.

Returns
RL\ClientHtml

Definition at line 3253 of file OutputPage.php.

References $dbr, DB_REPLICA, MediaWiki\ResourceLoader\ClientHtml\setConfig(), and wfGetDB().

◆ getRobotPolicy()

OutputPage::getRobotPolicy ( )

Get the current robot policy for the page as a string in the form <index policy>,<follow policy>.

Returns
string

Definition at line 940 of file OutputPage.php.

◆ getSections()

OutputPage::getSections ( )
Access: internal
For usage in Skin::getSectionsData() only.
Returns
array Array of sections. Empty if OutputPage::setSections() has not been called.

Definition at line 2059 of file OutputPage.php.

◆ getSubtitle()

OutputPage::getSubtitle ( )
Returns
string

Definition at line 1253 of file OutputPage.php.

◆ getSyndicationLinks()

OutputPage::getSyndicationLinks ( )

Return URLs for each supported syndication format for this page.

Returns
array Associating format keys with URLs

Definition at line 1383 of file OutputPage.php.

◆ getTarget()

OutputPage::getTarget ( )
Returns
null|string ResourceLoader target

Definition at line 645 of file OutputPage.php.

◆ getTemplateIds()

OutputPage::getTemplateIds ( )

Get the templates used on this page.

Returns
array (namespace => dbKey => revId)
Since
1.18

Definition at line 1928 of file OutputPage.php.

◆ getUnprefixedDisplayTitle()

OutputPage::getUnprefixedDisplayTitle ( )

Returns page display title without namespace prefix if possible.

This method is unreliable and best avoided. (T314399)

Since
1.32
Returns
string HTML

Definition at line 1146 of file OutputPage.php.

References $matches, Parser\formatPageTitle(), and getTitle().

◆ getVaryHeader()

OutputPage::getVaryHeader ( )

Return a Vary: header on which to vary caches.

Based on the keys of $mVaryHeader, such as Accept-Encoding or Cookie

Returns
string

Definition at line 2507 of file OutputPage.php.

References $header.

◆ hasHeadItem()

OutputPage::hasHeadItem (   $name)

Check if the header item $name is already set.

Parameters
string$nameItem name
Returns
bool

Definition at line 741 of file OutputPage.php.

◆ haveCacheVaryCookies()

OutputPage::haveCacheVaryCookies ( )

Check if the request has a cache-varying cookie header If it does, it's very important that we don't allow public caching.

Returns
bool

Definition at line 2469 of file OutputPage.php.

References wfDebug().

◆ headElement()

OutputPage::headElement ( Skin  $sk,
  $includeStyle = true 
)
Parameters
Skin$skThe given Skin
bool$includeStyleUnused
Returns
string The doctype, opening "<html>", and head element.

Definition at line 3338 of file OutputPage.php.

References getContext(), Skin\getHtmlElementAttributes(), Skin\getOptions(), Skin\getPageClasses(), Skin\getSkinName(), getTitle(), getUser(), Skin\isResponsive(), and wfDeprecated().

◆ isArticle()

OutputPage::isArticle ( )

Return whether the content displayed page is related to the source of the corresponding article on the wiki.

Returns
bool

Definition at line 1416 of file OutputPage.php.

◆ isArticleRelated()

OutputPage::isArticleRelated ( )

Return whether this page is related an article on the wiki.

Returns
bool

Definition at line 1438 of file OutputPage.php.

◆ isDisabled()

OutputPage::isDisabled ( )

Return whether the output will be completely disabled.

Returns
bool

Definition at line 1286 of file OutputPage.php.

◆ isPrintable()

OutputPage::isPrintable ( )

Return whether the page is "printable".

Returns
bool

Definition at line 1270 of file OutputPage.php.

◆ isRevisionCurrent()

OutputPage::isRevisionCurrent ( )

Whether the revision displayed is the latest revision of the page.

Since
1.34
Returns
bool

Definition at line 1870 of file OutputPage.php.

◆ isSyndicated()

OutputPage::isSyndicated ( )

Should we output feed links for this page?

Returns
bool

Definition at line 1375 of file OutputPage.php.

◆ isTOCEnabled()

OutputPage::isTOCEnabled ( )

Whether the output has a table of contents.

Returns
bool
Since
1.22

Definition at line 4386 of file OutputPage.php.

◆ loadSkinModules()

OutputPage::loadSkinModules (   $sk)

Transfer styles and JavaScript modules from skin.

Parameters
Skin$skto load modules for

Definition at line 2750 of file OutputPage.php.

References $modules.

◆ lowerCdnMaxage()

OutputPage::lowerCdnMaxage (   $maxage)

Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is lower than the current s-maxage.

Either way, $maxage is now an upper limit on s-maxage, so that future calls to setCdnMaxage() will no longer be able to raise the s-maxage above $maxage.

Parameters
int$maxageMaximum cache time on the CDN, in seconds
Since
1.27

Definition at line 2356 of file OutputPage.php.

◆ makeResourceLoaderLink()

OutputPage::makeResourceLoaderLink (   $modules,
  $only,
array  $extraQuery = [] 
)

Explicitly load or embed modules on a page.

Parameters
array | string$modulesOne or more module names
string$onlyRL\Module TYPE_ class constant
array$extraQuery[optional] Array with extra query parameters for the request
Returns
string|WrappedStringList HTML

Definition at line 3448 of file OutputPage.php.

References $modules.

◆ output()

OutputPage::output (   $return = false)

Finally, all the text has been munged and accumulated into the object, let's actually output it:

Parameters
bool$returnSet to true to get the result as a string rather than sending it
Returns
string|null
Exceptions
Exception
FatalError
MWException

Definition at line 2772 of file OutputPage.php.

References $content, print, PROTO_CURRENT, wfExpandUrl(), and wfTimestamp().

◆ parseAsContent()

OutputPage::parseAsContent (   $text,
  $linestart = true 
)

Parse wikitext in the page content language and return the HTML.

The result will be language-converted to the user's preferred variant. Output will be tidy.

Parameters
string$textWikitext in the page content language
bool$linestartIs this the start of a line? (Defaults to true)
Exceptions
MWException
Returns
string HTML
Since
1.32

Definition at line 2256 of file OutputPage.php.

References getTitle().

◆ parseAsInterface()

OutputPage::parseAsInterface (   $text,
  $linestart = true 
)

Parse wikitext in the user interface language and return the HTML.

The result will not be language-converted, as user interface messages are already localized into a specific variant. Output will be tidy.

Parameters
string$textWikitext in the user interface language
bool$linestartIs this the start of a line? (Defaults to true)
Exceptions
MWException
Returns
string HTML
Since
1.32

Definition at line 2277 of file OutputPage.php.

References getTitle().

◆ parseInlineAsInterface()

OutputPage::parseInlineAsInterface (   $text,
  $linestart = true 
)

Parse wikitext in the user interface language, strip paragraph wrapper, and return the HTML.

The result will not be language-converted, as user interface messages are already localized into a specific variant. Output will be tidy. Outer paragraph wrapper will only be stripped if the result is a single paragraph.

Parameters
string$textWikitext in the user interface language
bool$linestartIs this the start of a line? (Defaults to true)
Exceptions
MWException
Returns
string HTML
Since
1.32

Definition at line 2300 of file OutputPage.php.

References Parser\stripOuterParagraph().

◆ parserOptions()

OutputPage::parserOptions ( )

Get/set the ParserOptions object to use for wikitext parsing.

Returns
ParserOptions

Definition at line 1815 of file OutputPage.php.

References getContext(), and getUser().

◆ prepareErrorPage()

OutputPage::prepareErrorPage (   $pageTitle,
  $htmlTitle = false 
)

Prepare this object to display an error page; disable caching and indexing, clear the current text and redirect, set the page's title and optionally an custom HTML title (content of the "<title>" tag).

Parameters
string | Message$pageTitleWill be passed directly to setPageTitle()
string | Message | false$htmlTitleWill be passed directly to setHTMLTitle(); optional, if not passed the "<title>" attribute will be based on $pageTitle

Definition at line 2911 of file OutputPage.php.

◆ prependHTML()

OutputPage::prependHTML (   $text)

Prepend $text to the body HTML.

Parameters
string$textHTML

Definition at line 1768 of file OutputPage.php.

◆ preventClickjacking()

OutputPage::preventClickjacking (   $enable = true)

Set a flag which will cause an X-Frame-Options header appropriate for edit pages to be sent.

The header value is controlled by $wgEditPageFrameOptions.

This is the default for special pages. If you display a CSRF-protected form on an ordinary view page, then you need to call this function.

Parameters
bool$enable
Deprecated:
since 1.38, use ::setPreventClickjacking( true )

Definition at line 2572 of file OutputPage.php.

◆ redirect()

OutputPage::redirect (   $url,
  $responsecode = '302' 
)

Redirect to $url rather than displaying the normal page.

Parameters
string$url
string | int$responsecodeHTTP status code

Definition at line 415 of file OutputPage.php.

Referenced by PageDataRequestHandler\httpContentNegotiation().

◆ reduceAllowedModules()

OutputPage::reduceAllowedModules (   $type,
  $level 
)

Limit the highest level of CSS/JS untrustworthiness allowed.

If passed the same or a higher level than the current level of untrustworthiness set, the level will remain unchanged.

Parameters
string$type
int$levelRL\Module class constant

Definition at line 1759 of file OutputPage.php.

References $type.

◆ returnToMain()

OutputPage::returnToMain (   $unused = null,
  $returnto = null,
  $returntoquery = null 
)

Add a "return to" link pointing to a specified title, or the title indicated in the request, or else the main page.

Parameters
mixed | null$unused
PageReference | LinkTarget | string | null$returntoPage to return to
string | null$returntoqueryQuery string for the return to link

Definition at line 3171 of file OutputPage.php.

References wfCgiToArray().

Referenced by Article\doDelete().

◆ sendCacheControl()

OutputPage::sendCacheControl ( )

Send cache control HTTP headers.

Definition at line 2682 of file OutputPage.php.

References wfDebug().

Referenced by checkLastModified().

◆ setArticleBodyOnly()

OutputPage::setArticleBodyOnly (   $only)

Set whether the output should only contain the body of the article, without any skin, sidebar, etc.

Used e.g. when calling with "action=render".

Parameters
bool$onlyWhether to output only the body of the article

Definition at line 762 of file OutputPage.php.

◆ setArticleFlag()

OutputPage::setArticleFlag (   $newVal)

Set whether the displayed content is related to the source of the corresponding article on the wiki Setting true will cause the change "article related" toggle to true.

Parameters
bool$newVal

Definition at line 1403 of file OutputPage.php.

◆ setArticleRelated()

OutputPage::setArticleRelated (   $newVal)

Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false.

Parameters
bool$newVal

Definition at line 1426 of file OutputPage.php.

◆ setCanonicalUrl()

OutputPage::setCanonicalUrl (   $url)

Set the URL to be used for the <link rel=canonical>>.

This should be used in preference to addLink(), to avoid duplicate link tags.

Parameters
string$url

Definition at line 498 of file OutputPage.php.

Referenced by Article\showRedirectedFromHeader().

◆ setCategoryLinks()

OutputPage::setCategoryLinks ( array  $categories)

Reset the category links (but not the category list) and add $categories.

Parameters
array$categoriesMapping category name => sort key

Definition at line 1593 of file OutputPage.php.

◆ setCdnMaxage()

OutputPage::setCdnMaxage (   $maxage)

Set the value of the "s-maxage" part of the "Cache-control" HTTP header.

Parameters
int$maxageMaximum cache time on the CDN, in seconds.

Definition at line 2343 of file OutputPage.php.

◆ setCopyright()

OutputPage::setCopyright (   $hasCopyright)

Set whether the standard copyright should be shown for the current page.

Parameters
bool$hasCopyright

Definition at line 1447 of file OutputPage.php.

◆ setCopyrightUrl()

OutputPage::setCopyrightUrl (   $url)

Set the copyright URL to send with the output.

Empty string to omit, null to reset.

Since
1.26
Parameters
string | null$url

Definition at line 438 of file OutputPage.php.

◆ setDisplayTitle()

OutputPage::setDisplayTitle (   $html)

Same as page title but only contains name of the page, not any other text.

Since
1.32
Parameters
string$htmlPage title text.
See also
OutputPage::setPageTitle

Definition at line 1117 of file OutputPage.php.

◆ setFeedAppendQuery()

OutputPage::setFeedAppendQuery (   $val)

Add default feeds to the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.

See also
addFeedLink()
Parameters
string | false$valQuery to append to feed links or false to output default links

Definition at line 1347 of file OutputPage.php.

References $type, and getTitle().

◆ setFileVersion()

OutputPage::setFileVersion (   $file)

Set the displayed file version.

Parameters
File | null$file
Returns
mixed Previous value

Definition at line 1905 of file OutputPage.php.

References $file, File\exists(), and wfSetVar().

◆ setFollowPolicy()

OutputPage::setFollowPolicy (   $policy)

Set the follow policy for the page, but leave the index policy un- touched.

Parameters
string$policyEither 'follow' or 'nofollow'.

Definition at line 1024 of file OutputPage.php.

Referenced by setRobotPolicy(), and Article\showMissingArticle().

◆ setHTMLTitle()

OutputPage::setHTMLTitle (   $name)

"HTML title" means the contents of "<title>".

It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.

Parameters
string | Message$name

Definition at line 1046 of file OutputPage.php.

References getContext().

◆ setIndexPolicy()

OutputPage::setIndexPolicy (   $policy)

Set the index policy for the page, but leave the follow policy un- touched.

Parameters
string$policyEither 'index' or 'noindex'.

Definition at line 1002 of file OutputPage.php.

Referenced by setRobotPolicy(), and Article\showMissingArticle().

◆ setIndicators()

OutputPage::setIndicators ( array  $indicators)

Add an array of indicators, with their identifiers as array keys and HTML contents as values.

In case of duplicate keys, existing values are overwritten.

Note
External code which calls this method should ensure that any indicators sourced from parsed wikitext are wrapped with the appropriate class; see note in ::getIndicators().
Parameters
string[]$indicators
Since
1.25

Definition at line 1647 of file OutputPage.php.

◆ setLanguageLinks()

OutputPage::setLanguageLinks ( array  $newLinkArray)

Reset the language links and add new language links.

Parameters
string[]$newLinkArrayArray of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')

Definition at line 1480 of file OutputPage.php.

◆ setLastModified()

OutputPage::setLastModified (   $timestamp)

Override the last modified timestamp.

Parameters
string$timestampNew timestamp, in a format readable by wfTimestamp()

Definition at line 912 of file OutputPage.php.

References wfTimestamp().

◆ setPageTitle()

OutputPage::setPageTitle (   $name)

"Page title" means the contents of \<h1\>.

It is stored as a valid HTML fragment. This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>. This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed. Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.

Parameters
string | Message$name
-taint$nametainted Phan-taint-check gets very confused by $name being either a string or a Message

Definition at line 1084 of file OutputPage.php.

References getContext().

Referenced by Article\doDelete().

◆ setPreventClickjacking()

OutputPage::setPreventClickjacking ( bool  $enable)

Set the prevent-clickjacking flag.

If true, will cause an X-Frame-Options header appropriate for edit pages to be sent. The header value is controlled by $wgEditPageFrameOptions. This is the default for special pages. If you display a CSRF-protected form on an ordinary view page, then you need to call this function.

Setting this flag to false will turn off frame-breaking. This can be called from pages which do not contain any CSRF-protected HTML form.

Parameters
bool$enableIf true, will cause an X-Frame-Options header appropriate for edit pages to be sent.
Since
1.38

Definition at line 2605 of file OutputPage.php.

Referenced by Article\showPatrolFooter().

◆ setPrintable()

OutputPage::setPrintable ( )

Set the page as printable, i.e.

it'll be displayed with all print styles included

Definition at line 1261 of file OutputPage.php.

◆ setProperty()

OutputPage::setProperty (   $name,
  $value 
)

Set an additional output property.

Since
1.21
Parameters
string$name
mixed$value

Definition at line 782 of file OutputPage.php.

◆ setRedirectedFrom()

OutputPage::setRedirectedFrom ( PageReference  $t)

Set $mRedirectedFrom, the page which redirected us to the current page.

Parameters
PageReference$t

Definition at line 1068 of file OutputPage.php.

References $t.

Referenced by Article\showRedirectedFromHeader().

◆ setRevisionId()

OutputPage::setRevisionId (   $revid)

Set the revision ID which will be seen by the wiki text parser for things such as embedded {{REVISIONID}} variable use.

Parameters
int | null$revidA positive integer, or null
Returns
mixed Previous value

Definition at line 1840 of file OutputPage.php.

References wfSetVar().

◆ setRevisionIsCurrent()

OutputPage::setRevisionIsCurrent ( bool  $isCurrent)

Set whether the revision displayed (as set in ::setRevisionId()) is the latest revision of the page.

Parameters
bool$isCurrent

Definition at line 1860 of file OutputPage.php.

◆ setRevisionTimestamp()

OutputPage::setRevisionTimestamp (   $timestamp)

Set the timestamp of the revision which will be displayed.

This is used to avoid a extra DB call in Skin::lastModified().

Parameters
string | null$timestamp
Returns
mixed Previous value

Definition at line 1885 of file OutputPage.php.

References wfSetVar().

◆ setRobotPolicy()

OutputPage::setRobotPolicy (   $policy)

Set the robot policy for the page: http://www.robotstxt.org/meta.html

Parameters
string$policyThe literal string to output as the contents of the meta tag. Will be parsed according to the spec and output in standardized form.

Definition at line 923 of file OutputPage.php.

References setFollowPolicy(), and setIndexPolicy().

Referenced by Article\doDelete().

◆ setRobotsOptions()

OutputPage::setRobotsOptions ( array  $options = [])

Set the robots policy with options for the page.

Since
1.38
Parameters
array$optionsAn array of key-value pairs or a string to populate the robots meta tag content attribute as a string.

Definition at line 971 of file OutputPage.php.

◆ setSections()

OutputPage::setSections ( array  $sections)

Adds sections to OutputPage from ParserOutput.

Parameters
array$sections
Access: internal
For use by Article.php

Definition at line 2050 of file OutputPage.php.

◆ setStatusCode()

OutputPage::setStatusCode (   $statusCode)

Set the HTTP status code to send with the output.

Parameters
int$statusCode

Definition at line 447 of file OutputPage.php.

◆ setSubtitle()

OutputPage::setSubtitle (   $str)

Replace the subtitle with $str.

Parameters
string | Message$strNew value of the subtitle. String should be safe HTML.

Definition at line 1191 of file OutputPage.php.

◆ setSyndicated()

OutputPage::setSyndicated (   $show = true)

Add or remove feed links in the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.

See also
addFeedLink()
Parameters
bool$showTrue: add default feeds, false: remove all feeds

Definition at line 1316 of file OutputPage.php.

◆ setTarget()

OutputPage::setTarget (   $target)

Sets ResourceLoader target for load.php links.

If null, will be omitted

Parameters
string | null$target

Definition at line 654 of file OutputPage.php.

◆ setTitle()

OutputPage::setTitle ( PageReference  $t)

Set the Title object to use.

Parameters
PageReference$t

Definition at line 1178 of file OutputPage.php.

References $t, and getContext().

◆ setupOOUI()

static OutputPage::setupOOUI (   $skinName = 'default',
  $dir = 'ltr' 
)
static

Helper function to setup the PHP implementation of OOUI to use in this request.

Since
1.26
Parameters
string$skinNameThe Skin name to determine the correct OOUI theme
string$dirLanguage direction

Definition at line 4397 of file OutputPage.php.

◆ showErrorPage()

OutputPage::showErrorPage (   $title,
  $msg,
  $params = [],
  $returnto = null,
  $returntoquery = null 
)

Output a standard error page.

showErrorPage( 'titlemsg', 'pagetextmsg' ); showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] ); showErrorPage( 'titlemsg', $messageObject ); showErrorPage( $titleMessageObject, $messageObject );

Parameters
string | Message$titleMessage key (string) for page title, or a Message object
string | Message$msgMessage key (string) for page text, or a Message object
array$paramsMessage parameters; ignored if $msg is a Message object
PageReference | LinkTarget | string | null$returntoPage to show a return link to; defaults to the 'returnto' URL parameter
string | null$returntoqueryQuery string for the return to link; defaults to the 'returntoquery' URL parameter

Definition at line 2940 of file OutputPage.php.

References $title.

◆ showFatalError()

OutputPage::showFatalError (   $message)

Output an error page.

Note
FatalError exception class provides an alternative.
Parameters
string$messageError to output. Must be escaped for HTML.

Definition at line 3141 of file OutputPage.php.

◆ showLagWarning()

OutputPage::showLagWarning (   $lag)

Show a warning about replica DB lag.

If the lag is higher than $wgDatabaseReplicaLagCritical seconds, then the warning is a bit more obvious. If the lag is lower than $wgDatabaseReplicaLagWarning, then no warning is shown.

Parameters
int$lagReplica lag

Definition at line 3122 of file OutputPage.php.

◆ showNewSectionLink()

OutputPage::showNewSectionLink ( )

Show an "add new section" link?

Returns
bool

Definition at line 1295 of file OutputPage.php.

◆ showPermissionsErrorPage()

OutputPage::showPermissionsErrorPage ( array  $errors,
  $action = null 
)

Output a standard permission error page.

Parameters
array$errorsError message keys or [key, param...] arrays
string | null$actionAction that was denied or null if unknown

Definition at line 2969 of file OutputPage.php.

References $title, getAuthority(), SpecialPage\getTitleFor(), getUser(), PROTO_RELATIVE, and wfArrayToCgi().

◆ showsCopyright()

OutputPage::showsCopyright ( )

Return whether the standard copyright should be shown for the current page.

By default, it is true for all articles but other pages can signal it by using setCopyright( true ).

Used by SkinTemplate to decided whether to show the copyright.

Returns
bool

Definition at line 1460 of file OutputPage.php.

◆ styleLink()

OutputPage::styleLink (   $style,
array  $options 
)
protected

Generate \<link\> tags for stylesheets.

Parameters
string$styleURL to the file
array$optionsOption, can contain 'condition', 'dir', 'media' keys
Returns
string HTML fragment

Definition at line 4165 of file OutputPage.php.

◆ tailElement()

OutputPage::tailElement (   $skin)

The final bits that go to the bottom of a page HTML document including the closing tags.

Access: internal
Since
1.37
Parameters
Skin$skin
Returns
string

Definition at line 4458 of file OutputPage.php.

References wfReportTime().

◆ transformCssMedia()

static OutputPage::transformCssMedia (   $media)
static

Transform "media" attribute based on request parameters.

Parameters
string$mediaCurrent value of the "media" attribute
Returns
string|null Modified value of the "media" attribute, or null to disable this stylesheet

Definition at line 4284 of file OutputPage.php.

References $wgRequest.

◆ transformFilePath()

static OutputPage::transformFilePath (   $remotePathPrefix,
  $localPath,
  $file 
)
static

Utility method for transformResourceFilePath().

Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.

Since
1.27
Parameters
string$remotePathPrefixURL path prefix that points to $localPath
string$localPathFile directory exposed at $remotePath
string$filePath to target file relative to $localPath
Returns
string URL

Definition at line 4262 of file OutputPage.php.

References wfLogWarning().

◆ transformResourcePath()

static OutputPage::transformResourcePath ( Config  $config,
  $path 
)
static

Transform path to web-accessible static resource.

This is used to add a validation hash as query string. This aids various behaviors:

  • Put long Cache-Control max-age headers on responses for improved cache performance.
  • Get the correct version of a file as expected by the current page.
  • Instantly get the updated version of a file after deployment.

Avoid using this for urls included in HTML as otherwise clients may get different versions of a resource when navigating the site depending on when the page was cached. If changes to the url propagate, this is not a problem (e.g. if the url is in an external stylesheet).

Since
1.27
Parameters
Config$config
string$pathPath-absolute URL to file (from document root, must start with "/")
Returns
string URL

Definition at line 4222 of file OutputPage.php.

References $path, and Config\get().

◆ userCanPreview()

OutputPage::userCanPreview ( )

To make it harder for someone to slip a user a fake JavaScript or CSS preview, a random token is associated with the login session.

If it's not passed back with the preview request, we won't render the code.

Returns
bool

Definition at line 3728 of file OutputPage.php.

References $title, getAuthority(), getTitle(), and getUser().

◆ versionRequired()

OutputPage::versionRequired (   $version)

Display an error page indicating that a given version of MediaWiki is required to use it.

Parameters
mixed$versionThe version of MediaWiki needed to use the page

Definition at line 3052 of file OutputPage.php.

◆ wrapWikiMsg()

OutputPage::wrapWikiMsg (   $wrap,
  $msgSpecs 
)

This function takes a number of message/argument specifications, wraps them in some overall structure, and then parses the result and adds it to the output.

In the $wrap, $1 is replaced with the first message, $2 with the second, and so on. The subsequent arguments may be either 1) strings, in which case they are message names, or 2) arrays, in which case, within each array, the first element is the message name, and subsequent elements are the parameters to that message.

Don't use this for messages that are not in the user's interface language.

For example:

$wgOut->wrapWikiMsg( "<div class='customclass'>\\n$1\\n</div>", 'some-msg-key' );

Is equivalent to:

$wgOut->addWikiTextAsInterface( "<div class='customclass'>\\n"
    . wfMessage( 'some-msg-key' )->plain() . "\\n</div>" );

The newline after the opening div is needed in some wikitext. See T21226.

Parameters
string$wrap
mixed...$msgSpecs

Definition at line 4366 of file OutputPage.php.

References $args, and $s.

◆ wrapWikiTextAsInterface()

OutputPage::wrapWikiTextAsInterface (   $wrapperClass,
  $text 
)

Convert wikitext in the user interface language to HTML and add it to the buffer with a <div class="$wrapperClass"> wrapper.

The result will not be language-converted, as user interface messages as already localized into a specific variant. The $text will be parsed in start-of-line context. Output will be tidy.

Parameters
string$wrapperClassThe class attribute value for the
wrapper in the output HTML
string$text
Wikitext in the user interface language
Since
1.32

Definition at line 1983 of file OutputPage.php.

References getTitle().

Referenced by Article\doDelete().

Member Data Documentation

◆ $mAdditionalBodyClasses

array OutputPage::$mAdditionalBodyClasses = []
protected

Additional <body> classes; there are also <body> classes from other sources.

Definition at line 189 of file OutputPage.php.

◆ $mAdditionalHtmlClasses

array OutputPage::$mAdditionalHtmlClasses = []
protected

Additional <html> classes; This should be rarely modified; prefer mAdditionalBodyClasses.

Definition at line 180 of file OutputPage.php.

◆ $mAllowedModules

array OutputPage::$mAllowedModules
protected
Initial value:
= [
RL\Module::TYPE_COMBINED => RL\Module::ORIGIN_ALL,
]

What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?

See also
RL\Module::$origin RL\Module::ORIGIN_ALL is assumed unless overridden;

Definition at line 240 of file OutputPage.php.

◆ $mBodytext

string OutputPage::$mBodytext = ''

Contains all of the "<body>" content.

Should be private we got set/get accessors and the append() method.

Definition at line 87 of file OutputPage.php.

◆ $mCanonicalUrl

string bool OutputPage::$mCanonicalUrl = false
protected

Definition at line 64 of file OutputPage.php.

◆ $mCategories

string [][] OutputPage::$mCategories
protected
Initial value:
= [
'hidden' => [],
'normal' => [],
]
Deprecated:
since 1.38, will be made private (T301020)

Definition at line 143 of file OutputPage.php.

◆ $mCategoryLinks

string [][] OutputPage::$mCategoryLinks = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 137 of file OutputPage.php.

◆ $mCdnMaxage

int OutputPage::$mCdnMaxage = 0
protected

Cache stuff.

Looks like mEnableClientCache

Definition at line 294 of file OutputPage.php.

◆ $mCdnMaxageLimit

int OutputPage::$mCdnMaxageLimit = INF
protected

Upper limit on mCdnMaxage.

Definition at line 296 of file OutputPage.php.

◆ $mDoNothing

bool OutputPage::$mDoNothing = false
protected

Whether output is disabled.

If this is true, the 'output' method will do nothing.

Definition at line 245 of file OutputPage.php.

◆ $mEnableClientCache

bool OutputPage::$mEnableClientCache = true
protected

Set to false to send no-cache headers, disabling client-side caching.

(This variable should really be named in the opposite sense; see ::disableClientCache().)

Deprecated:
since 1.38; will be made private (T301020)

Definition at line 268 of file OutputPage.php.

◆ $mFeedLinksAppendQuery

OutputPage::$mFeedLinksAppendQuery = null
protected

Definition at line 233 of file OutputPage.php.

◆ $mFileVersion

array OutputPage::$mFileVersion = null
protected

Definition at line 315 of file OutputPage.php.

◆ $mHeadItems

array OutputPage::$mHeadItems = []
protected

Array of elements in "<head>".

Parser might add its own headers!

Deprecated:
since 1.38; will be made private (T301020)

Definition at line 186 of file OutputPage.php.

◆ $mHideNewSectionLink

bool OutputPage::$mHideNewSectionLink = false
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 283 of file OutputPage.php.

◆ $mImageTimeKeys

array OutputPage::$mImageTimeKeys = []
protected

Definition at line 228 of file OutputPage.php.

◆ $mIndicators

string [] OutputPage::$mIndicators = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 152 of file OutputPage.php.

◆ $mInlineStyles

string OutputPage::$mInlineStyles = ''
protected

Inline CSS styles.

Use addInlineStyle() sparingly

Definition at line 168 of file OutputPage.php.

◆ $mJsConfigVars

array OutputPage::$mJsConfigVars = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 219 of file OutputPage.php.

◆ $mLastModified

string OutputPage::$mLastModified = ''
protected

Used for sending cache control.

The whole caching system should probably be moved into its own class.

Definition at line 131 of file OutputPage.php.

◆ $mLinktags

array OutputPage::$mLinktags = []
protected

Definition at line 61 of file OutputPage.php.

◆ $mMetatags

string [][] OutputPage::$mMetatags = []
protected

Should be private.

Used with addMeta() which adds "<meta>"

Definition at line 58 of file OutputPage.php.

◆ $mModules

array OutputPage::$mModules = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 195 of file OutputPage.php.

◆ $mModuleStyles

array OutputPage::$mModuleStyles = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 201 of file OutputPage.php.

◆ $mNewSectionLink

bool OutputPage::$mNewSectionLink = false
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 277 of file OutputPage.php.

◆ $mNoGallery

bool OutputPage::$mNoGallery = false

Comes from the parser.

This was probably made to load CSS/JS only if we had "<gallery>". Used directly in CategoryPage.php. Looks like ResourceLoader can replace this.

Deprecated:
since 1.38; will be made private (T301020)

Definition at line 291 of file OutputPage.php.

◆ $mPageLinkTitle

string OutputPage::$mPageLinkTitle = ''

Used by skin template.

Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );

Definition at line 174 of file OutputPage.php.

◆ $mParserOptions

ParserOptions OutputPage::$mParserOptions = null
protected

lazy initialised, use parserOptions()

Definition at line 253 of file OutputPage.php.

◆ $mPreventClickjacking

bool OutputPage::$mPreventClickjacking = true
protected

Controls if anti-clickjacking / frame-breaking headers will be sent.

This should be done for pages where edit actions are possible. Setter: $this->setPreventClickjacking()

Definition at line 303 of file OutputPage.php.

◆ $mRedirect

string OutputPage::$mRedirect = ''

Definition at line 122 of file OutputPage.php.

◆ $mRedirectCode

string OutputPage::$mRedirectCode = ''

Definition at line 231 of file OutputPage.php.

◆ $mResourceLoader

ResourceLoader OutputPage::$mResourceLoader
protected

Definition at line 204 of file OutputPage.php.

◆ $mStatusCode

int OutputPage::$mStatusCode
protected

Definition at line 125 of file OutputPage.php.

◆ $mTemplateIds

array OutputPage::$mTemplateIds = []
protected
Deprecated:
since 1.38; will be made private (T301020)

Definition at line 225 of file OutputPage.php.

◆ $styles

array OutputPage::$styles = []
protected

An array of stylesheet filenames (relative from skins path), with options for CSS media, IE conditions, and RTL/LTR direction.

For internal use; add settings in the skin via $this->addStyle()

Style again! This seems like a code duplication since we already have mStyles. This is what makes Open Source amazing.

Definition at line 325 of file OutputPage.php.


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