This class is a collection of static functions that serve two purposes: More...

Static Public Member Functions
static	buttonAttributes (array $attrs, array $modifiers=[])
	Modifies a set of attributes meant for button elements and apply a set of default attributes when $wgUseMediaWikiUIEverywhere enabled. More...

static	check ( $name, $checked=false, array $attribs=[])
	Convenience function to produce a checkbox (input element with type=checkbox) More...

static	closeElement ( $element)
	Returns "</$element>". More...

static	element ( $element, $attribs=[], $contents='')
	Identical to rawElement(), but HTML-escapes $contents (like Xml::element()). More...

static	expandAttributes (array $attribs)
	Given an associative array of element attributes, generate a string to stick after the element name in HTML output. More...

static	getTextInputAttributes (array $attrs)
	Modifies a set of attributes meant for text input elements and apply a set of default attributes. More...

static	hidden ( $name, $value, array $attribs=[])
	Convenience function to produce an input element with type=hidden. More...

static	htmlHeader (array $attribs=[])
	Constructs the opening html-tag with necessary doctypes depending on global variables. More...

static	infoBox ( $text, $icon, $alt, $class='')
	Get HTML for an info box with an icon. More...

static	inlineScript ( $contents)
	Output a "<script>" tag with the given contents. More...

static	inlineStyle ( $contents, $media='all')
	Output a "<style>" tag with the given contents for the given media type (if any). More...

static	input ( $name, $value='', $type='text', array $attribs=[])
	Convenience function to produce an "<input>" element. More...

static	isXmlMimeType ( $mimetype)
	Determines if the given MIME type is xml. More...

static	label ( $label, $id, array $attribs=[])
	Convenience function for generating a label for inputs. More...

static	linkButton ( $contents, array $attrs, array $modifiers=[])
	Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enabled). More...

static	linkedScript ( $url)
	Output a "<script>" tag linking to the given URL, e.g., "<script src=foo.js></script>". More...

static	linkedStyle ( $url, $media='all')
	Output a "<link rel=stylesheet>" linking to the given URL for the given media type (if any). More...

static	namespaceSelector (array $params=[], array $selectAttribs=[])
	Build a drop-down box for selecting a namespace. More...

static	namespaceSelectorOptions (array $params=[])
	Helper for Html::namespaceSelector(). More...

static	openElement ( $element, $attribs=[])
	Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/' in XML mode for empty elements). More...

static	radio ( $name, $checked=false, array $attribs=[])
	Convenience function to produce a radio button (input element with type=radio) More...

static	rawElement ( $element, $attribs=[], $contents='')
	Returns an HTML element in a string. More...

static	srcSet (array $urls)
	Generate a srcset attribute value. More...

static	submitButton ( $contents, array $attrs, array $modifiers=[])
	Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enabled). More...

static	textarea ( $name, $value='', array $attribs=[])
	Convenience function to produce a <textarea> element. More...

Static Private Member Functions
static	dropDefaults ( $element, array $attribs)
	Given an element name and an associative array of element attributes, return an array that is functionally identical to the input array, but possibly smaller. More...

Static Private Attributes
static	$boolAttribs

static	$voidElements

Detailed Description

This class is a collection of static functions that serve two purposes:

1) Implement any algorithms specified by HTML5, or other HTML specifications, in a convenient and self-contained way.

2) Allow HTML elements to be conveniently and safely generated, like the current Xml class but a) less confused (Xml supports HTML-specific things, but only sometimes!) and b) not necessarily confined to XML-compatible output.

There are two important configuration options this class uses:

$wgMimeType: If this is set to an xml MIME type then output should be valid XHTML5.

This class is meant to be confined to utility functions that are called from trusted code paths. It does not do enforcement of policy like not allowing elements.

Since: 1.16

Definition at line 48 of file Html.php.

Member Function Documentation

◆ buttonAttributes()

static Html::buttonAttributes	(	array	$attrs,
		array	$modifiers = `[]`
	)

static

Modifies a set of attributes meant for button elements and apply a set of default attributes when $wgUseMediaWikiUIEverywhere enabled.

Parameters

array	$attrs	HTML attributes in an associative array
string[]	$modifiers	classes to add to the button

See also: https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers

Returns: array $attrs A modified attribute array

Definition at line 109 of file Html.php.

References $wgUseMediaWikiUIEverywhere, and global.

Referenced by PreferencesForm\getButtons(), and input().

◆ check()

static Html::check	(		$name,
			$checked = `false`,
		array	$attribs = `[]`
	)

static

Convenience function to produce a checkbox (input element with type=checkbox)

Parameters

string	$name	Name attribute
bool	$checked	Whether the checkbox is checked or not
array	$attribs	Array of additional attributes

