This class should be covered by a general architecture document which does not exist as of January 2011. More...

Inheritance diagram for OutputPage:

[legend]

Collaboration diagram for OutputPage:

[legend]

Public Member Functions
	__construct (IContextSource $context)
	Constructor for OutputPage.

	adaptCdnTTL ( $mtime, $minTTL=0, $maxTTL=0)
	Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage()

	addAcceptLanguage ()
	T23672: Add Accept-Language to Vary and Key headers if there's no 'variant' parameter existed in GET.

	addBacklinkSubtitle (Title $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.

	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.

	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:".

	addMetadataLink (array $linkarr)
	Add a new \<link\> with "rel" attribute set to "meta".

	addModules ( $modules)
	Add one or more modules recognized by ResourceLoader.

	addModuleScripts ( $modules)
	Add only JS of one or more modules recognized by ResourceLoader.

	addModuleStyles ( $modules)
	Add only CSS of one or more modules recognized by ResourceLoader.

	addParserOutput ( $parserOutput, $poOptions=[])
	Add everything from a ParserOutput object.

	addParserOutputContent ( $parserOutput, $poOptions=[])
	Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput object, without any other metadata.

	addParserOutputMetadata ( $parserOutput)
	Add all metadata associated with a ParserOutput object, but without the actual HTML.

	addParserOutputText ( $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, $version=null)
	Add a JavaScript file out of skins/common, or a given relative path.

	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 ()
	Add a wikitext-formatted message to the output.

	addWikiMsgArray ( $name, $args)
	Add a wikitext-formatted message to the output.

	addWikiText ( $text, $linestart=true, $interface=true)
	Convert wikitext to HTML and add it to the buffer Default assumes that the current page title will be used.

	addWikiTextTidy ( $text, $linestart=true)
	Add wikitext with tidy enabled.

	addWikiTextTitle ( $text, Title $title, $linestart, $tidy=false, $interface=false)
	Add wikitext with a custom Title object.

	addWikiTextTitleTidy ( $text, &$title, $linestart=true)
	Add wikitext with a custom Title object and tidy enabled.

	addWikiTextWithTitle ( $text, &$title, $linestart=true)
	Add wikitext with a custom Title object.

	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.

	disable ()
	Disable output completely, i.e.

	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.

	enableSectionEditLinks ( $flag=true)
	Enables/disables section edit links, doesn't override NOEDITSECTION

	forceHideNewSectionLink ()
	Forcibly hide the new section link?

	formatPermissionsErrorMessage (array $errors, $action=null)
	Format a list of error messages.

	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 cookies that will influence on 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.

	getFeedAppendQuery ()
	Will currently always return null.

	getFileSearchOptions ()
	Get the files used on this page.

	getFileVersion ()
	Get the displayed file version.

	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.

	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.

	getKeyHeader ()
	Get a complete Key header.

	getLanguageLinks ()
	Get the list of language links.

	getLinkHeader ()
	Return a Link: header.

	getLinkTags ()
	Returns the current <link> tags.

	getMetadataAttribute ()
	Get the value of the "rel" attribute for metadata links.

	getMetaTags ()
	Returns the current <meta> tags.

	getModules ( $filter=false, $position=null, $param='mModules', $type=ResourceLoaderModule::TYPE_COMBINED)
	Get the list of modules to include on this page.

	getModuleScripts ( $filter=false, $position=null)
	Get the list of module JS to include on this page.

	getModuleStyles ( $filter=false, $position=null)
	Get the list of module CSS to include on this page.

	getPageTitle ()
	Return the "page title", i.e.

	getPageTitleActionText ()
	Get the value of the "action text".

	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.

	getSubtitle ()
	Get the subtitle.

	getSyndicationLinks ()
	Return URLs for each supported syndication format for this page.

	getTarget ()

	getTemplateIds ()
	Get the templates used on this page.

	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".

	isSyndicated ()
	Should we output feed links for this page?

	isTOCEnabled ()
	Whether the output has a table of contents.

	lowerCdnMaxage ( $maxage)
	Lower the value of the "s-maxage" part of the "Cache-control" HTTP header.

	makeResourceLoaderLink ( $modules, $only, array $extraQuery=[])
	Explicily 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:

	parse ( $text, $linestart=true, $interface=false, $language=null)
	Parse wikitext and return the HTML.

	parseInline ( $text, $linestart=true, $interface=false)
	Parse wikitext, strip paragraphs, and return the HTML.

	parserOptions ( $options=null)
	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.

	sectionEditLinksEnabled ()

	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 ( $v)
	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 ( $v)
	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.

	setCopyrightUrl ( $url)
	Set the copyright URL to send with the output.

	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\>.

	setPageTitleActionText ( $text)
	Set the new value of the "action text", this will be added to the "HTML title", separated from it with " - ".

	setPrintable ()
	Set the page as printable, i.e.

	setProperty ( $name, $value)
	Set an additional output property.

	setRedirectedFrom ( $t)
	Set $mRedirectedFrom, the Title of 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.

	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

	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 (Title $t)
	Set the Title object to use.

	showErrorPage ( $title, $msg, $params=[])
	Output a standard error page.

	showFatalError ( $message)

	showFileCopyError ( $old, $new)

	showFileDeleteError ( $name)

	showFileNotFoundError ( $name)

	showFileRenameError ( $old, $new)

	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.

	showUnexpectedValueError ( $name, $val)

	userCanPreview ()
	To make it harder for someone to slip a user a fake user-JavaScript or user-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)
	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.

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.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Static Public Member Functions
static	buildBacklinkSubtitle (Title $title, $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	$mPagetitle = ''
	Should be private - has getter and setter.

string	$mRedirect = ''

string	$mRedirectCode = ''

Protected Member Functions
	addCategoryLinksToLBAndGetResult (array $categories)

	addLogoPreloadLinkHeaders ()
	Add Link headers for preloading the wiki's logo.

	buildExemptModules ()
	Build exempt modules and legacy non-ResourceLoader styles.

	filterModules (array $modules, $position=null, $type=ResourceLoaderModule::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)

	isUserCssPreview ()

	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	$mAllowedModules
	What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?

bool	$mCanonicalUrl = false

array	$mCategories

array	$mCategoryLinks = []

int	$mCdnMaxage = 0
	Cache stuff.

int	$mCdnMaxageLimit = INF
	Upper limit on mCdnMaxage.

int	$mContainsNewMagic = 0

bool	$mDoNothing = false
	Whether output is disabled.

	$mEnableClientCache = true

	$mFeedLinksAppendQuery = null

array	$mFileVersion = null

array	$mHeadItems = []
	Array of elements in "<head>".

bool	$mHideNewSectionLink = false

array	$mImageTimeKeys = []

array	$mIndicators = []

string	$mInlineStyles = ''
	Inline CSS styles.

array	$mJsConfigVars = []

string	$mLastModified = ''
	Used for sending cache control.

array	$mLinktags = []

array	$mMetatags = []
	Should be private.

array	$mModules = []

array	$mModuleScripts = []

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.

Private Member Functions
	feedLink ( $type, $url, $text)
	Generate a "<link rel/>" for a feed.

	getRlClientContext ()

	isUserJsPreview ()

	warnModuleTargetFilter ( $moduleName)

Private Attributes
string null	$copyrightUrl
	The URL to send in a <link> element with rel=license.

array	$limitReportJSData = []
	Profiling data.

bool	$mArticleBodyOnly = false
	Flag if output should only contain the body of the article.

bool	$mEnableTOC = false
	Whether parser output contains a table of contents.

	$mFeedLinks = []
	Handles the Atom / RSS links.

	$mFollowPolicy = 'follow'

string	$mHTMLtitle = ''
	Stores contents of "<title>" tag.

	$mIndexPolicy = 'index'

bool	$mIsarticle = false
	Is the displayed content related to the source of the corresponding wiki article.

bool	$mIsArticleRelated = true
	Stores "article flag" toggle.

array	$mLanguageLinks = []
	Array of Interwiki Prefixed (non DB key) Titles (e.g.

	$mLinkHeader = []
	Link: header contents.

string	$mPageTitleActionText = ''

bool	$mPrintable = false
	We have to set isPrintable().

	$mProperties = []
	Additional key => value data.

Title	$mRedirectedFrom = null
	If the current page was reached through a redirect, $mRedirectedFrom contains the Title of the redirect.

int	$mRevisionId = null
	To include the variable {{REVISIONID}}.

string	$mRevisionTimestamp = null

	$mScripts = ''
	Used for JavaScript (predates ResourceLoader)

array	$mSubtitle = []
	Contains the page subtitle.

string null	$mTarget = null
	ResourceLoader target for load.php links.

	$mVaryHeader

ResourceLoaderClientHtml	$rlClient

ResourceLoaderContext	$rlClientContext

array	$rlExemptStyleModules

string	$rlUserModuleState

Detailed Description

This class should be covered by a general architecture document which does not exist as of January 2011.

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

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 45 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 309 of file OutputPage.php.

References $context, and ContextSource\setContext().

Member Function Documentation

◆ adaptCdnTTL()

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

Get TTL in [$minTTL,$maxTTL] in 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	$mtime	Last-Modified timestamp
int	$minTTL	Mimimum TTL in seconds [default: 1 minute]
int	$maxTTL	Maximum TTL in seconds [default: $wgSquidMaxage]

Returns: int TTL in seconds

Since: 1.28

Definition at line 1966 of file OutputPage.php.

References ContextSource\getConfig(), lowerCdnMaxage(), and wfTimestamp().

◆ addAcceptLanguage()

OutputPage::addAcceptLanguage ( )

T23672: Add Accept-Language to Vary and Key headers if there's no 'variant' parameter existed in GET.

For example: /w/index.php?title=Main_page should always be served; but /w/index.php?title=Main_page&variant=zh-cn should never be served.

Definition at line 2130 of file OutputPage.php.

References $lang, addVaryHeader(), ContextSource\getRequest(), and ContextSource\getTitle().

Referenced by sendCacheControl().

◆ addBacklinkSubtitle()

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

Add a subtitle containing a backlink to a page.

Parameters

Title	$title	Title to link to
array	$query	Array of additional parameters to include in the link

Definition at line 1017 of file OutputPage.php.

References $query, and addSubtitle().

◆ addBodyClasses()

OutputPage::addBodyClasses ( $classes )

Add a class to the <body> element.

Since: 1.30

Parameters

string | string[] $classes One or more classes to add

Definition at line 676 of file OutputPage.php.

◆ addCategoryLinks()

OutputPage::addCategoryLinks ( array $categories )

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

Parameters

array $categories Mapping category name => sort key

Definition at line 1242 of file OutputPage.php.

References $linkRenderer, $res, $type, $wgContLang, addCategoryLinksToLBAndGetResult(), NS_CATEGORY, and string.

Referenced by addParserOutputMetadata(), and setCategoryLinks().

◆ addCategoryLinksToLBAndGetResult()

OutputPage::addCategoryLinksToLBAndGetResult ( array $categories )

protected

Parameters

array $categories

Returns: bool|ResultWrapper

Definition at line 1292 of file OutputPage.php.

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

Referenced by addCategoryLinks().

◆ 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 1509 of file OutputPage.php.

References $attribs, and addHTML().

◆ addFeedLink()

OutputPage::addFeedLink	(		$format,
			$href )

Add a feed link to the page header.

Parameters

string	$format	Feed type, should be a key of $wgFeedClasses
string	$href	URL

Definition at line 1131 of file OutputPage.php.

References ContextSource\getConfig().

◆ 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::addMetaLink() 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	$name	Item name
string	$value	Raw HTML

Definition at line 646 of file OutputPage.php.

References $name, and $value.

◆ addHeadItems()

OutputPage::addHeadItems ( $values )

Add one or more head items to the output.

Since: 1.28

Parameters

string | string[] $values Raw HTML

Definition at line 656 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	$to	Target MediaWiki.org page title or encoded URL.
bool	$overrideBaseUrl	Whether $url is a full URL, to avoid MW.o.

Since: 1.25

Definition at line 1402 of file OutputPage.php.

References $link, addModuleStyles(), ContextSource\msg(), setIndicators(), and wfUrlencode().

◆ addHTML()

OutputPage::addHTML ( $text )

Append $text to the body HTML.

Parameters

string $text HTML

Definition at line 1496 of file OutputPage.php.

Referenced by addElement(), addParserOutputText(), addReturnTo(), addTemplate(), addWikiMsgArray(), showErrorPage(), showFatalError(), and showPermissionsErrorPage().

◆ addInlineScript()

OutputPage::addInlineScript ( $script )

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

Use OutputPage::addModules() if possible.

Parameters

string $script JavaScript text, no script tags

Definition at line 483 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_css	Inline CSS
string	$flip	Set to 'flip' to flip the CSS if needed

Definition at line 3548 of file OutputPage.php.

References ContextSource\getLanguage().

◆ addJsConfigVars()

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

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

Parameters

string \| array	$keys	Key or array of key/value pairs
mixed	$value	[optional] Value of the configuration variable

Definition at line 3035 of file OutputPage.php.

References $keys, and $value.

Referenced by addParserOutputContent(), and addParserOutputMetadata().

◆ addLanguageLinks()

OutputPage::addLanguageLinks ( array $newLinkArray )

Add new language links.

Parameters

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

Definition at line 1214 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 $linkarr Associative array of attributes.

Definition at line 383 of file OutputPage.php.

Referenced by addMetadataLink().

◆ addLinkHeader()

OutputPage::addLinkHeader ( $header )

Add an HTTP Link: header.

Parameters

string $header Header value

Definition at line 2074 of file OutputPage.php.

References $header.

Referenced by addLogoPreloadLinkHeaders().

◆ addLogoPreloadLinkHeaders()

OutputPage::addLogoPreloadLinkHeaders ( )

protected

Add Link headers for preloading the wiki's logo.

Since: 1.26

Definition at line 3942 of file OutputPage.php.

References addLinkHeader(), ContextSource\getConfig(), and ResourceLoaderSkinModule\getLogo().

Referenced by output().

◆ addMeta()

OutputPage::addMeta	(		$name,
			$val )

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

Parameters

string	$name	Name of the meta tag
string	$val	Value of the meta tag

Definition at line 362 of file OutputPage.php.

◆ addMetadataLink()

OutputPage::addMetadataLink ( array $linkarr )

Add a new \<link\> with "rel" attribute set to "meta".

Parameters

array $linkarr Associative array mapping attribute names to their values, both keys and values will be escaped, and the "rel" attribute will be automatically added

Definition at line 404 of file OutputPage.php.

References addLink(), and getMetadataAttribute().

◆ addModules()

OutputPage::addModules ( $modules )

Add one or more modules recognized by ResourceLoader.

Modules added through this function will be loaded by ResourceLoader when the page loads.

Parameters

string | array $modules Module name (string) or array of module names

Definition at line 555 of file OutputPage.php.

References $modules.

Referenced by ListToggle\__construct(), addParserOutputContent(), addParserOutputMetadata(), getRlClient(), and output().

◆ addModuleScripts()

OutputPage::addModuleScripts ( $modules )

Add only JS of one or more modules recognized by ResourceLoader.

Module scripts added through this function will be loaded by ResourceLoader when the page loads.

Parameters

string | array $modules Module name (string) or array of module names

Definition at line 579 of file OutputPage.php.

References $modules.

Referenced by addParserOutputContent(), and addParserOutputMetadata().

◆ addModuleStyles()

OutputPage::addModuleStyles ( $modules )

Add only CSS of one or more modules recognized by ResourceLoader.

Module styles added through this function will be added using standard link CSS tags, rather than as a combined Javascript and CSS package. Thus, they will load when JavaScript is disabled (unless CSS also happens to be disabled).

Parameters

string | array $modules Module name (string) or array of module names

Definition at line 605 of file OutputPage.php.

References $modules.

Referenced by ListToggle\__construct(), addHelpLink(), addParserOutputContent(), addParserOutputMetadata(), enableOOUI(), and getRlClient().

◆ addParserOutput()

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

Add everything from a ParserOutput object.

Parameters

ParserOutput	$parserOutput
array	$poOptions	Options to ParserOutput::getText()

Definition at line 1860 of file OutputPage.php.

References addParserOutputMetadata(), and addParserOutputText().

Referenced by addWikiTextTitle().

◆ addParserOutputContent()

OutputPage::addParserOutputContent	(		$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	$poOptions	Options to ParserOutput::getText()

Definition at line 1829 of file OutputPage.php.

References addJsConfigVars(), addModules(), addModuleScripts(), addModuleStyles(), and addParserOutputText().

◆ addParserOutputMetadata()

OutputPage::addParserOutputMetadata ( $parserOutput )

Add all metadata associated with a ParserOutput object, but without the actual HTML.

This includes categories, language links, ResourceLoader modules, effects of certain magic words, and so on.

Since: 1.24

Parameters

ParserOutput $parserOutput

Definition at line 1753 of file OutputPage.php.

References addCategoryLinks(), addJsConfigVars(), addModules(), addModuleScripts(), addModuleStyles(), enableClientCache(), enableOOUI(), ContextSource\getConfig(), ContextSource\getTitle(), list, and setIndicators().

Referenced by addParserOutput().

◆ addParserOutputText()

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

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

Since: 1.24

Parameters

ParserOutput	$parserOutput
array	$poOptions	Options to ParserOutput::getText()

Definition at line 1846 of file OutputPage.php.

References addHTML().

Referenced by addParserOutput(), and addParserOutputContent().

◆ addReturnTo()

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

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

Parameters

Title	$title	Title to link
array	$query	Query string parameters
string	$text	Text of the link (input is not escaped)
array	$options	Options array to pass to Linker

Definition at line 2651 of file OutputPage.php.

References $link, $linkRenderer, $options, $query, addHTML(), and ContextSource\msg().

Referenced by returnToMain().

◆ 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 $script Raw HTML

Definition at line 452 of file OutputPage.php.

Referenced by addScriptFile().

◆ addScriptFile()

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

Add a JavaScript file out of skins/common, or a given relative path.

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

Parameters

string	$file	Filename in skins/common or complete on-server path (/foo/bar.js)
string	$version	Style version of the file. Defaults to $wgStyleVersion

Definition at line 464 of file OutputPage.php.

References addScript(), ContextSource\getConfig(), and wfAppendQuery().

◆ 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	$style	URL to the file
string	$media	To specify a media type, 'screen', 'printable', 'handheld' or any.
string	$condition	For IE conditional comments, specifying an IE version
string	$dir	Set to 'rtl' or 'ltr' for direction-specific sheets

Definition at line 3527 of file OutputPage.php.

References $options.

◆ addSubtitle()

OutputPage::addSubtitle ( $str )

Add $str to the subtitle.

Parameters

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

Definition at line 986 of file OutputPage.php.

References getContext().

Referenced by addBacklinkSubtitle(), and setSubtitle().

◆ addTemplate()

OutputPage::addTemplate ( & $template )

Add the output of a QuickTemplate to the output buffer.

Parameters

QuickTemplate &$template

Definition at line 1870 of file OutputPage.php.

References $template, and addHTML().

◆ addVaryHeader()

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

Add an HTTP header that will influence on the cache.

Parameters

string	$header	Header name
string[] \| null	$option	Options for the Key header. See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for the list of valid options.

Definition at line 2041 of file OutputPage.php.

References $header.

Referenced by addAcceptLanguage(), getKeyHeader(), getVaryHeader(), output(), and sendCacheControl().

◆ addWikiMsg()

OutputPage::addWikiMsg ( )

Add a wikitext-formatted message to the output.

This is equivalent to:

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

Definition at line 3802 of file OutputPage.php.

References $args, and addWikiMsgArray().

Referenced by versionRequired().

◆ 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 3816 of file OutputPage.php.

References $args, addHTML(), and ContextSource\msg().

Referenced by addWikiMsg(), and showErrorPage().

◆ addWikiText()

OutputPage::addWikiText	(	$text,
		$linestart = true,
		$interface = true )

Convert wikitext to HTML and add it to the buffer Default assumes that the current page title will be used.

Parameters

string	$text
bool	$linestart	Is this the start of a line?
bool	$interface	Is this text in the user interface language?

Exceptions

MWException

Definition at line 1673 of file OutputPage.php.

References addWikiTextTitle(), and ContextSource\getTitle().

Referenced by showPermissionsErrorPage(), and wrapWikiMsg().

◆ addWikiTextTidy()

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

Add wikitext with tidy enabled.

Parameters

string	$text	Wikitext
bool	$linestart	Is this the start of a line?

Definition at line 1709 of file OutputPage.php.

References addWikiTextTitleTidy(), and ContextSource\getTitle().

◆ addWikiTextTitle()

OutputPage::addWikiTextTitle	(		$text,
		Title	$title,
			$linestart,
			$tidy = false,
			$interface = false )

Add wikitext with a custom Title object.

Parameters

string	$text	Wikitext
Title	$title
bool	$linestart	Is this the start of a line?
bool	$tidy	Whether to use tidy
bool	$interface	Whether it is an interface message (for example disables conversion)

Definition at line 1724 of file OutputPage.php.

References $wgParser, addParserOutput(), and parserOptions().

Referenced by addWikiText(), addWikiTextTitleTidy(), and addWikiTextWithTitle().

◆ addWikiTextTitleTidy()

OutputPage::addWikiTextTitleTidy	(		$text,
		&	$title,
			$linestart = true )

Add wikitext with a custom Title object and tidy enabled.

Parameters

string	$text	Wikitext
Title	&$title
bool	$linestart	Is this the start of a line?

Definition at line 1699 of file OutputPage.php.

References addWikiTextTitle().

Referenced by addWikiTextTidy().

◆ addWikiTextWithTitle()

OutputPage::addWikiTextWithTitle	(		$text,
		&	$title,
			$linestart = true )

Add wikitext with a custom Title object.

Parameters

string	$text	Wikitext
Title	&$title
bool	$linestart	Is this the start of a line?

Definition at line 1688 of file OutputPage.php.

References addWikiTextTitle().

◆ 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.

Definition at line 2178 of file OutputPage.php.

◆ buildBacklinkSubtitle()

static OutputPage::buildBacklinkSubtitle	(	Title	$title,
			$query = [] )

static

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

Parameters

Title	$title	Title to link to
array	$query	Array of additional parameters to include in the link

Returns: Message

Since: 1.25

Definition at line 1002 of file OutputPage.php.

References $linkRenderer, $query, and wfMessage().

◆ buildCssLinksArray()

OutputPage::buildCssLinksArray ( )

Returns: array

Definition at line 3624 of file OutputPage.php.

References $link, $options, and styleLink().

Referenced by buildExemptModules().

◆ buildExemptModules()

OutputPage::buildExemptModules ( )

protected

Build exempt modules and legacy non-ResourceLoader styles.

Returns: string|WrappedStringList HTML

Definition at line 3561 of file OutputPage.php.

References $wgContLang, buildCssLinksArray(), ContextSource\getLanguage(), ContextSource\getRequest(), ContextSource\getTitle(), isUserCssPreview(), makeResourceLoaderLink(), and ResourceLoaderModule\TYPE_STYLES.

Referenced by headElement().

◆ 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 737 of file OutputPage.php.

References $value, disable(), ContextSource\getConfig(), ContextSource\getRequest(), ContextSource\getUser(), sendCacheControl(), wfClearOutputBuffers(), wfDebug(), and wfTimestamp().

◆ clearHTML()

OutputPage::clearHTML ( )

Clear the body HTML.

Definition at line 1516 of file OutputPage.php.

Referenced by prepareErrorPage().

◆ clearSubtitle()

OutputPage::clearSubtitle ( )

Clear the subtitles.

Definition at line 1024 of file OutputPage.php.

Referenced by prepareErrorPage(), and setSubtitle().

◆ 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 2941 of file OutputPage.php.

◆ disable()

OutputPage::disable ( )

Disable output completely, i.e.

calling output() will have no effect

Definition at line 1057 of file OutputPage.php.

Referenced by checkLastModified().

◆ 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 1434 of file OutputPage.php.

References ContextSource\getConfig(), ResourceLoaderModule\ORIGIN_CORE_INDIVIDUAL, ResourceLoaderModule\ORIGIN_USER_SITEWIDE, reduceAllowedModules(), ResourceLoaderModule\TYPE_SCRIPTS, and ResourceLoaderModule\TYPE_STYLES.

Referenced by output().

◆ enableClientCache()

OutputPage::enableClientCache ( $state )

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

Parameters

bool $state

Returns: bool

Definition at line 1990 of file OutputPage.php.

References wfSetVar().

Referenced by addParserOutputMetadata(), and prepareErrorPage().

◆ 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 3921 of file OutputPage.php.

References addModuleStyles(), ContextSource\getLanguage(), and getSkin().

Referenced by addParserOutputMetadata().

◆ enableSectionEditLinks()

OutputPage::enableSectionEditLinks ( $flag = true )

Enables/disables section edit links, doesn't override NOEDITSECTION

Parameters

bool $flag

Since: 1.23

Deprecated: since 1.31, use $poOptions to addParserOutput() instead.

Definition at line 3885 of file OutputPage.php.

References wfDeprecated().

◆ feedLink()

OutputPage::feedLink	(	$type,
		$url,
		$text )

private

Generate a "<link rel/>" for a feed.

Parameters

string	$type	Feed type
string	$url	URL to the feed
string	$text	Value of the "title" attribute

Returns: string HTML fragment

Definition at line 3509 of file OutputPage.php.

Referenced by getHeadLinksArray().

◆ filterModules()

OutputPage::filterModules	(	array	$modules,
			$position = null,
			$type = ResourceLoaderModule::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

array	$modules
string \| null	$position	Unused
string	$type

Returns: array

Definition at line 495 of file OutputPage.php.

References $modules, $resourceLoader, $type, ResourceLoaderModule\getOrigin(), getResourceLoader(), and warnModuleTargetFilter().

Referenced by getModules(), getRlClient(), and makeResourceLoaderLink().

◆ forceHideNewSectionLink()

OutputPage::forceHideNewSectionLink ( )

Forcibly hide the new section link?

Returns: bool

Definition at line 1084 of file OutputPage.php.

◆ formatPermissionsErrorMessage()

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

Format a list of error messages.

Parameters

array	$errors	Array of arrays returned by Title::getUserPermissionsErrors
string	$action	Action that was denied or null if unknown

Returns: string The wikitext error-messages, formatted into a list.

Definition at line 2566 of file OutputPage.php.

References ContextSource\msg().

Referenced by showPermissionsErrorPage().

◆ getAllowedModules()

OutputPage::getAllowedModules ( $type )

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

See also: ResourceLoaderModule::$origin

Parameters

string $type ResourceLoaderModule TYPE_ constant

Returns: int ResourceLoaderModule ORIGIN_ class constant

Definition at line 1459 of file OutputPage.php.

References $type, ResourceLoaderModule\ORIGIN_ALL, and ResourceLoaderModule\TYPE_COMBINED.

Referenced by reduceAllowedModules().

◆ getArticleBodyOnly()

OutputPage::getArticleBodyOnly ( )

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

Returns: bool

Definition at line 696 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 2967 of file OutputPage.php.

References ContextSource\getRequest(), getRlClient(), ContextSource\getTitle(), isUserJsPreview(), ResourceLoader\makeConfigSetScript(), ResourceLoader\makeInlineScript(), makeResourceLoaderLink(), and ResourceLoaderModule\TYPE_COMBINED.

◆ getCacheVaryCookies()

OutputPage::getCacheVaryCookies ( )

Get the list of cookies that will influence on the cache.

Returns: array

Definition at line 1999 of file OutputPage.php.

References ContextSource\getConfig().

Referenced by getKeyHeader(), getVaryHeader(), and haveCacheVaryCookies().

◆ 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 425 of file OutputPage.php.

◆ getCategories()

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

Get the list of category names this page belongs to.

Parameters

string

$type

The 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: array Array of strings

Definition at line 1353 of file OutputPage.php.

References $type.

Referenced by getJSVars().

◆ 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: array

Definition at line 1340 of file OutputPage.php.

◆ getFeedAppendQuery()

OutputPage::getFeedAppendQuery ( )

Will currently always return null.

Returns: null

Definition at line 1158 of file OutputPage.php.

◆ getFileSearchOptions()

OutputPage::getFileSearchOptions ( )

Get the files used on this page.

Returns: array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))

Since: 1.18

Definition at line 1660 of file OutputPage.php.

◆ getFileVersion()

OutputPage::getFileVersion ( )

Get the displayed file version.

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

Definition at line 1640 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 2199 of file OutputPage.php.

References ContextSource\getConfig().

Referenced by getJSVars(), and output().

◆ getHeadItemsArray()

OutputPage::getHeadItemsArray ( )

Get an array of head items.

Returns: array

Definition at line 630 of file OutputPage.php.

◆ getHeadLinksArray()

OutputPage::getHeadLinksArray ( )

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

Definition at line 3233 of file OutputPage.php.

References $lang, $link, $query, $type, $wgVersion, feedLink(), Action\getActionName(), ContextSource\getConfig(), getContext(), ContextSource\getRequest(), getSyndicationLinks(), ContextSource\getTitle(), ContextSource\getUser(), isArticleRelated(), ContextSource\msg(), PROTO_CANONICAL, PROTO_RELATIVE, text, wfAppendQuery(), wfExpandUrl(), and wfScript().

Referenced by headElement().

◆ getHTML()

OutputPage::getHTML ( )

Get the body HTML.

Returns: string HTML

Definition at line 1525 of file OutputPage.php.

◆ getHTMLTitle()

OutputPage::getHTMLTitle ( )

Return the "HTML title", i.e.

the content of the "<title>" tag.

Returns: string

Definition at line 913 of file OutputPage.php.

Referenced by headElement().

◆ getIndicators()

OutputPage::getIndicators ( )

Get the indicators associated with this page.

The array will be internally ordered by item keys.

Returns: array Keys: identifiers, values: HTML contents

Since: 1.25

Definition at line 1390 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 3025 of file OutputPage.php.

Referenced by getJSVars().

◆ 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 ResourceLoaderStartUpModule

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 3055 of file OutputPage.php.

References $lang, $type, $vars, $wgContLang, ContextSource\canUseWikiPage(), Action\getActionName(), getCategories(), getContext(), getFrameOptions(), getJsConfigVars(), getRevisionId(), getSkin(), ContextSource\getTitle(), ContextSource\getUser(), ContextSource\getWikiPage(), isArticle(), list, NS_SPECIAL, SpecialPageFactory\resolveAlias(), and wfTimestamp().

Referenced by getRlClient().

◆ getKeyHeader()

OutputPage::getKeyHeader ( )

Get a complete Key header.

Returns: string

Definition at line 2096 of file OutputPage.php.

References $header, $options, addVaryHeader(), and getCacheVaryCookies().

Referenced by sendCacheControl().

◆ 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 1233 of file OutputPage.php.

◆ getLinkHeader()

OutputPage::getLinkHeader ( )

Return a Link: header.

Based on the values of $mLinkHeader.

Returns: string

Definition at line 2083 of file OutputPage.php.

Referenced by output().

◆ getLinkTags()

OutputPage::getLinkTags ( )

Returns the current <link> tags.

Since: 1.25

Returns: array

Definition at line 393 of file OutputPage.php.

◆ getMetadataAttribute()

OutputPage::getMetadataAttribute ( )

Get the value of the "rel" attribute for metadata links.

Returns: string

Definition at line 434 of file OutputPage.php.

Referenced by addMetadataLink().

◆ getMetaTags()

OutputPage::getMetaTags ( )

Returns the current <meta> tags.

Since: 1.25

Returns: array

Definition at line 372 of file OutputPage.php.

◆ getModules()

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

Get the list of modules to include on this page.

Parameters

bool	$filter	Whether to filter out insufficiently trustworthy modules
string \| null	$position	Unused
string	$param
string	$type

Returns: array Array of module names

Definition at line 539 of file OutputPage.php.

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

Referenced by getModuleScripts(), getModuleStyles(), and getRlClient().

◆ getModuleScripts()

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

Get the list of module JS to include on this page.

Parameters

bool	$filter
string \| null	$position	Unused

Returns: array Array of module names

Definition at line 566 of file OutputPage.php.

References getModules(), and ResourceLoaderModule\TYPE_SCRIPTS.

Referenced by getRlClient().

◆ getModuleStyles()

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

Get the list of module CSS to include on this page.

Parameters

bool	$filter
string \| null	$position	Unused

Returns: array Array of module names

Definition at line 590 of file OutputPage.php.

References getModules(), and ResourceLoaderModule\TYPE_STYLES.

Referenced by getRlClient().

◆ getPageTitle()

OutputPage::getPageTitle ( )

Return the "page title", i.e.

the content of the \<h1\> tag.

Returns: string

Definition at line 958 of file OutputPage.php.

Referenced by headElement().

◆ getPageTitleActionText()

OutputPage::getPageTitleActionText ( )

Get the value of the "action text".

Returns: string

Definition at line 890 of file OutputPage.php.

◆ getPreventClickjacking()

OutputPage::getPreventClickjacking ( )

Get the prevent-clickjacking flag.

Since: 1.24

Returns: bool

Definition at line 2188 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 718 of file OutputPage.php.

References $name.

◆ getRedirect()

OutputPage::getRedirect ( )

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

Returns: string

Definition at line 330 of file OutputPage.php.

◆ getResourceLoader()

OutputPage::getResourceLoader ( )

Get a ResourceLoader object associated with this OutputPage.

Returns: ResourceLoader

Definition at line 2905 of file OutputPage.php.

References ContextSource\getConfig().

Referenced by filterModules(), getRlClient(), getRlClientContext(), and warnModuleTargetFilter().

◆ getRevisionId()

OutputPage::getRevisionId ( )

Get the displayed revision ID.

Returns: int

Definition at line 1596 of file OutputPage.php.

Referenced by getJSVars().

◆ getRevisionTimestamp()

OutputPage::getRevisionTimestamp ( )

Get the timestamp of displayed revision.

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

Returns: string|null

Definition at line 1617 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: ResourceLoaderClientHtml

Definition at line 2726 of file OutputPage.php.

References $context, $dbr, $name, addModules(), addModuleStyles(), DB_REPLICA, filterModules(), getJSVars(), getModules(), getModuleScripts(), getModuleStyles(), getResourceLoader(), getRlClientContext(), getSkin(), getTarget(), isUserCssPreview(), isUserJsPreview(), ResourceLoaderWikiModule\preloadTitleInfo(), ResourceLoaderClientHtml\setConfig(), ResourceLoaderClientHtml\setExemptStates(), ResourceLoaderClientHtml\setModules(), ResourceLoaderClientHtml\setModuleScripts(), ResourceLoaderClientHtml\setModuleStyles(), and wfGetDB().

Referenced by getBottomScripts(), and headElement().

◆ getRlClientContext()

OutputPage::getRlClientContext ( )

private

Definition at line 2694 of file OutputPage.php.

References $query, ContextSource\getLanguage(), ContextSource\getRequest(), getResourceLoader(), getSkin(), ContextSource\getUser(), ResourceLoader\inDebugMode(), isPrintable(), and ResourceLoader\makeLoaderQuery().

Referenced by getRlClient(), and makeResourceLoaderLink().

◆ getSubtitle()

OutputPage::getSubtitle ( )

Get the subtitle.

Returns: string

Definition at line 1033 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 1149 of file OutputPage.php.

Referenced by getHeadLinksArray().

◆ getTarget()

OutputPage::getTarget ( )

Returns: null|string ResourceLoader target

Definition at line 612 of file OutputPage.php.

Referenced by getRlClient().

◆ getTemplateIds()

OutputPage::getTemplateIds ( )

Get the templates used on this page.

Returns: array (namespace => dbKey => revId)

Since: 1.18

Definition at line 1650 of file OutputPage.php.

◆ 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 2057 of file OutputPage.php.

References $header, $options, addVaryHeader(), and getCacheVaryCookies().

Referenced by sendCacheControl().

◆ hasHeadItem()

OutputPage::hasHeadItem ( $name )

Check if the header item $name is already set.

Parameters

string $name Item name

Returns: bool

Definition at line 666 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 2021 of file OutputPage.php.

References $request, getCacheVaryCookies(), ContextSource\getRequest(), and wfDebug().

◆ headElement()

OutputPage::headElement	(	Skin	$sk,
			$includeStyle = true )

Parameters

Skin	$sk	The given Skin
bool	$includeStyle	Unused

Returns: string The doctype, opening "<html>", and head element.

Definition at line 2809 of file OutputPage.php.

References $wgContLang, buildExemptModules(), Action\getActionName(), ContextSource\getConfig(), getContext(), getHeadLinksArray(), getHTMLTitle(), ContextSource\getLanguage(), getPageTitle(), getRlClient(), ContextSource\getTitle(), ContextSource\getUser(), ResourceLoaderClientHtml\makeLoad(), ContextSource\msg(), setHTMLTitle(), and ResourceLoaderModule\TYPE_SCRIPTS.

◆ 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 1182 of file OutputPage.php.

Referenced by getJSVars().

◆ isArticleRelated()

OutputPage::isArticleRelated ( )

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

Returns: bool

Definition at line 1204 of file OutputPage.php.

Referenced by getHeadLinksArray().

◆ isDisabled()

OutputPage::isDisabled ( )

Return whether the output will be completely disabled.

Returns: bool

Definition at line 1066 of file OutputPage.php.

◆ isPrintable()

OutputPage::isPrintable ( )

Return whether the page is "printable".

Returns: bool

Definition at line 1050 of file OutputPage.php.

Referenced by getRlClientContext().

◆ isSyndicated()

OutputPage::isSyndicated ( )

Should we output feed links for this page?

Returns: bool

Definition at line 1141 of file OutputPage.php.

◆ isTOCEnabled()

OutputPage::isTOCEnabled ( )

Whether the output has a table of contents.

Returns: bool

Since: 1.22

Definition at line 3875 of file OutputPage.php.

◆ isUserCssPreview()

OutputPage::isUserCssPreview ( )

protected

Definition at line 2954 of file OutputPage.php.

References ContextSource\getConfig(), ContextSource\getTitle(), and userCanPreview().

Referenced by buildExemptModules(), and getRlClient().

◆ isUserJsPreview()

OutputPage::isUserJsPreview ( )

private

Definition at line 2947 of file OutputPage.php.

References ContextSource\getConfig(), ContextSource\getTitle(), and userCanPreview().

Referenced by getBottomScripts(), and getRlClient().

◆ lowerCdnMaxage()

OutputPage::lowerCdnMaxage ( $maxage )

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

Parameters

int $maxage Maximum cache time on the CDN, in seconds

Since: 1.27

Definition at line 1948 of file OutputPage.php.

References setCdnMaxage().

Referenced by adaptCdnTTL().

◆ makeResourceLoaderLink()

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

Explicily load or embed modules on a page.

Parameters

array \| string	$modules	One or more module names
string	$only	ResourceLoaderModule TYPE_ class constant
array	$extraQuery	[optional] Array with extra query parameters for the request

Returns: string|WrappedStringList HTML

Definition at line 2923 of file OutputPage.php.

References $modules, filterModules(), getRlClientContext(), and ResourceLoaderClientHtml\makeLoad().

Referenced by buildExemptModules(), and getBottomScripts().

◆ output()

OutputPage::output ( $return = false )

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

Parameters

bool $return Set to true to get the result as a string rather than sending it

Returns: string|null

Exceptions

Exception
FatalError
MWException

Definition at line 2292 of file OutputPage.php.

References $code, $e, $response, $wgContLang, addLogoPreloadLinkHeaders(), addModules(), addVaryHeader(), disallowUserJs(), ContextSource\getConfig(), getFrameOptions(), getLinkHeader(), ContextSource\getRequest(), getSkin(), print, PROTO_CURRENT, sendCacheControl(), wfExpandUrl(), and wfTimestamp().

◆ parse()

OutputPage::parse	(	$text,
		$linestart = true,
		$interface = false,
		$language = null )

Parse wikitext and return the HTML.

Parameters

string	$text
bool	$linestart	Is this the start of a line?
bool	$interface	Use interface language ($wgLang instead of $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL. This also disables LanguageConverter.
Language	$language	Target language object, will override $interface

Exceptions

MWException

Returns: string HTML

Definition at line 1886 of file OutputPage.php.

References $wgParser, ContextSource\getTitle(), and parserOptions().

Referenced by parseInline(), and showPermissionsErrorPage().

◆ parseInline()

OutputPage::parseInline	(	$text,
		$linestart = true,
		$interface = false )

Parse wikitext, strip paragraphs, and return the HTML.

Parameters

string	$text
bool	$linestart	Is this the start of a line?
bool	$interface	Use interface language ($wgLang instead of $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL

Returns: string HTML

Definition at line 1928 of file OutputPage.php.

References parse().

◆ parserOptions()

OutputPage::parserOptions ( $options = null )

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

Parameters

ParserOptions | null $options Either the ParserOption to use or null to only get the current ParserOption object. This parameter is deprecated since 1.31.

Returns: ParserOptions

Definition at line 1536 of file OutputPage.php.

References $options, getContext(), ContextSource\getUser(), wfDeprecated(), wfGetAllCallers(), wfLogWarning(), and wfSetVar().

Referenced by addWikiTextTitle(), and parse().

◆ 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	$pageTitle	Will be passed directly to setPageTitle()
string \| Message	$htmlTitle	Will be passed directly to setHTMLTitle(); optional, if not passed the "<title>" attribute will be based on $pageTitle

Definition at line 2423 of file OutputPage.php.

References clearHTML(), clearSubtitle(), enableClientCache(), setArticleRelated(), setHTMLTitle(), setPageTitle(), and setRobotPolicy().

Referenced by showErrorPage(), showFatalError(), showPermissionsErrorPage(), and versionRequired().

◆ prependHTML()

OutputPage::prependHTML ( $text )

Prepend $text to the body HTML.

Parameters

string $text HTML

Definition at line 1487 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

Definition at line 2169 of file OutputPage.php.

◆ redirect()

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

Redirect to $url rather than displaying the normal page.

Parameters

string	$url
string	$responsecode	HTTP status code

Definition at line 319 of file OutputPage.php.

◆ 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	$level	ResourceLoaderModule class constant

Definition at line 1478 of file OutputPage.php.

References $type, and getAllowedModules().

Referenced by disallowUserJs().

◆ 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	$unused
Title \| string	$returnto	Title or String to return to
string	$returntoquery	Query string for the return to link

Definition at line 2667 of file OutputPage.php.

References addReturnTo(), ContextSource\getRequest(), and wfCgiToArray().

Referenced by showErrorPage(), showPermissionsErrorPage(), and versionRequired().

◆ sectionEditLinksEnabled()

OutputPage::sectionEditLinksEnabled ( )

Returns: bool

Since: 1.23

Deprecated: since 1.31, use $poOptions to addParserOutput() instead.

Definition at line 3894 of file OutputPage.php.

References wfDeprecated().

◆ sendCacheControl()

OutputPage::sendCacheControl ( )

Send cache control HTTP headers.

Definition at line 2212 of file OutputPage.php.

References $response, addAcceptLanguage(), addVaryHeader(), ContextSource\getConfig(), getKeyHeader(), ContextSource\getRequest(), getVaryHeader(), and wfDebug().

Referenced by checkLastModified(), and output().

◆ 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 $only Whether to output only the body of the article

Definition at line 687 of file OutputPage.php.

◆ setArticleFlag()

OutputPage::setArticleFlag ( $v )

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 $v

Definition at line 1169 of file OutputPage.php.

◆ setArticleRelated()

OutputPage::setArticleRelated ( $v )

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 $v

Definition at line 1192 of file OutputPage.php.

Referenced by prepareErrorPage().

◆ 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 414 of file OutputPage.php.

◆ setCategoryLinks()

OutputPage::setCategoryLinks ( array $categories )

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

Parameters

array $categories Mapping category name => sort key

Definition at line 1327 of file OutputPage.php.

References addCategoryLinks().

◆ setCdnMaxage()

OutputPage::setCdnMaxage ( $maxage )

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

Parameters

int $maxage Maximum cache time on the CDN, in seconds.

Definition at line 1938 of file OutputPage.php.

Referenced by lowerCdnMaxage().

◆ 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 342 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 $val Query to append to feed links or false to output default links

Definition at line 1113 of file OutputPage.php.

References $query, $type, ContextSource\getConfig(), and ContextSource\getTitle().

Referenced by setSyndicated().

◆ setFileVersion()

OutputPage::setFileVersion ( $file )

Set the displayed file version.

Parameters

File | bool $file

Returns: mixed Previous value

Definition at line 1627 of file OutputPage.php.

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

◆ setFollowPolicy()

OutputPage::setFollowPolicy ( $policy )

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

Parameters

string $policy Either 'follow' or 'nofollow'.

Returns: null

Definition at line 868 of file OutputPage.php.

Referenced by setRobotPolicy().

◆ 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 900 of file OutputPage.php.

References $name, and getContext().

Referenced by headElement(), prepareErrorPage(), and setPageTitle().

◆ setIndexPolicy()

OutputPage::setIndexPolicy ( $policy )

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

Parameters

string $policy Either 'index' or 'noindex'.

Returns: null

Definition at line 854 of file OutputPage.php.

Referenced by setRobotPolicy().

◆ 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.

Parameters

array $indicators

Since: 1.25

Definition at line 1376 of file OutputPage.php.

Referenced by addHelpLink(), and addParserOutputMetadata().

◆ setLanguageLinks()

OutputPage::setLanguageLinks ( array $newLinkArray )

Reset the language links and add new language links.

Parameters

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

Definition at line 1224 of file OutputPage.php.

◆ setLastModified()

OutputPage::setLastModified ( $timestamp )

Override the last modified timestamp.

Parameters

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

Definition at line 824 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

Definition at line 936 of file OutputPage.php.

References getContext(), ContextSource\msg(), and setHTMLTitle().

Referenced by prepareErrorPage().

◆ setPageTitleActionText()

OutputPage::setPageTitleActionText ( $text )

Set the new value of the "action text", this will be added to the "HTML title", separated from it with " - ".

Parameters

string $text New value of the "action text"

Definition at line 881 of file OutputPage.php.

◆ setPrintable()

OutputPage::setPrintable ( )

Set the page as printable, i.e.

it'll be displayed with all print styles included

Definition at line 1041 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 707 of file OutputPage.php.

References $name, and $value.

◆ setRedirectedFrom()

OutputPage::setRedirectedFrom ( $t )

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

Parameters

Title $t

Definition at line 922 of file OutputPage.php.

References $t.

◆ 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 $revid An positive integer, or null

Returns: mixed Previous value

Definition at line 1586 of file OutputPage.php.

References wfSetVar().

◆ 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 1607 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 $policy The literal string to output as the contents of the meta tag. Will be parsed according to the spec and output in standardized form.

Returns: null

Definition at line 836 of file OutputPage.php.

References Article\formatRobotPolicy(), setFollowPolicy(), and setIndexPolicy().

Referenced by prepareErrorPage().

◆ setStatusCode()

OutputPage::setStatusCode ( $statusCode )

Set the HTTP status code to send with the output.

Parameters

int $statusCode

Definition at line 351 of file OutputPage.php.

◆ setSubtitle()

OutputPage::setSubtitle ( $str )

Replace the subtitle with $str.

Parameters

string | Message $str New value of the subtitle. String should be safe HTML.

Definition at line 976 of file OutputPage.php.

References addSubtitle(), and clearSubtitle().

◆ 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 $show True: add default feeds, false: remove all feeds

Definition at line 1096 of file OutputPage.php.

References setFeedAppendQuery().

◆ setTarget()

OutputPage::setTarget ( $target )

Sets ResourceLoader target for load.php links.

If null, will be omitted

Parameters

string | null $target

Definition at line 621 of file OutputPage.php.

◆ setTitle()

OutputPage::setTitle ( Title $t )

Set the Title object to use.

Parameters

Title $t

Definition at line 967 of file OutputPage.php.

References 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	$skinName	The Skin name to determine the correct OOUI theme
String	$dir	Language direction

Definition at line 3906 of file OutputPage.php.

◆ showErrorPage()

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

Output a standard error page.

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

Parameters

string \| Message	$title	Message key (string) for page title, or a Message object
string \| Message	$msg	Message key (string) for page text, or a Message object
array	$params	Message parameters; ignored if $msg is a Message object

Definition at line 2448 of file OutputPage.php.

References $params, addHTML(), addWikiMsgArray(), ContextSource\msg(), prepareErrorPage(), and returnToMain().

◆ showFatalError()

OutputPage::showFatalError ( $message )

Definition at line 2617 of file OutputPage.php.

References addHTML(), ContextSource\msg(), and prepareErrorPage().

Referenced by showFileCopyError(), showFileDeleteError(), showFileNotFoundError(), showFileRenameError(), and showUnexpectedValueError().

◆ showFileCopyError()

OutputPage::showFileCopyError	(		$old,
			$new )

Definition at line 2627 of file OutputPage.php.

References ContextSource\msg(), showFatalError(), and text.

◆ showFileDeleteError()

OutputPage::showFileDeleteError ( $name )

Definition at line 2635 of file OutputPage.php.

References ContextSource\msg(), showFatalError(), and text.

◆ showFileNotFoundError()

OutputPage::showFileNotFoundError ( $name )

Definition at line 2639 of file OutputPage.php.

References ContextSource\msg(), showFatalError(), and text.

◆ showFileRenameError()

OutputPage::showFileRenameError	(		$old,
			$new )

Definition at line 2631 of file OutputPage.php.

References ContextSource\msg(), showFatalError(), and text.

◆ showLagWarning()

OutputPage::showLagWarning ( $lag )

Show a warning about replica DB lag.

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

Parameters

int $lag Slave lag

Definition at line 2605 of file OutputPage.php.

References ContextSource\getConfig(), ContextSource\getLanguage(), and wrapWikiMsg().

◆ showNewSectionLink()

OutputPage::showNewSectionLink ( )

Show an "add new section" link?

Returns: bool

Definition at line 1075 of file OutputPage.php.

◆ showPermissionsErrorPage()

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

Output a standard permission error page.

Parameters

array	$errors	Error message keys or [key, param...] arrays
string	$action	Action that was denied or null if unknown

Definition at line 2475 of file OutputPage.php.

References $linkRenderer, $query, $request, addHTML(), addWikiText(), array(), formatPermissionsErrorMessage(), ContextSource\getRequest(), ContextSource\getUser(), User\groupHasPermission(), ContextSource\msg(), parse(), prepareErrorPage(), returnToMain(), text, and wfArrayToCgi().

◆ showUnexpectedValueError()

OutputPage::showUnexpectedValueError	(		$name,
			$val )

Definition at line 2623 of file OutputPage.php.

References ContextSource\msg(), showFatalError(), and text.

◆ styleLink()

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

protected

Generate \<link\> tags for stylesheets.

Parameters

string	$style	URL to the file
array	$options	Option, can contain 'condition', 'dir', 'media' keys

Returns: string HTML fragment

Definition at line 3643 of file OutputPage.php.

References $link, $options, ContextSource\getConfig(), and ContextSource\getLanguage().

Referenced by buildCssLinksArray().

◆ transformCssMedia()

static OutputPage::transformCssMedia ( $media )

static

Transform "media" attribute based on request parameters.

Parameters

string $media Current value of the "media" attribute

Returns: string Modified value of the "media" attribute, or null to skip this stylesheet

Definition at line 3757 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	$remotePathPrefix	URL path prefix that points to $localPath
string	$localPath	File directory exposed at $remotePath
string	$file	Path to target file relative to $localPath

Returns: string URL

Definition at line 3741 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	$path	Path-absolute URL to file (from document root, must start with "/")

Returns: string URL

Definition at line 3699 of file OutputPage.php.

References $IP, $path, and Config\get().

◆ userCanPreview()

OutputPage::userCanPreview ( )

To make it harder for someone to slip a user a fake user-JavaScript or user-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 3190 of file OutputPage.php.

References $request, ContextSource\getRequest(), ContextSource\getTitle(), and ContextSource\getUser().

Referenced by isUserCssPreview(), and isUserJsPreview().

◆ versionRequired()

OutputPage::versionRequired ( $version )

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

Parameters

mixed $version The version of MediaWiki needed to use the page

Definition at line 2552 of file OutputPage.php.

References addWikiMsg(), ContextSource\msg(), prepareErrorPage(), and returnToMain().

◆ warnModuleTargetFilter()

OutputPage::warnModuleTargetFilter ( $moduleName )

private

Definition at line 515 of file OutputPage.php.

References getResourceLoader().

Referenced by filterModules().

◆ wrapWikiMsg()

OutputPage::wrapWikiMsg ( $wrap )

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='error'>\\n$1\\n</div>", 'some-error' );

Is equivalent to:

$wgOut->addWikiText( "<div class='error'>\\n" . wfMessage( 'some-error' )->plain() . "\\n</div>" );

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

Parameters

string $wrap

Definition at line 3845 of file OutputPage.php.

References $args, $s, addWikiText(), ContextSource\msg(), plain, and wfDeprecated().

Referenced by showLagWarning().

Member Data Documentation

◆ $copyrightUrl

string null OutputPage::$copyrightUrl

private

The URL to send in a <link> element with rel=license.

Definition at line 293 of file OutputPage.php.

◆ $limitReportJSData

array OutputPage::$limitReportJSData = []

private

Profiling data.

Definition at line 296 of file OutputPage.php.

◆ $mAdditionalBodyClasses

array OutputPage::$mAdditionalBodyClasses = []

protected

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

Definition at line 138 of file OutputPage.php.

◆ $mAllowedModules

array OutputPage::$mAllowedModules

protected

Initial value:

= [
        ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
    ]

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

See also: ResourceLoaderModule::$origin ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;

Definition at line 183 of file OutputPage.php.

◆ $mArticleBodyOnly

bool OutputPage::$mArticleBodyOnly = false

private

Flag if output should only contain the body of the article.

Definition at line 212 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 64 of file OutputPage.php.

◆ $mCanonicalUrl

bool OutputPage::$mCanonicalUrl = false

protected

Definition at line 53 of file OutputPage.php.

◆ $mCategories

array OutputPage::$mCategories

protected

Initial value:

= [
        'hidden' => [],
        'normal' => [],
    ]

Definition at line 106 of file OutputPage.php.

◆ $mCategoryLinks

array OutputPage::$mCategoryLinks = []

protected

Definition at line 103 of file OutputPage.php.

◆ $mCdnMaxage

int OutputPage::$mCdnMaxage = 0

protected

Cache stuff.

Looks like mEnableClientCache

Definition at line 231 of file OutputPage.php.

◆ $mCdnMaxageLimit

int OutputPage::$mCdnMaxageLimit = INF

protected

Upper limit on mCdnMaxage.

Definition at line 233 of file OutputPage.php.

◆ $mContainsNewMagic

int OutputPage::$mContainsNewMagic = 0

protected

Definition at line 193 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 188 of file OutputPage.php.

◆ $mEnableClientCache

OutputPage::$mEnableClientCache = true

protected

Definition at line 209 of file OutputPage.php.

◆ $mEnableTOC

bool OutputPage::$mEnableTOC = false

private

Whether parser output contains a table of contents.

Definition at line 288 of file OutputPage.php.

◆ $mFeedLinks

OutputPage::$mFeedLinks = []

private

Handles the Atom / RSS links.

We probably only support Atom in 2011.

See also: $wgAdvertisedFeedTypes

Definition at line 206 of file OutputPage.php.

◆ $mFeedLinksAppendQuery

OutputPage::$mFeedLinksAppendQuery = null

protected

Definition at line 176 of file OutputPage.php.

◆ $mFileVersion

array OutputPage::$mFileVersion = null

protected

Definition at line 249 of file OutputPage.php.

◆ $mFollowPolicy

OutputPage::$mFollowPolicy = 'follow'

private

Definition at line 262 of file OutputPage.php.

◆ $mHeadItems

array OutputPage::$mHeadItems = []

protected

Array of elements in "<head>".

Parser might add its own headers!

Definition at line 135 of file OutputPage.php.

◆ $mHideNewSectionLink

bool OutputPage::$mHideNewSectionLink = false

protected

Definition at line 218 of file OutputPage.php.

◆ $mHTMLtitle

string OutputPage::$mHTMLtitle = ''

private

Stores contents of "<title>" tag.

Definition at line 67 of file OutputPage.php.

◆ $mImageTimeKeys

array OutputPage::$mImageTimeKeys = []

protected

Definition at line 171 of file OutputPage.php.

◆ $mIndexPolicy

OutputPage::$mIndexPolicy = 'index'

private

Definition at line 261 of file OutputPage.php.

◆ $mIndicators

array OutputPage::$mIndicators = []

protected

Definition at line 112 of file OutputPage.php.

◆ $mInlineStyles

string OutputPage::$mInlineStyles = ''

protected

Inline CSS styles.

Use addInlineStyle() sparingly

Definition at line 126 of file OutputPage.php.

◆ $mIsarticle

bool OutputPage::$mIsarticle = false

private

Is the displayed content related to the source of the corresponding wiki article.

Definition at line 73 of file OutputPage.php.

◆ $mIsArticleRelated

bool OutputPage::$mIsArticleRelated = true

private

Stores "article flag" toggle.

Definition at line 76 of file OutputPage.php.

◆ $mJsConfigVars

array OutputPage::$mJsConfigVars = []

protected

Definition at line 165 of file OutputPage.php.

◆ $mLanguageLinks

array OutputPage::$mLanguageLinks = []

private

Array of Interwiki Prefixed (non DB key) Titles (e.g.

'fr:Test page')

Definition at line 115 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 100 of file OutputPage.php.

◆ $mLinkHeader

OutputPage::$mLinkHeader = []

private

Link: header contents.

Definition at line 301 of file OutputPage.php.

◆ $mLinktags

array OutputPage::$mLinktags = []

protected

Definition at line 50 of file OutputPage.php.

◆ $mMetatags

array OutputPage::$mMetatags = []

protected

Should be private.

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

Definition at line 47 of file OutputPage.php.

◆ $mModules

array OutputPage::$mModules = []

protected

Definition at line 141 of file OutputPage.php.

◆ $mModuleScripts

array OutputPage::$mModuleScripts = []

protected

Definition at line 144 of file OutputPage.php.

◆ $mModuleStyles

array OutputPage::$mModuleStyles = []

protected

Definition at line 147 of file OutputPage.php.

◆ $mNewSectionLink

bool OutputPage::$mNewSectionLink = false

protected

Definition at line 215 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.

Definition at line 225 of file OutputPage.php.

◆ $mPageLinkTitle

string OutputPage::$mPageLinkTitle = ''

Used by skin template.

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

Definition at line 132 of file OutputPage.php.

◆ $mPagetitle

string OutputPage::$mPagetitle = ''

Should be private - has getter and setter.

Contains the HTML title

Definition at line 58 of file OutputPage.php.

◆ $mPageTitleActionText

string OutputPage::$mPageTitleActionText = ''

private

Definition at line 228 of file OutputPage.php.

◆ $mParserOptions

ParserOptions OutputPage::$mParserOptions = null

protected

lazy initialised, use parserOptions()

Definition at line 199 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. Setters: $this->preventClickjacking() and $this->allowClickjacking().

Definition at line 240 of file OutputPage.php.

◆ $mPrintable

bool OutputPage::$mPrintable = false

private

We have to set isPrintable().

Some pages should never be printed (ex: redirections).

Definition at line 82 of file OutputPage.php.

◆ $mProperties

OutputPage::$mProperties = []

private

Additional key => value data.

Definition at line 278 of file OutputPage.php.

◆ $mRedirect

string OutputPage::$mRedirect = ''

Definition at line 91 of file OutputPage.php.

◆ $mRedirectCode

string OutputPage::$mRedirectCode = ''

Definition at line 174 of file OutputPage.php.

◆ $mRedirectedFrom

Title OutputPage::$mRedirectedFrom = null

private

If the current page was reached through a redirect, $mRedirectedFrom contains the Title of the redirect.

Definition at line 273 of file OutputPage.php.

◆ $mResourceLoader

ResourceLoader OutputPage::$mResourceLoader

protected

Definition at line 150 of file OutputPage.php.

◆ $mRevisionId

int OutputPage::$mRevisionId = null

private

To include the variable {{REVISIONID}}.

Definition at line 243 of file OutputPage.php.

◆ $mRevisionTimestamp

string OutputPage::$mRevisionTimestamp = null

private

Definition at line 246 of file OutputPage.php.

◆ $mScripts

OutputPage::$mScripts = ''

private

Used for JavaScript (predates ResourceLoader)

Todo: We should split JS / CSS. mScripts content is inserted as is in "<head>" by Skin. This might contain either a link to a stylesheet or inline CSS.

Definition at line 123 of file OutputPage.php.

◆ $mStatusCode

int OutputPage::$mStatusCode

protected

Definition at line 94 of file OutputPage.php.

◆ $mSubtitle

array OutputPage::$mSubtitle = []

private

Contains the page subtitle.

Special pages usually have some links here. Don't confuse with site subtitle added by skins.

Definition at line 88 of file OutputPage.php.

◆ $mTarget

string null OutputPage::$mTarget = null

private

ResourceLoader target for load.php links.

If null, will be omitted

Definition at line 283 of file OutputPage.php.

◆ $mTemplateIds

array OutputPage::$mTemplateIds = []

protected

Definition at line 168 of file OutputPage.php.

◆ $mVaryHeader

OutputPage::$mVaryHeader

private

Initial value:

= [
        'Accept-Encoding' => [ 'match=gzip' ],
    ]

Definition at line 263 of file OutputPage.php.

◆ $rlClient

ResourceLoaderClientHtml OutputPage::$rlClient

private

Definition at line 153 of file OutputPage.php.

◆ $rlClientContext

ResourceLoaderContext OutputPage::$rlClientContext

private

Definition at line 156 of file OutputPage.php.

◆ $rlExemptStyleModules

array OutputPage::$rlExemptStyleModules

private

Definition at line 162 of file OutputPage.php.

◆ $rlUserModuleState

string OutputPage::$rlUserModuleState

private

Definition at line 159 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 259 of file OutputPage.php.

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

includes/OutputPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ adaptCdnTTL()

◆ addAcceptLanguage()

◆ addBacklinkSubtitle()

◆ addBodyClasses()

◆ addCategoryLinks()

◆ addCategoryLinksToLBAndGetResult()

◆ addElement()

◆ addFeedLink()

◆ addHeadItem()

◆ addHeadItems()

◆ addHelpLink()

◆ addHTML()

◆ addInlineScript()

◆ addInlineStyle()

◆ addJsConfigVars()

◆ addLanguageLinks()

◆ addLink()

◆ addLinkHeader()

◆ addLogoPreloadLinkHeaders()

◆ addMeta()

◆ addMetadataLink()

◆ addModules()

◆ addModuleScripts()

◆ addModuleStyles()

◆ addParserOutput()

◆ addParserOutputContent()

◆ addParserOutputMetadata()

◆ addParserOutputText()

◆ addReturnTo()

◆ addScript()

◆ addScriptFile()

◆ addStyle()

◆ addSubtitle()

◆ addTemplate()

◆ addVaryHeader()

◆ addWikiMsg()

◆ addWikiMsgArray()

◆ addWikiText()

◆ addWikiTextTidy()

◆ addWikiTextTitle()

◆ addWikiTextTitleTidy()

◆ addWikiTextWithTitle()

◆ allowClickjacking()

◆ buildBacklinkSubtitle()

◆ buildCssLinksArray()

◆ buildExemptModules()

◆ checkLastModified()

◆ clearHTML()

◆ clearSubtitle()

◆ combineWrappedStrings()

◆ disable()

◆ disallowUserJs()

◆ enableClientCache()

◆ enableOOUI()

◆ enableSectionEditLinks()

◆ feedLink()

◆ filterModules()

◆ forceHideNewSectionLink()

◆ formatPermissionsErrorMessage()

◆ getAllowedModules()

◆ getArticleBodyOnly()

◆ getBottomScripts()

◆ getCacheVaryCookies()

◆ getCanonicalUrl()

◆ getCategories()

◆ getCategoryLinks()

◆ getFeedAppendQuery()

◆ getFileSearchOptions()