Returns: string Raw HTML

Definition at line 663 of file Html.php.

References $attribs, $name, $value, and input().

◆ closeElement()

static Html::closeElement ( $element )

static

Returns "</$element>".

Since: 1.17

Parameters

string $element Name of the element, e.g., 'a'

Returns: string A closing tag

Definition at line 309 of file Html.php.

Referenced by CategoryViewer\columnList(), SpecialCategories\execute(), SpecialListGrants\execute(), SpecialTrackingCategories\execute(), SpecialGadgetUsage\formatResult(), TablePager\formatRow(), SpecialLog\getActionButtons(), SpecialChangeCredentials\getAuthForm(), OracleInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), MysqlInstaller\getConnectForm(), MssqlInstaller\getConnectForm(), SpecialVersion\getCreditsForExtension(), SpecialVersion\getEntryPointInfo(), SpecialVersion\getExternalLibraries(), BaseTemplate\getFooter(), FancyCaptcha\getFormInformation(), ApiHelp\getHelpInternal(), HTMLFancyCaptchaField\getInputHTML(), DatabaseInstaller\getInstallUserBox(), HTMLMultiSelectField\getOneCheckbox(), HTMLCheckMatrix\getOneCheckbox(), EditPage\getPreviewLimitReport(), MssqlInstaller\getSettingsForm(), DatabaseInstaller\getWebUserBox(), SpecialVersion\getWgHooks(), OutputPage\headElement(), ImagePage\imageLinks(), infoBox(), ChangesListSpecialPage\makeLegend(), SpecialInterwiki\makeTable(), ApiMain\modifyHelp(), namespaceSelector(), ConfirmEditHooks\onAlternateEditPreview(), SpecialVersion\openExtType(), WebInstallerOutput\outputFooter(), SpecialSpecialpages\outputPageList(), SpecialGadgetUsage\outputResults(), MediaStatisticsPage\outputTableEnd(), SpecialGadgetUsage\outputTableStart(), rawElement(), SpecialAllPages\showChunk(), SpecialGadgets\showExportForm(), SpecialExpandTemplates\showHtmlPreview(), SpecialPrefixindex\showPrefixChunk(), SpecialChangeCredentials\showSubpageList(), UserrightsPage\switchForm(), SpecialEmailUser\userForm(), TitleBlacklistHooks\validateBlacklist(), and wfHtmlValidationHandler().

◆ dropDefaults()

static Html::dropDefaults	(		$element,
		array	$attribs
	)

staticprivate

Given an element name and an associative array of element attributes, return an array that is functionally identical to the input array, but possibly smaller.

In particular, attributes might be stripped if they are given their default values.

This method is not guaranteed to remove all redundant attributes, only some common ones and some others selected arbitrarily at random. It only guarantees that the output array should be functionally identical to the input array (currently per the HTML 5 draft as of 2009-09-06).

Parameters

string	$element	Name of the element, e.g., 'a'
array	$attribs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.

Returns: array An array of attributes functionally identical to $attribs

Definition at line 332 of file Html.php.

References $attribs, $type, $value, and as.

◆ element()

static Html::element	(	$element,
		$attribs = `[]`,
		$contents = `''`
	)

static

Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).

Parameters

string	$element	Name of the element, e.g., 'a'
array	$attribs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.
string	$contents

Returns: string

Definition at line 231 of file Html.php.

References $attribs, and rawElement().

Referenced by OutputPage\addElement(), JsonContent\arrayTable(), OutputPage\buildExemptModules(), ListToggle\checkboxLink(), ApiFormatBase\closePrinter(), SimpleCaptcha\confirmEditMerged(), MWDebug\deprecated(), SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), WebInstallerDBConnect\execute(), SpecialPreferences\execute(), SpecialListGrants\execute(), SpecialVersion\execute(), UserrightsPage\execute(), OutputPage\feedLink(), ChangesList\flag(), PageQueryPage\formatResult(), FewestrevisionsPage\formatResult(), MostlinkedCategoriesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), MostlinkedTemplatesPage\formatResult(), MostlinkedPage\formatResult(), UnwatchedpagesPage\formatResult(), ShortPagesPage\formatResult(), SpecialGadgetUsage\formatResult(), SpecialPagesWithProp\formatResult(), SpecialProtectedtitles\formatRow(), SpecialNewpages\formatRow(), ProtectedPagesPager\formatValue(), SpecialLog\getActionButtons(), SpecialChangeCredentials\getAuthForm(), VFormHTMLForm\getButtons(), HTMLForm\getButtons(), BaseTemplate\getClear(), OracleInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), MysqlInstaller\getConnectForm(), MssqlInstaller\getConnectForm(), SpecialVersion\getCreditsForExtension(), UploadForm\getDescriptionSection(), FeedUtils\getDiffLink(), TablePager\getEmptyBody(), SpecialVersion\getEntryPointInfo(), SpecialVersion\getExternalLibraries(), LoginSignupSpecialPage\getFieldDefinitions(), QuestyCaptcha\getFormInformation(), FancyCaptcha\getFormInformation(), OutputPage\getHeadLinksArray(), ApiHelp\getHelpInternal(), HTMLFancyCaptchaField\getInputHTML(), HTMLButtonField\getInputHTML(), HTMLCheckMatrix\getInputHTML(), DatabaseInstaller\getInstallUserBox(), UploadSourceField\getLabelHtml(), RevDelFileItem\getLink(), HTMLCheckMatrix\getOneCheckbox(), WebInstaller\getPageListItem(), SpecialVersion\getParserTags(), HistoryPager\getRevisionButton(), MssqlInstaller\getSettingsForm(), TablePager\getStartBody(), SpecialVersion\getVersionLinkedGit(), DatabaseInstaller\getWebUserBox(), SpecialVersion\getWgHooks(), OutputPage\headElement(), infoBox(), input(), label(), linkButton(), linkedScript(), linkedStyle(), Linker\makeExternalImage(), Skin\makeFooterIcon(), InfoAction\makeHeader(), ChangesListSpecialPage\makeLegend(), SpecialBookSources\makeListItem(), ResourceLoaderClientHtml\makeLoad(), BaseTemplate\makeSearchButton(), BaseTemplate\makeSearchInput(), SpecialInterwiki\makeTable(), ApiMain\modifyHelp(), namespaceSelector(), Language\numLink(), JsonContent\objectRow(), JsonContent\objectTable(), ConfirmEditHooks\onAlternateEditPreview(), InfoAction\onView(), SpecialVersion\openExtType(), Xml\option(), MediaStatisticsPage\outputMediaType(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialGadgetUsage\outputResults(), MediaStatisticsPage\outputTableRow(), SpecialGadgetUsage\outputTableStart(), InfoAction\pageInfo(), ImportReporter\reportNotice(), MWExceptionRenderer\reportOutageHTML(), JsonContent\rootValueTable(), ChangesList\showCharacterDifference(), SpecialAllPages\showChunk(), DifferenceEngine\showDiffPage(), SpecialInterwiki\showForm(), SpecialImport\showForm(), SpecialUndelete\showHistory(), SpecialAutoblockList\showList(), SpecialBlockList\showList(), SpecialUndelete\showList(), SpecialGadgets\showMainForm(), SpecialPrefixindex\showPrefixChunk(), EditPage\showStandardInputs(), SpecialChangeCredentials\showSubpageList(), SpecialAutoblockList\showTotal(), SpecialUploadStash\showUploads(), WebInstaller\startPageWrapper(), submitButton(), Xml\submitButton(), textarea(), Linker\tocLine(), TitleBlacklistHooks\validateBlacklist(), JsonContent\valueCell(), and wfHtmlValidationHandler().

◆ expandAttributes()

static Html::expandAttributes ( array $attribs )

static

Given an associative array of element attributes, generate a string to stick after the element name in HTML output.

Like [ 'href' => 'https://www.mediawiki.org/' ] becomes something like ' href="https://www.mediawiki.org"'. Again, this is like Xml::expandAttributes(), but it implements some HTML-specific logic.

Attributes that can contain space-separated lists ('class', 'accesskey' and 'rel') array values are allowed as well, which will automagically be normalized and converted to a space-separated string. In addition to a numerical array, the attribute value may also be an associative array. See the example below for how that works.

Numerical array: Html::element( 'em', [

'class' => [ 'foo', 'bar' ]

] );

// gives '<em class="foo bar"></em>'

Associative array: Html::element( 'em', [

'class' => [ 'foo', 'bar', 'foo' => false, 'quux' => true ]

] );

// gives '<em class="bar quux"></em>'

Parameters

array $attribs Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. Values will be HTML-escaped. A value of false or null means to omit the attribute. For boolean attributes, you can omit the key, e.g., [ 'checked' ] instead of [ 'checked' => 'checked' ] or such.

Exceptions

MWException If an attribute that doesn't allow lists is set to an array

Returns: string HTML fragment that goes between element name and '>' (starting with a space if at least one attribute is output)

Definition at line 474 of file Html.php.

References $attribs, $ret, $value, and as.

Referenced by EnhancedChangesList\getLineData(), and openElement().

◆ getTextInputAttributes()

static Html::getTextInputAttributes ( array $attrs )

static

Modifies a set of attributes meant for text input elements and apply a set of default attributes.

Removes size attribute when $wgUseMediaWikiUIEverywhere enabled.

Parameters

array $attrs An attribute array.

Returns: array $attrs A modified attribute array

Definition at line 136 of file Html.php.

References $wgUseMediaWikiUIEverywhere, and global.

Referenced by Xml\input(), input(), and Xml\textarea().

◆ hidden()

static Html::hidden	(		$name,
			$value,
		array	$attribs = `[]`
	)

static

Convenience function to produce an input element with type=hidden.

Parameters

string	$name	Name attribute
string	$value	Value attribute
array	$attribs	Associative array of miscellaneous extra attributes, passed to Html::element()

Returns: string Raw HTML

Definition at line 725 of file Html.php.

References $attribs, $name, $value, and input().

Referenced by SpecialEditTags\buildCheckBoxes(), AllMessagesTablePager\buildForm(), ProtectionForm\buildForm(), Article\confirmDelete(), Preferences\datetimePreferences(), SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), ImagePage\doRenderLangOpt(), SpecialRenameuser\execute(), WebInstallerLanguage\execute(), SpecialNewpages\form(), SpecialLog\getActionButtons(), InputBox\getCommentForm(), InputBox\getCreateForm(), LogEventsList\getFilterLinks(), SpecialContributions\getForm(), MathCaptcha\getFormInformation(), TablePager\getHiddenFields(), HTMLForm\getHiddenFields(), HTMLFormFieldCloner\getInputHTMLForKey(), InputBox\getMoveForm(), InputBox\getSearchForm(), HistoryPager\getStartBody(), UserrightsPage\groupCheckboxes(), SpecialNuke\listForm(), SpecialPrefixindex\namespacePrefixForm(), HistoryAction\onView(), ImagePage\openShowImage(), MediaWiki\Widget\Search\SearchFormWidget\powerSearchBox(), SpecialWatchlist\setTopText(), MediaWiki\Widget\Search\SearchFormWidget\shortDialogHtml(), EditPage\showEditForm(), UserrightsPage\showEditUserGroupsForm(), SpecialGadgets\showExportForm(), SpecialInterwiki\showForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), FileDeleteForm\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), EditPage\showFormAfterText(), EditPage\showFormBeforeText(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), LogEventsList\showOptions(), SpecialProtectedtitles\showOptions(), SpecialUndelete\showSearchForm(), UserrightsPage\switchForm(), SpecialEmailUser\userForm(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ htmlHeader()

static Html::htmlHeader ( array $attribs = [] )

static

Constructs the opening html-tag with necessary doctypes depending on global variables.

Parameters

array $attribs Associative array of miscellaneous extra attributes, passed to Html::element() of html tag.

Returns: string Raw HTML

Definition at line 886 of file Html.php.

References $attribs, $ret, $wgHtml5Version, $wgMimeType, $wgXhtmlNamespaces, as, global, isXmlMimeType(), and openElement().

Referenced by OutputPage\headElement(), WebInstallerOutput\outputHeader(), WebInstallerOutput\outputShortHeader(), and wfHtmlValidationHandler().

◆ infoBox()

static Html::infoBox	(	$text,
		$icon,
		$alt,
		$class = `''`
	)

static

Get HTML for an info box with an icon.

Parameters

string	$text	Wikitext, get this with wfMessage()->plain()
string	$icon	Path to icon file (used as 'src' attribute)
string	$alt	Alternate text for the icon
string	$class	Additional class name to add to the wrapper div

Returns: string

Definition at line 943 of file Html.php.

References $s, closeElement(), element(), and openElement().

Referenced by WebInstaller\getInfoBox().

◆ inlineScript()

static Html::inlineScript ( $contents )

static

Output a "<script>" tag with the given contents.

Todo:: do some useful escaping as well, like if $contents contains literal "</script>" or (for XML) literal "]]>".

Parameters

string $contents JavaScript

Returns: string Raw HTML

Definition at line 562 of file Html.php.

References rawElement().

Referenced by OutputPage\addInlineScript(), ReCaptcha\getFormInformation(), ResourceLoaderClientHtml\getHeadHtml(), and HTMLReCaptchaField\getInputHTML().

◆ inlineStyle()

static Html::inlineStyle	(	$contents,
		$media = `'all'`
	)

static

Output a "<style>" tag with the given contents for the given media type (if any).

TODO: do some useful escaping as well, like if $contents contains literal "</style>" (admittedly unlikely).

Parameters

string	$contents	CSS
string	$media	A media type string, like 'screen'

Returns: string Raw HTML

Definition at line 594 of file Html.php.

References rawElement().

Referenced by OutputPage\addInlineStyle(), OutputPage\buildExemptModules(), ResourceLoaderClientHtml\makeLoad(), and wfHtmlValidationHandler().

◆ input()

static Html::input	(		$name,
			$value = `''`,
			$type = `'text'`,
		array	$attribs = `[]`
	)

static

Convenience function to produce an "<input>" element.

This supports the new HTML5 input types and attributes.

Parameters

string	$name	Name attribute
string	$value	Value attribute
string	$type	Type attribute
array	$attribs	Associative array of miscellaneous extra attributes, passed to Html::element()

Returns: string Raw HTML

Definition at line 642 of file Html.php.

References $attribs, $name, $type, $value, buttonAttributes(), element(), and getTextInputAttributes().

Referenced by check(), Xml\dateMenu(), SpecialContributions\getForm(), MathCaptcha\getFormInformation(), HTMLSelectOrOtherField\getInputHTML(), HTMLSelectAndOtherField\getInputHTML(), HTMLFormFieldWithButton\getInputHTML(), HTMLTextField\getInputHTML(), EditPage\getSummaryInput(), hidden(), radio(), SpecialImport\showForm(), and SpecialEmailUser\userForm().

◆ isXmlMimeType()

static Html::isXmlMimeType ( $mimetype )

static

Determines if the given MIME type is xml.

Parameters

string $mimetype MIME type

Returns: bool

Definition at line 925 of file Html.php.

Referenced by OutputPage\headElement(), and htmlHeader().

◆ label()

static Html::label	(		$label,
			$id,
		array	$attribs = `[]`
	)

static

Convenience function for generating a label for inputs.

Parameters

string	$label	Contents of the label
string	$id	ID of the element being labeled
array	$attribs	Additional attributes

Returns: string Raw HTML

Definition at line 709 of file Html.php.

References $attribs, and element().

Referenced by SpecialEmailUser\userForm().

◆ linkButton()

static Html::linkButton	(		$contents,
		array	$attrs,
		array	$modifiers = `[]`
	)

static

Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enabled).

Parameters

string	$contents	The raw HTML contents of the element: not escaped!
array	$attrs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.
string[]	$modifiers	classes to add to the button

See also: https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers

Returns: string Raw HTML

Definition at line 165 of file Html.php.

References element().

Referenced by EditPage\showStandardInputs().

◆ linkedScript()

static Html::linkedScript ( $url )

static

Output a "<script>" tag linking to the given URL, e.g., "<script src=foo.js></script>".

Parameters

string $url

Returns: string Raw HTML

Definition at line 579 of file Html.php.

References element().

Referenced by OutputPage\addScriptFile(), WebInstallerOutput\getJQuery(), WebInstallerOutput\outputHeader(), WebInstallerOutput\outputShortHeader(), and SpecialJavaScriptTest\plainQUnit().

◆ linkedStyle()

static Html::linkedStyle	(	$url,
		$media = `'all'`
	)

static

Output a "<link rel=stylesheet>" linking to the given URL for the given media type (if any).

Parameters

string	$url
string	$media	A media type string, like 'screen'

Returns: string Raw HTML

Definition at line 623 of file Html.php.

References element().

Referenced by WebInstallerOutput\getCssUrl(), ResourceLoaderClientHtml\makeLoad(), and OutputPage\styleLink().

◆ namespaceSelector()

static Html::namespaceSelector	(	array	$params = `[]`,
		array	$selectAttribs = `[]`
	)

static

Build a drop-down box for selecting a namespace.

Parameters

array	$params	Params to set. selected: [optional] Id of namespace which should be pre-selected all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces. label: text for label to add before the field. exclude: [optional] Array of namespace ids to exclude. disable: [optional] Array of namespace ids for which the option should be disabled in the selector.
array	$selectAttribs	HTML attributes for the generated select element. id: [optional], default: 'namespace'. name: [optional], default: 'namespace'.

Returns: string HTML code to select a namespace.

Definition at line 813 of file Html.php.

References $options, $params, $ret, as, closeElement(), element(), namespaceSelectorOptions(), and openElement().

Referenced by SpecialWatchlist\doHeader(), SpecialContributions\getForm(), HTMLSelectNamespace\getInputHTML(), SpecialImport\getMappingFormPart(), SpecialProtectedpages\getNamespaceMenu(), SpecialProtectedtitles\getNamespaceMenu(), SpecialRecentChanges\namespaceFilterForm(), SpecialPrefixindex\namespacePrefixForm(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ namespaceSelectorOptions()

static Html::namespaceSelectorOptions ( array $params = [] )

static

Helper for Html::namespaceSelector().

Parameters

array $params See Html::namespaceSelector()

Returns: array

Definition at line 761 of file Html.php.

References $options, $params, $wgContLang, as, global, NS_MAIN, and wfMessage().

Referenced by MediaWiki\Widget\NamespaceInputWidget\getNamespaceDropdownOptions(), and namespaceSelector().

◆ openElement()

static Html::openElement	(	$element,
		$attribs = `[]`
	)

static

Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/' in XML mode for empty elements).

Parameters

string	$element	Name of the element, e.g., 'a'
array	$attribs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.

Returns: string

Definition at line 251 of file Html.php.

References $attribs, array(), and expandAttributes().

Referenced by DifferenceEngine\addHeader(), CategoryViewer\columnList(), MonoBookTemplate\customBox(), WebInstallerDBConnect\execute(), SpecialCategories\execute(), SpecialTrackingCategories\execute(), SpecialListGrants\execute(), SpecialGadgetUsage\formatResult(), TablePager\formatRow(), SpecialLog\getActionButtons(), SpecialChangeCredentials\getAuthForm(), OracleInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), MysqlInstaller\getConnectForm(), MssqlInstaller\getConnectForm(), SpecialVersion\getCreditsForExtension(), SpecialVersion\getEntryPointInfo(), SpecialVersion\getExternalLibraries(), BaseTemplate\getFooter(), SpecialContributions\getForm(), FancyCaptcha\getFormInformation(), ApiHelp\getHelpInternal(), CategoryViewer\getHTML(), HTMLFancyCaptchaField\getInputHTML(), DatabaseInstaller\getInstallUserBox(), HTMLMultiSelectField\getOneCheckbox(), HTMLCheckMatrix\getOneCheckbox(), EditPage\getPreviewLimitReport(), MssqlInstaller\getSettingsForm(), TablePager\getStartBody(), HistoryPager\getStartBody(), DatabaseInstaller\getWebUserBox(), SpecialVersion\getWgHooks(), OutputPage\headElement(), htmlHeader(), ImagePage\imageLinks(), infoBox(), ChangesListSpecialPage\makeLegend(), SpecialInterwiki\makeTable(), ApiMain\modifyHelp(), namespaceSelector(), ConfirmEditHooks\onAlternateEditPreview(), SpecialVersion\openExtType(), WebInstallerOutput\outputHeader(), SpecialSpecialpages\outputPageList(), SpecialGadgetUsage\outputResults(), SpecialGadgetUsage\outputTableStart(), MediaStatisticsPage\outputTableStart(), rawElement(), EnhancedChangesList\recentChangesBlockLine(), SpecialAllPages\showChunk(), EditPage\showEditForm(), SpecialGadgets\showExportForm(), SpecialExpandTemplates\showHtmlPreview(), SpecialPrefixindex\showPrefixChunk(), SpecialChangeCredentials\showSubpageList(), UserrightsPage\switchForm(), Linker\tocLine(), SpecialEmailUser\userForm(), TitleBlacklistHooks\validateBlacklist(), and wfHtmlValidationHandler().

◆ radio()

static Html::radio	(		$name,
			$checked = `false`,
		array	$attribs = `[]`
	)

static

Convenience function to produce a radio button (input element with type=radio)

Parameters

string	$name	Name attribute
bool	$checked	Whether the radio button is checked or not
array	$attribs	Array of additional attributes

Returns: string Raw HTML

Definition at line 686 of file Html.php.

References $attribs, $name, $value, and input().

◆ rawElement()

static Html::rawElement	(	$element,
		$attribs = `[]`,
		$contents = `''`
	)

static

Returns an HTML element in a string.

The major advantage here over manually typing out the HTML is that it will escape all attribute values.

This is quite similar to Xml::tags(), but it implements some useful HTML-specific logic. For instance, there is no $allowShortTag parameter: the closing tag is magically omitted if $element has an empty content model.

Parameters

string	$element	The element's name, e.g., 'a'
array	$attribs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.
string	$contents	The raw HTML contents of the element: not escaped!

Returns: string Raw HTML

Definition at line 209 of file Html.php.

References $attribs, closeElement(), and openElement().

Referenced by OutputPage\addHelpLink(), InfoAction\addRow(), InfoAction\addTable(), SpecialBlock\alterForm(), JsonContent\arrayRow(), JsonContent\arrayTable(), MediaWiki\Linker\LinkRenderer\buildAElement(), ChangeTags\buildTagFilterSelector(), SpecialEditWatchlist\buildTools(), ApiFormatBase\closePrinter(), MWDebug\deprecated(), EditPage\displayPreviewArea(), SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), ImagePage\doRenderLangOpt(), WebInstaller\downloadLinkHook(), WikiEditorHooks\EditPageBeforeEditToolbar(), element(), SpecialRenameuser\execute(), SpecialApiHelp\execute(), SpecialPreferences\execute(), SpecialListGrants\execute(), SpecialListGroupRights\execute(), SpecialActiveUsers\execute(), SpecialListUsers\execute(), UserrightsPage\execute(), FormatMetadata\flattenArrayReal(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), SpecialNewpages\form(), TemplatesOnThisPageFormatter\format(), OldChangesList\formatChangeLine(), DateFormatter\formatDate(), HTMLFormField\formatErrors(), HTMLForm\formatErrors(), CategoryViewer\formatList(), HTMLMultiSelectField\formatOptions(), HTMLRadioField\formatOptions(), XmlSelect\formatOptions(), DeletedContribsPager\formatRevisionRow(), SpecialMergeHistory\formatRevisionRow(), SpecialProtectedtitles\formatRow(), CategoryPager\formatRow(), SpecialStatistics\formatRow(), ActiveUsersPager\formatRow(), UsersPager\formatRow(), TablePager\formatRow(), DeletedContribsPager\formatRow(), SpecialNewpages\formatRow(), ContribsPager\formatRow(), HTMLForm\formatSection(), BlockListPager\formatValue(), ProtectedPagesPager\formatValue(), BaseTemplate\getAfterPortlet(), OOUIHTMLForm\getButtons(), VFormHTMLForm\getButtons(), HTMLForm\getButtons(), Skin\getCachedNotice(), Skin\getCategories(), EditPage\getCheckboxes(), SpecialVersion\getCreditsForExtension(), HTMLFormField\getDiv(), Title\getEditNotices(), TablePager\getEmptyBody(), SpecialVersion\getEntryPointInfo(), HTMLForm\getErrorsOrWarnings(), SpecialVersion\getExternalLibraries(), LoginSignupSpecialPage\getFieldDefinitions(), BaseTemplate\getFooter(), SpecialContributions\getForm(), FancyCaptcha\getFormInformation(), ApiHelp\getHelpInternal(), HTMLFormField\getHelpTextHtmlDiv(), HTMLFormField\getHelpTextHtmlTable(), ListToggle\getHTML(), XmlSelect\getHTML(), BaseTemplate\getIndicators(), HTMLCheckField\getInputHTML(), HTMLFancyCaptchaField\getInputHTML(), HTMLButtonField\getInputHTML(), HTMLCheckMatrix\getInputHTML(), Licenses\getInputHTML(), HTMLFormFieldCloner\getInputHTML(), HTMLFormFieldCloner\getInputHTMLForKey(), UploadSourceField\getLabelHtml(), HTMLFancyCaptchaField\getLabelHtml(), HTMLFormField\getLabelHtml(), TablePager\getLimitForm(), SpecialProtectedpages\getNamespaceMenu(), LoginSignupSpecialPage\getPageHtml(), SpecialVersion\getParserFunctionHooks(), SpecialVersion\getParserTags(), EditPage\getPreviewLimitReport(), EditPage\getPreviewText(), Block\getRedactedName(), LogFormatter\getRestrictedElement(), DifferenceEngine\getRevisionHeader(), TablePager\getStartBody(), MediaStatisticsPage\getTableHeaderRow(), HTMLCheckMatrix\getTableRow(), HTMLFormField\getTableRow(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget\headerHtml(), HistoryPager\historyLine(), CoreTagHooks\html(), ImagePage\imageLinks(), Poem\indentVerse(), inlineScript(), inlineStyle(), LogEventsList\logLine(), Linker\makeExternalLink(), Skin\makeFooterIcon(), InfoAction\makeHeader(), ChangesListSpecialPage\makeLegend(), BaseTemplate\makeLink(), VectorTemplate\makeLink(), SpecialBookSources\makeListItem(), BaseTemplate\makeListItem(), ResourceLoaderClientHtml\makeLoad(), Linker\makeMediaLinkFile(), ImagePage\makeMetadataTable(), BaseTemplate\makeSearchButton(), ImagePage\makeSizeLink(), SpecialInterwiki\makeTable(), EditPage\makeTemplatesOnThisPageList(), Linker\makeThumbLink2(), ApiMain\modifyHelp(), JsonContent\objectRow(), JsonContent\objectTable(), ConfirmEditHooks\onAlternateEditPreview(), CreditsAction\onView(), SpecialVersion\openExtType(), ImagePage\openShowImage(), SpecialRecentChanges\optionsPanel(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialSpecialpages\outputPageList(), MediaStatisticsPage\outputTableRow(), InfoAction\pageInfo(), SpecialBlock\postText(), CoreTagHooks\pre(), SkinTemplate\prepareQuickTemplate(), SpecialBlock\preText(), EnhancedChangesList\recentChangesBlockLine(), OldChangesList\recentChangesLine(), MediaWiki\Widget\Search\InterwikiSearchResultWidget\render(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\render(), Poem\renderPoem(), JsonContent\rootValueTable(), SpecialNewFiles\setTopText(), SpecialRecentChanges\setTopText(), SpecialWatchlist\setTopText(), SpecialAllPages\showChunk(), DifferenceEngine\showDiffPage(), EditPage\showEditForm(), SpecialInterwiki\showForm(), SpecialWatchlist\showHideCheck(), OutputPage\showLagWarning(), SpecialAutoblockList\showList(), SpecialBlockList\showList(), LogEventsList\showLogExtract(), SpecialGadgets\showMainForm(), SpecialPrefixindex\showPrefixChunk(), SpecialSearch\showResults(), SpecialChangeCredentials\showSubpageList(), SpecialUploadStash\showUploads(), LogFormatter\styleRestricedElement(), Linker\tocLine(), SpecialEmailUser\userForm(), JsonContent\valueCell(), wfHtmlValidationHandler(), ApiHelp\wrap(), VFormHTMLForm\wrapForm(), HTMLForm\wrapForm(), and SkinTemplate\wrapHTML().

◆ srcSet()

static Html::srcSet ( array $urls )

static

Generate a srcset attribute value.

Generates a srcset attribute value from an array mapping pixel densities to URLs. A trailing 'x' in pixel density values is optional.

Note: srcset width and height values are not supported.

See also: https://html.spec.whatwg.org/#attr-img-srcset

Example:: Html::srcSet( [

'1x' => 'standard.jpeg',

'1.5x' => 'large.jpeg',

'3x' => 'extra-large.jpeg',

] );

// gives 'standard.jpeg 1x, large.jpeg 1.5x, extra-large.jpeg 2x'

Parameters

string[] $urls

Returns: string

Definition at line 990 of file Html.php.

References as, and string.

Referenced by ThumbnailImage\toHtml().

◆ submitButton()

static Html::submitButton	(		$contents,
		array	$attrs,
		array	$modifiers = `[]`
	)

static

Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enabled).

Parameters

string	$contents	The raw HTML contents of the element: not escaped!
array	$attrs	Associative array of attributes, e.g., [ 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for further documentation.
string[]	$modifiers	classes to add to the button

See also: https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers

Returns: string Raw HTML

Definition at line 185 of file Html.php.

References element().

Referenced by SpecialContributions\getForm(), HistoryAction\onView(), HistoryPager\submitButton(), and SpecialEmailUser\userForm().

◆ textarea()

static Html::textarea	(		$name,
			$value = `''`,
		array	$attribs = `[]`
	)

static

Convenience function to produce a <textarea> element.

This supports leaving out the cols= and rows= which Xml requires and are required by HTML4/XHTML but not required by HTML5.

Parameters

string	$name	Name attribute
string	$value	Value attribute
array	$attribs	Associative array of miscellaneous extra attributes, passed to Html::element()

Returns: string Raw HTML

Definition at line 741 of file Html.php.

References $attribs, $name, $value, and element().

Referenced by HTMLTextAreaField\getInputHTML(), and EditPage\showTextbox().

Member Data Documentation

◆ $boolAttribs

Html::$boolAttribs

staticprivate

Initial value:

= [
        'async',
        'autofocus',
        'autoplay',
        'checked',
        'controls',
        'default',
        'defer',
        'disabled',
        'formnovalidate',
        'hidden',
        'ismap',
        'itemscope',
        'loop',
        'multiple',
        'muted',
        'novalidate',
        'open',
        'pubdate',
        'readonly',
        'required',
        'reversed',
        'scoped',
        'seamless',
        'selected',
        'truespeed',
        'typemustmatch',
        
        'itemscope',
    ]

Definition at line 70 of file Html.php.

◆ $voidElements

Html::$voidElements

staticprivate

Initial value:

= [
        'area',
        'base',
        'br',
        'col',
        'embed',
        'hr',
        'img',
        'input',
        'keygen',
        'link',
        'meta',
        'param',
        'source',
        'track',
        'wbr',
    ]

Definition at line 50 of file Html.php.

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

includes/Html.php

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ buttonAttributes()

◆ check()

◆ closeElement()

◆ dropDefaults()

◆ element()

◆ expandAttributes()

◆ getTextInputAttributes()

◆ hidden()

◆ htmlHeader()

◆ infoBox()

◆ inlineScript()

◆ inlineStyle()

◆ input()

◆ isXmlMimeType()

◆ label()

◆ linkButton()

◆ linkedScript()

◆ linkedStyle()

◆ namespaceSelector()

◆ namespaceSelectorOptions()

◆ openElement()

◆ radio()

◆ rawElement()

◆ srcSet()

◆ submitButton()

◆ textarea()

Member Data Documentation

◆ $boolAttribs

◆ $voidElements