The edit page/HTML interface (split from Article) The actual database and text munging is still in Article, but it should get easier to call those from alternate interfaces. More...

Inheritance diagram for EditPage:

[legend]

Collaboration diagram for EditPage:

[legend]

Public Member Functions
	__construct (Article $article)
	Stable to call. More...

	attemptSave (&$resultDetails=false)
	Attempt submission. More...

	edit ()
	This is the function that gets called for "action=edit". More...

	getArticle ()

	getBaseRevision ()
	Returns the revision that was current at the time editing was initiated on the client, even if the edit was based on an old revision. More...

	getCancelLink ( $tabindex=0)

	getCheckboxesDefinition ( $checked)
	Return an array of checkbox definitions. More...

	getCheckboxesWidget (&$tabindex, $checked)
	Returns an array of checkboxes for the edit form, including 'minor' and 'watch' checkboxes and any other added by extensions. More...

	getContext ()

	getContextTitle ()
	Get the context title object. More...

	getEditButtons (&$tabindex)
	Returns an array of html code of the following buttons: save, diff and preview. More...

	getExpectedParentRevision ()
	Returns the RevisionRecord corresponding to the revision that was current at the time editing was initiated on the client even if the edit was based on an old revision. More...

	getParentRevId ()
	Get the edit's parent revision ID. More...

	getPreviewText ()
	Get the rendered text for previewing. More...

	getSummaryInputWidget ( $summary="", $labelText=null, $inputAttrs=null)
	Builds a standard summary input with a label. More...

	getTemplates ()

	getTitle ()

	importFormData (&$request)
	This function collects the form data and uses it to populate various member variables. More...

	initialiseForm ()
	Initialise form fields in the object Called on the first invocation, e.g. More...

	internalAttemptSave (&$result, $markAsBot=false)
	Attempt submission (no UI) More...

	isSupportedContentModel ( $modelId)
	Returns if the given content model is editable. More...

	makeTemplatesOnThisPageList (array $templates)
	Wrapper around TemplatesOnThisPageFormatter to make a "templates on this page" list. More...

	noSuchSectionPage ()
	Creates a basic error page which informs the user that they have attempted to edit a nonexistent section. More...

	setApiEditOverride ( $enableOverride)
	Allow editing of content that supports API direct editing, but not general direct editing. More...

	setContextTitle ( $title)
	Set the context Title object. More...

	setEditConflictHelperFactory (callable $factory)
	Set a factory function to create an EditConflictHelper. More...

	setHeaders ()

	setPreloadedContent (Content $content)
	Use this method before edit() to preload some content into the edit box. More...

	showDiff ()
	Get a diff between the current contents of the edit box and the version of the page we're editing from. More...

	showEditForm ( $formCallback=null)
	Send the edit form and related headers to OutputPage. More...

	spamPageWithContent ( $match=false)
	Show "your edit contains spam" page with your diff and text. More...

	tokenOk (&$request)
	Make sure the form isn't faking a user's credentials. More...

Static Public Member Functions
static	extractSectionTitle ( $text)
	Extract the section title from current section text, if any. More...

static	getCopyrightWarning ( $title, $format='plain', $langcode=null)
	Get the copyright warning, by default returns wikitext. More...

static	getEditToolbar ()
	Allow extensions to provide a toolbar. More...

static	getPreviewLimitReport (ParserOutput $output=null)
	Get the Limit report for page previews. More...

static	matchSpamRegex ( $text)
	Check given input text against $wgSpamRegex, and return the text of the first match. More...

static	matchSummarySpamRegex ( $text)
	Check given input text against $wgSummarySpamRegex, and return the text of the first match. More...

Public Attributes
string	$action = 'submit'

bool	$allowBlankSummary = false

string	$autoSumm = ''

null string	$contentFormat = null

string	$contentModel

bool	$deletedSinceEdit

	$didSave = false

bool	$diff = false

string	$editFormPageTop = ''
	Before even the preview. More...

	$editFormTextAfterContent = ''

	$editFormTextAfterTools = ''

	$editFormTextAfterWarn = ''

	$editFormTextBeforeContent = ''

	$editFormTextBottom = ''

	$editFormTextTop = ''

string	$editintro = ''

string	$edittime = ''
	Timestamp of the latest revision of the page when editing was initiated on the client. More...

bool	$firsttime
	True the first time the edit form is rendered, false after re-rendering with diff, save prompts, etc. More...

string	$formtype

bool	$hasPresetSummary = false
	Has a summary been preset using GET parameter &summary= ? More...

bool	$incompleteForm = false

bool	$isConflict = false
	Whether an edit conflict needs to be resolved. More...

bool	$isNew = false
	New page or new section. More...

bool stdClass	$lastDelete

bool	$markAsBot = true

Article	$mArticle

bool	$minoredit = false

bool	$missingComment = false

bool	$missingSummary = false

ParserOutput	$mParserOutput

	$mPreloadContent = null

bool	$mShowSummaryField = true

Title	$mTitle

bool	$mTokenOk = false

bool	$mTokenOkExceptSuffix = false

bool	$mTriedSave = false

bool	$nosummary = false

int	$oldid = 0
	Revision ID the edit is based on, or 0 if it's the current revision. More...

int	$parentRevId = 0
	Revision ID the edit is based on, adjusted when an edit conflict is resolved. More...

bool	$preview = false

	$previewTextAfterContent = ''

bool	$recreate = false

bool	$save = false

int null	$scrolltop = null

string	$section = ''

string	$sectiontitle = ''

string	$starttime = ''
	Timestamp from the first time the edit form was rendered. More...

string	$summary = ''

	$suppressIntro = false

string	$textbox1 = ''
	Page content input field. More...

string	$textbox2 = ''

bool	$tooBig = false

	$undidRev = 0

	$undoAfter = 0

bool	$watchthis = false

const	EDITFORM_ID = 'editform'
	HTML id and name for the beginning of the edit form. More...

const	POST_EDIT_COOKIE_DURATION = 1200
	Duration of PostEdit cookie, in seconds. More...

const	POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision'
	Prefix of key for cookie used to pass post-edit state. More...

const	UNICODE_CHECK = 'ℳ𝒲♥𝓊𝓃𝒾𝒸ℴ𝒹ℯ'
	Used for Unicode support checks. More...

Public Attributes inherited from MediaWiki\EditPage\IEditObject
const	AS_ARTICLE_WAS_DELETED = 222
	Status: article was deleted while editing and wpRecreate == false or form was not posted. More...

const	AS_BLANK_ARTICLE = 224
	Status: user tried to create a blank page and wpIgnoreBlankArticle == false. More...

const	AS_BLOCKED_PAGE_FOR_USER = 215
	Status: User is blocked from editing this page. More...

const	AS_CANNOT_USE_CUSTOM_MODEL = 241
	Status: when changing the content model is disallowed due to $wgContentHandlerUseDB being false. More...

const	AS_CHANGE_TAG_ERROR = 237
	Status: an error relating to change tagging. More...

const	AS_CONFLICT_DETECTED = 225
	Status: (non-resolvable) edit conflict. More...

const	AS_CONTENT_TOO_BIG = 216
	Status: Content too big (> $wgMaxArticleSize) More...

const	AS_END = 231
	Status: WikiPage::doEdit() was unsuccessful. More...

const	AS_HOOK_ERROR = 210
	Status: Article update aborted by a hook function. More...

const	AS_HOOK_ERROR_EXPECTED = 212
	Status: A hook function returned an error. More...

const	AS_IMAGE_REDIRECT_ANON = 233
	Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false) More...

const	AS_IMAGE_REDIRECT_LOGGED = 234
	Status: logged in user is not allowed to upload (User::isAllowed('upload') == false) More...

const	AS_MAX_ARTICLE_SIZE_EXCEEDED = 229
	Status: article is too big (> $wgMaxArticleSize), after merging in the new section. More...

const	AS_NO_CHANGE_CONTENT_MODEL = 235
	Status: user tried to modify the content model, but is not allowed to do that ( User::isAllowed('editcontentmodel') == false ) More...

const	AS_NO_CREATE_PERMISSION = 223
	Status: user tried to create this page, but is not allowed to do that. More...

const	AS_PARSE_ERROR = 240
	Status: can't parse content. More...

const	AS_RATE_LIMITED = 221
	Status: rate limiter for action 'edit' was tripped. More...

const	AS_READ_ONLY_PAGE = 220
	Status: wiki is in readonly mode (wfReadOnly() == true) More...

const	AS_READ_ONLY_PAGE_ANON = 218
	Status: this anonymous user is not allowed to edit this page. More...

const	AS_READ_ONLY_PAGE_LOGGED = 219
	Status: this logged in user is not allowed to edit this page. More...

const	AS_SELF_REDIRECT = 236
	Status: user tried to create self-redirect and wpIgnoreSelfRedirect is false. More...

const	AS_SPAM_ERROR = 232
	Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex. More...

const	AS_SUCCESS_NEW_ARTICLE = 201
	Status: Article successfully created. More...

const	AS_SUCCESS_UPDATE = 200
	Status: Article successfully updated. More...

const	AS_SUMMARY_NEEDED = 226
	Status: no edit summary given and the user has forceeditsummary set and the user is not editing in his own userspace or talkspace and wpIgnoreBlankSummary == false. More...

const	AS_TEXTBOX_EMPTY = 228
	Status: user tried to create a new section without content. More...

const	AS_UNICODE_NOT_SUPPORTED = 242
	Status: edit rejected because browser doesn't support Unicode. More...

Protected Member Functions
	addContentModelChangeLogEntry (User $user, $oldModel, $newModel, $reason)

	addEditNotices ()

	addExplainConflictHeader (OutputPage $out)

	addLongPageWarningHeader ()

	addNewLineAtEnd ( $wikitext)

	addPageProtectionWarningHeaders ()

	addTalkPageText ()

	buildTextboxAttribs ( $name, array $customAttribs, User $user)

	displayPermissionsError (array $permErrors)
	Display a permissions error page, like OutputPage::showPermissionsErrorPage(), but with the following differences: More...

	displayPreviewArea ( $previewOutput, $isOnTop=false)

	displayViewSourcePage (Content $content, $errorMessage='')
	Display a read-only View Source page. More...

	doPreviewParse (Content $content)
	Parse the page for a preview. More...

	getActionURL (Title $title)
	Returns the URL to use in the form's action attribute. More...

	getContentObject ( $def_content=null)

	getCopywarn ()
	Get the copyright warning. More...

	getCurrentContent ()
	Get the current content of the page. More...

	getEditPermissionErrors ( $rigor=PermissionManager::RIGOR_SECURE)

	getLastDelete ()
	Get the last log record of this page being deleted, if ever. More...

	getPreloadedContent ( $preload, $params=[])
	Get the contents to be preloaded into the box, either set by an earlier setPreloadText() or by loading the given page. More...

	getPreviewParserOptions ()
	Get parser options for a preview. More...

	getSubmitButtonLabel ()
	Get the message key of the label for the button to save the page. More...

	getSummaryPreview ( $isSubjectPreview, $summary="")

	importContentFormData (&$request)
	Subpage overridable method for extracting the page content data from the posted form to be placed in $this->textbox1, if using customized input this method should be overridden and return the page text that will be used for saving, preview parsing and so on... More...

	incrementConflictStats ()

	isSectionEditSupported ()
	Section editing is supported when the page content model allows section edit and we are editing current revision. More...

	isWrongCaseUserConfigPage ()
	Checks whether the user entered a skin name in uppercase, e.g. More...

	previewOnOpen ()
	Should we show a preview when the edit form is first shown? More...

	runPostMergeFilters (Content $content, Status $status, User $user)
	Run hooks that can filter edits just before they get saved. More...

	setPostEditCookie ( $statusValue)
	Sets post-edit cookie indicating the user just saved a particular revision. More...

	showConflict ()
	Show an edit conflict. More...

	showContentForm ()
	Subpage overridable method for printing the form for page content editing By default this simply outputs wpTextbox1 Subclasses can override this to provide a custom UI for editing; be it a form, or simply wpTextbox1 with a modified content that will be reverse modified when extracted from the post data. More...

	showCustomIntro ()
	Attempt to show a custom editing introduction, if supplied. More...

	showEditTools ()
	Inserts optional text shown below edit and upload forms. More...

	showFormAfterText ()

	showFormBeforeText ()

	showHeader ()

	showHeaderCopyrightWarning ()
	Show the header copyright warning. More...

	showIntro ()
	Show all applicable editing introductions. More...

	showPreview ( $text)
	Append preview output to OutputPage. More...

	showStandardInputs (&$tabindex=2)

	showSummaryInput ( $isSubjectPreview, $summary="")

	showTextbox ( $text, $name, $customAttribs=[])

	showTextbox1 ( $customAttribs=null, $textoverride=null)
	Method to output wpTextbox1 The $textoverride method can be used by subclasses overriding showContentForm to pass back to this method. More...

	showTextbox2 ()

	showTosSummary ()
	Give a chance for site and per-namespace customizations of terms of service summary link that might exist separately from the copyright notice. More...

	toEditContent ( $text)
	Turns the given text into a Content object by unserializing it. More...

	toEditText ( $content)
	Gets an editable textual representation of $content. More...

	updateWatchlist ()
	Register the change of watch status. More...

	wasDeletedSinceLastEdit ()
	Check if a page was deleted while the user was editing it, before submit. More...

Protected Attributes
bool	$allowBlankArticle = false

bool	$allowSelfRedirect = false

bool	$blankArticle = false

bool int	$contentLength = false

IContextSource	$context

bool	$edit

Revision bool null	$mBaseRevision = false
	A revision object corresponding to $this->editRevId. More...

bool	$selfRedirect = false

Private Member Functions
	formatStatusErrors (Status $status)
	Wrap status errors in an errorbox for increased visibility. More...

	getCheckboxesDefinitionForWatchlist ( $watch)
	Get the watchthis and watchlistExpiry form field definitions. More...

	getEditConflictHelper ()

	getOriginalContent (User $user)
	Get the content of the wanted revision, without section extraction. More...

	getSummaryInputAttributes (array $inputAttrs=null)
	Helper function for summary input functions, which returns the necessary attributes for the input. More...

	getUndoContent (RevisionRecord $undoRev, RevisionRecord $oldRev)
	Returns the result of a three-way merge when undoing changes. More...

	guessSectionName ( $text)
	Turns section name wikitext into anchors for use in HTTP redirects. More...

	handleStatus (Status $status, $resultDetails)
	Handle status, such as after attempt save. More...

	incrementEditFailureStats ( $failureType)

	incrementResolvedConflicts ()
	Log when a page was successfully saved after the edit conflict view. More...

	isPageExistingAndViewable ( $title, User $user)
	Verify if a given title exists and the given user is allowed to view it. More...

	isUndoClean (Content $content)
	Does sanity checks and compares the automatically generated undo content with the one that was submitted by the user. More...

	mergeChangesIntoContent (&$editContent)
	Attempts to do 3-way merge of edit content with a base revision and current content, in case of edit conflict, in whichever way appropriate for the content type. More...

	newSectionSummary (&$sectionanchor=null)
	Return the summary to be used for a new section. More...

	newTextConflictHelper ( $submitButtonLabel)

Private Attributes
null array	$changeTags = null

IContentHandlerFactory	$contentHandlerFactory

TextConflictHelper null	$editConflictHelper

callable	$editConflictHelperFactory
	Factory function to create an edit conflict helper. More...

int	$editRevId = null
	Revision ID of the latest revision of the page when editing was initiated on the client. More...

bool	$enableApiEditOverride = false
	Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing. More...

string	$hookError = ''

bool	$isOldRev = false
	Whether an old revision is edited. More...

null Title	$mContextTitle = null

RevisionRecord bool null	$mExpectedParentRevision = false
	A RevisionRecord corresponding to $this->editRevId or $this->edittime Replaced $mBaseRevision. More...

WikiPage	$page

PermissionManager	$permManager

RevisionStore	$revisionStore

string null	$unicodeCheck
	What the user submitted in the 'wpUnicodeCheck' field. More...

WatchedItemStoreInterface	$watchedItemStore

string null	$watchlistExpiry
	The expiry time of the watch item, or null if it is not watched temporarily. More...

bool	$watchlistExpiryEnabled = false
	Corresponds to $wgWatchlistExpiry. More...

Detailed Description

The edit page/HTML interface (split from Article) The actual database and text munging is still in Article, but it should get easier to call those from alternate interfaces.

EditPage cares about two distinct titles: $this->mContextTitle is the page that forms submit to, links point to, redirects go to, etc. $this->mTitle (as well as $mArticle) is the page in the database that is actually being edited. These are usually the same, but they are now allowed to be different.

Surgeon General's Warning: prolonged exposure to this class is known to cause headaches, which may be fatal.

@newable

Note: marked as newable in 1.35 for lack of a better alternative, but should be split up into service objects and command objects in the future (T157658).

Definition at line 62 of file EditPage.php.

Constructor & Destructor Documentation

◆ __construct()

EditPage::__construct ( Article $article )

Stable to call.

Parameters

Article $article

Definition at line 457 of file EditPage.php.

References deprecatePublicProperty(), getContext(), Article\getContext(), Article\getPage(), and Article\getTitle().

Member Function Documentation

◆ addContentModelChangeLogEntry()

EditPage::addContentModelChangeLogEntry	(	User	$user,
			$oldModel,
			$newModel,
			$reason
	)

protected

Parameters

User	$user
string \| false	$oldModel	false if the page is being newly created
string	$newModel
string	$reason

Definition at line 2579 of file EditPage.php.

Referenced by internalAttemptSave().

◆ addEditNotices()

EditPage::addEditNotices ( )

protected

Since: 1.29

Definition at line 4691 of file EditPage.php.

Referenced by showEditForm().

◆ addExplainConflictHeader()

EditPage::addExplainConflictHeader ( OutputPage $out )

protected

Parameters

OutputPage $out

Since: 1.29

Definition at line 4795 of file EditPage.php.

References OutputPage\addHTML(), and getEditConflictHelper().

Referenced by showHeader().

◆ addLongPageWarningHeader()

EditPage::addLongPageWarningHeader ( )

protected

Since: 1.29

Definition at line 4720 of file EditPage.php.

References $lang.

Referenced by showHeader().

◆ addNewLineAtEnd()

EditPage::addNewLineAtEnd ( $wikitext )

protected

Parameters

string $wikitext

Returns: string

Since: 1.29

Definition at line 4819 of file EditPage.php.

◆ addPageProtectionWarningHeaders()

EditPage::addPageProtectionWarningHeaders ( )

protected

Since: 1.29

Definition at line 4750 of file EditPage.php.

References $page, and LogEventsList\showLogExtract().

Referenced by showHeader().

◆ addTalkPageText()

EditPage::addTalkPageText ( )

protected

Since: 1.29

Definition at line 4711 of file EditPage.php.

Referenced by showEditForm().

◆ attemptSave()

EditPage::attemptSave ( & $resultDetails = false )

Attempt submission.

Parameters

array | bool &$resultDetails See docs for $result in internalAttemptSave

Exceptions

UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError

Returns: Status The resulting status object.

Definition at line 1735 of file EditPage.php.

References $markAsBot, and internalAttemptSave().

Referenced by edit().

◆ buildTextboxAttribs()

EditPage::buildTextboxAttribs	(		$name,
		array	$customAttribs,
		User	$user
	)

protected

Parameters

string	$name
mixed[]	$customAttribs
User	$user

Returns: mixed[]

Since: 1.29

Definition at line 4808 of file EditPage.php.

◆ displayPermissionsError()

EditPage::displayPermissionsError ( array $permErrors )

protected

Display a permissions error page, like OutputPage::showPermissionsErrorPage(), but with the following differences:

If redlink=1, the user will be redirected to the page
If there is content to display or the error occurs while either saving, previewing or showing the difference, it will be a "View source for ..." page displaying the source code after the error message.

Since: 1.19

Parameters

array $permErrors Array of permissions errors

Exceptions

PermissionsError

Definition at line 759 of file EditPage.php.

References $action, $content, displayViewSourcePage(), and getContentObject().

Referenced by edit().

◆ displayPreviewArea()

EditPage::displayPreviewArea	(	$previewOutput,
		$isOnTop = `false`
	)

protected

Definition at line 3713 of file EditPage.php.

References Xml\openElement(), Html\rawElement(), showDiff(), and showPreview().

Referenced by showEditForm().

◆ displayViewSourcePage()

EditPage::displayViewSourcePage	(	Content	$content,
			$errorMessage = `''`
	)

protected

Display a read-only View Source page.

Parameters

Content	$content
string	$errorMessage	additional wikitext error message to display

Definition at line 789 of file EditPage.php.

References $content, $textbox1, getContextTitle(), getTemplates(), makeTemplatesOnThisPageList(), showTextbox(), and toEditText().

Referenced by displayPermissionsError(), and edit().

◆ doPreviewParse()

EditPage::doPreviewParse ( Content $content )

protected

Parse the page for a preview.

Subclasses may override this class, in order to parse with different options, or to otherwise modify the preview HTML.

Parameters

Content $content The page content

Returns

array with keys:

parserOutput: The ParserOutput object
html: The HTML to be displayed

Definition at line 4333 of file EditPage.php.

References $content, and getPreviewParserOptions().

Referenced by getPreviewText().

◆ edit()

EditPage::edit ( )

This is the function that gets called for "action=edit".

It sets up various member variables, then passes execution to another function, usually showEditForm()

The edit form is self-submitting, so that when things like preview and edit conflicts occur, we get the same form back with the extra stuff added. Only when the final submission is made and all is well do we actually save and redirect to the newly-edited page.

Definition at line 567 of file EditPage.php.

References DeferredUpdates\addCallableUpdate(), attemptSave(), displayPermissionsError(), displayViewSourcePage(), getContentObject(), getEditPermissionErrors(), handleStatus(), importFormData(), initialiseForm(), previewOnOpen(), showEditForm(), showIntro(), wfDebug(), and wfReadOnly().

Referenced by importFormData().

◆ extractSectionTitle()

static EditPage::extractSectionTitle ( $text )

static

Extract the section title from current section text, if any.

Parameters

string $text

Returns: string|bool String or false

Definition at line 3320 of file EditPage.php.

References $matches.

Referenced by showHeader().

◆ formatStatusErrors()

EditPage::formatStatusErrors ( Status $status )

private

Wrap status errors in an errorbox for increased visibility.

Parameters

Status $status

Returns: string Wikitext

Definition at line 1962 of file EditPage.php.

References Status\getWikiText().

Referenced by runPostMergeFilters().

◆ getActionURL()

EditPage::getActionURL ( Title $title )

protected

Returns the URL to use in the form's action attribute.

This is used by EditPage subclasses when simply customizing the action variable in the constructor is not enough. This can be used when the EditPage lives inside of a Special page rather than a custom page action.

Parameters

Title $title Title object for which is being edited (where we go to for &action= links)

Returns: string

Definition at line 4063 of file EditPage.php.

References $title.

Referenced by showEditForm().

◆ getArticle()

EditPage::getArticle ( )

Returns: Article

Definition at line 491 of file EditPage.php.

References $mArticle.

◆ getBaseRevision()

EditPage::getBaseRevision ( )

Returns the revision that was current at the time editing was initiated on the client, even if the edit was based on an old revision.

Deprecated:: since 1.35, use ::getExpectedParentRevision

Warning: this method is very poorly named. If the user opened the form with ?oldid=X, one might think of X as the "base revision", which is NOT what this returns, see oldid for that. One might further assume that this corresponds to the $baseRevId parameter of WikiPage::doEditContent, which is not the case either. getExpectedParentRevision() would perhaps be a better name.

Returns: Revision|null Current version when editing was initiated on the client

Definition at line 2684 of file EditPage.php.

References $mBaseRevision, getExpectedParentRevision(), and wfDeprecated().

◆ getCancelLink()

EditPage::getCancelLink ( $tabindex = 0 )

Parameters

int $tabindex Current tabindex

Returns: string

Definition at line 4035 of file EditPage.php.

References $oldid, and getContextTitle().

Referenced by showStandardInputs().

◆ getCheckboxesDefinition()

EditPage::getCheckboxesDefinition ( $checked )

Return an array of checkbox definitions.

Array keys correspond to the <input> 'name' attribute to use for each checkbox.

Array values are associative arrays with the following keys:

'label-message' (required): message for label text
'id' (required): 'id' attribute for the <input>
'default' (required): default checkedness (true or false)
'title-message' (optional): used to generate 'title' attribute for the <label>
'tooltip' (optional): used to generate 'title' and 'accesskey' attributes from messages like 'tooltip-foo', 'accesskey-foo'
'label-id' (optional): 'id' attribute for the <label>
'legacy-name' (optional): short name for backwards-compatibility
'class' (optional): PHP class name of the OOUI widget to use. Defaults to CheckboxInputWidget.
'options' (optional): options to use for DropdownInputWidget, ComboBoxInputWidget, etc. following the structure as given in the documentation for those classes.
'value-attr' (optional): name of the widget config option for the "current value" of the widget. Defaults to 'selected'; for some widget types it should be 'value'.
Parameters

array $checked Array of checkbox name (matching the 'legacy-name') => bool, where bool indicates the checked status of the checkbox

Returns
array[]

Definition at line 4415 of file EditPage.php.

References getCheckboxesDefinitionForWatchlist().

Referenced by getCheckboxesWidget().

◆ getCheckboxesDefinitionForWatchlist()

EditPage::getCheckboxesDefinitionForWatchlist ( $watch )

private

Get the watchthis and watchlistExpiry form field definitions.

Since: 1.35

Parameters

bool $watch

Returns: mixed[]

Definition at line 4451 of file EditPage.php.

References getContext(), WatchAction\getExpiryOptions(), getTitle(), and getUser().

Referenced by getCheckboxesDefinition().

◆ getCheckboxesWidget()

EditPage::getCheckboxesWidget	(	&	$tabindex,
			$checked
	)

Returns an array of checkboxes for the edit form, including 'minor' and 'watch' checkboxes and any other added by extensions.

Parameters

int	&$tabindex	Current tabindex
array	$checked	Array of checkbox => bool, where bool indicates the checked status of the checkbox

Returns: \OOUI\Element[] Associative array of string keys to \OOUI\Widget or \OOUI\Layout instances

Definition at line 4505 of file EditPage.php.

References $title, getCheckboxesDefinition(), and Linker\titleAttrib().

Referenced by showStandardInputs().

◆ getContentObject()

EditPage::getContentObject ( $def_content = null )

protected

Parameters

Content | null $def_content The default value to return

Returns: Content|false|null Content on success, $def_content for invalid sections

Since: 1.21

Definition at line 1240 of file EditPage.php.

References $content, $summary, $wgDisableAnonTalk, getOriginalContent(), getPreloadedContent(), getUndoContent(), ExternalUserNames\getUserLinkTitle(), WikiPage\hasDifferencesOutsideMainSlot(), ExternalUserNames\isExternal(), isSupportedContentModel(), ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, Html\rawElement(), and toEditContent().

Referenced by displayPermissionsError(), edit(), and initialiseForm().

◆ getContext()

EditPage::getContext ( )

Since: 1.28

Returns: IContextSource

Definition at line 499 of file EditPage.php.

References $context.

Referenced by __construct(), getCheckboxesDefinitionForWatchlist(), importFormData(), initialiseForm(), newTextConflictHelper(), and updateWatchlist().

◆ getContextTitle()

EditPage::getContextTitle ( )

Get the context title object.

Exceptions

RuntimeException if no context title was set

Returns: Title

Definition at line 526 of file EditPage.php.

References $mContextTitle.

Referenced by displayViewSourcePage(), getCancelLink(), setHeaders(), showEditForm(), and spamPageWithContent().

◆ getCopyrightWarning()

static EditPage::getCopyrightWarning	(	$title,
		$format = `'plain'`,
		$langcode = `null`
	)

static

Get the copyright warning, by default returns wikitext.

Parameters

Title	$title
string	$format	Output format, valid values are any function of a Message object
Language \| string \| null	$langcode	Language code or Language object.

Returns: string

Definition at line 3896 of file EditPage.php.

References $title, $wgRightsText, Hooks\runner(), and wfMessage().

Referenced by getCopywarn().

◆ getCopywarn()

EditPage::getCopywarn ( )

protected

Get the copyright warning.

Renamed to getCopyrightWarning(), old name kept around for backwards compatibility

Returns: string

Definition at line 3884 of file EditPage.php.

References getCopyrightWarning().

Referenced by showStandardInputs().

◆ getCurrentContent()

EditPage::getCurrentContent ( )

protected

Get the current content of the page.

This is basically similar to WikiPage::getContent( RevisionRecord::RAW ) except that when the page doesn't exist an empty content object is returned instead of null.

Since: 1.21

Returns: Content

Definition at line 1542 of file EditPage.php.

References $content, and getTitle().

Referenced by getOriginalContent(), internalAttemptSave(), showDiff(), and showEditForm().

◆ getEditButtons()

EditPage::getEditButtons ( & $tabindex )

Returns an array of html code of the following buttons: save, diff and preview.

Parameters

int &$tabindex Current tabindex

Returns: array

Definition at line 4579 of file EditPage.php.

References Linker\accesskey(), getSubmitButtonLabel(), and Linker\titleAttrib().

Referenced by showStandardInputs().

◆ getEditConflictHelper()

EditPage::getEditConflictHelper ( )

private

Returns: TextConflictHelper

Definition at line 4862 of file EditPage.php.

References $editConflictHelper, and getSubmitButtonLabel().

Referenced by addExplainConflictHeader(), incrementConflictStats(), incrementResolvedConflicts(), showConflict(), and showEditForm().

◆ getEditPermissionErrors()

EditPage::getEditPermissionErrors ( $rigor = PermissionManager::RIGOR_SECURE )

protected

Parameters

string $rigor PermissionManager::RIGOR_ constant

Returns: array

Definition at line 706 of file EditPage.php.

References wfArrayDiff2().

Referenced by edit().

◆ getEditToolbar()

static EditPage::getEditToolbar ( )

static

Allow extensions to provide a toolbar.

Returns: string|null

Definition at line 4379 of file EditPage.php.

References Hooks\runner().

◆ getExpectedParentRevision()

EditPage::getExpectedParentRevision ( )

Returns the RevisionRecord corresponding to the revision that was current at the time editing was initiated on the client even if the edit was based on an old revision.

Since: 1.35

Returns: RevisionRecord|null Current revision when editing was initiated on the client

Definition at line 2700 of file EditPage.php.

References $mExpectedParentRevision, and getTitle().

Referenced by getBaseRevision(), and mergeChangesIntoContent().

◆ getLastDelete()

EditPage::getLastDelete ( )

protected

Get the last log record of this page being deleted, if ever.

This is used to detect whether a delete occurred during editing.

Returns: bool|stdClass

Definition at line 4099 of file EditPage.php.

References $dbr, DB_REPLICA, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, CommentStore\getStore(), ActorMigration\newMigration(), and wfGetDB().

Referenced by wasDeletedSinceLastEdit().

◆ getOriginalContent()

EditPage::getOriginalContent ( User $user )

private

Get the content of the wanted revision, without section extraction.

The result of this function can be used to compare user's input with section replaced in its context (using WikiPage::replaceSectionAtRev()) to the original text of the edit.

This differs from Article::getContent() that when a missing revision is encountered the result will be null and not the 'missing-revision' message.

Since: 1.19

Parameters

User $user The user to get the revision for

Returns: Content|null

Definition at line 1501 of file EditPage.php.

References getCurrentContent().

Referenced by getContentObject().

◆ getParentRevId()

EditPage::getParentRevId ( )

Get the edit's parent revision ID.

The "parent" revision is the ancestor that should be recorded in this page's revision history. It is either the revision ID of the in-memory article content, or in the case of a 3-way merge in order to rebase across a recoverable edit conflict, the ID of the newer revision to which we have rebased this page.

Since: 1.27

Returns: int Revision ID

Definition at line 1526 of file EditPage.php.

References $parentRevId.

Referenced by showEditForm().

◆ getPreloadedContent()

EditPage::getPreloadedContent	(	$preload,
		$params = `[]`
	)

protected

Get the contents to be preloaded into the box, either set by an earlier setPreloadText() or by loading the given page.

Parameters

string	$preload	Representing the title to preload from.
array	$params	Parameters to use (interface-message style) in the preloaded text

Returns: Content

Since: 1.21

Definition at line 1615 of file EditPage.php.

References $content, $mPreloadContent, $page, $title, WikiPage\factory(), WikiPage\getContent(), WikiPage\getRedirectTarget(), isPageExistingAndViewable(), WikiPage\isRedirect(), Title\newFromText(), ParserOptions\newFromUser(), and wfDebug().

Referenced by getContentObject().

◆ getPreviewLimitReport()

static EditPage::getPreviewLimitReport ( ParserOutput $output = null )

static

Get the Limit report for page previews.

Since: 1.22

Parameters

ParserOutput | null $output ParserOutput object from the parse

Returns: string HTML

Definition at line 3924 of file EditPage.php.

References Html\closeElement(), Html\openElement(), Html\rawElement(), Hooks\runner(), and wfMessage().

Referenced by ApiParse\execute().

◆ getPreviewParserOptions()

EditPage::getPreviewParserOptions ( )

protected

Get parser options for a preview.

Returns: ParserOptions

Definition at line 4310 of file EditPage.php.

Referenced by doPreviewParse().

◆ getPreviewText()

EditPage::getPreviewText ( )

Get the rendered text for previewing.

Exceptions

MWException

Returns: string

Definition at line 4147 of file EditPage.php.

References $content, $previewTextAfterContent, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, CONTENT_MODEL_JSON, doPreviewParse(), getTitle(), incrementEditFailureStats(), Html\rawElement(), and toEditContent().

Referenced by showEditForm().

◆ getSubmitButtonLabel()

EditPage::getSubmitButtonLabel ( )

protected

Get the message key of the label for the button to save the page.

Since: 1.30

Returns: string

Definition at line 4555 of file EditPage.php.

Referenced by getEditButtons(), getEditConflictHelper(), and showHeader().

◆ getSummaryInputAttributes()

EditPage::getSummaryInputAttributes ( array $inputAttrs = null )

private

Helper function for summary input functions, which returns the necessary attributes for the input.

Parameters

array | null $inputAttrs Array of attrs to use on the input

Returns: array

Definition at line 3512 of file EditPage.php.

References CommentStore\COMMENT_CHARACTER_LIMIT.

Referenced by getSummaryInputWidget().

◆ getSummaryInputWidget()

EditPage::getSummaryInputWidget	(	$summary = `""`,
		$labelText = `null`,
		$inputAttrs = `null`
	)

Builds a standard summary input with a label.

Parameters

string	$summary	The value of the summary input
string \| null	$labelText	The html to place inside the label
array \| null	$inputAttrs	Array of attrs to use on the input

Returns: OOUI\FieldLayout OOUI FieldLayout with Label and Input

Definition at line 3535 of file EditPage.php.

References $summary, Linker\accesskey(), getSummaryInputAttributes(), and Linker\titleAttrib().

Referenced by showSummaryInput().

◆ getSummaryPreview()

EditPage::getSummaryPreview	(	$isSubjectPreview,
		$summary = `""`
	)

protected

Parameters

bool	$isSubjectPreview	True if this is the section subject/title up top, or false if this is the comment summary down below the textarea
string	$summary	The text of the summary to display

Returns: string

Definition at line 3594 of file EditPage.php.

References $summary, Linker\commentBlock(), and Xml\tags().

Referenced by showEditForm(), and showStandardInputs().

◆ getTemplates()

EditPage::getTemplates ( )

Returns: array

Definition at line 4357 of file EditPage.php.

References Title\makeTitle().

Referenced by displayViewSourcePage(), and showEditForm().

◆ getTitle()

EditPage::getTitle ( )

Since: 1.19

Returns: Title

Definition at line 507 of file EditPage.php.

References $mTitle.

Referenced by getCheckboxesDefinitionForWatchlist(), getCurrentContent(), getExpectedParentRevision(), getPreviewText(), initialiseForm(), newTextConflictHelper(), showHeader(), showTextbox1(), and toEditContent().

◆ getUndoContent()

EditPage::getUndoContent	(	RevisionRecord	$undoRev,
		RevisionRecord	$oldRev
	)

private

Returns the result of a three-way merge when undoing changes.

Parameters

RevisionRecord	$undoRev	Newest revision being undone. Corresponds to `undo` URL parameter.
RevisionRecord	$oldRev	Revision that is being restored. Corresponds to `undoafter` URL parameter.

Returns: Content|false

Definition at line 1466 of file EditPage.php.

References Revision\RevisionRecord\getContent(), Revision\RevisionRecord\getId(), and Revision\RevisionRecord\getSlot().

Referenced by getContentObject(), and isUndoClean().

◆ guessSectionName()

EditPage::guessSectionName ( $text )

private

Turns section name wikitext into anchors for use in HTTP redirects.

Various versions of Microsoft browsers misinterpret fragment encoding of Location: headers resulting in mojibake in address bar. Redirect them to legacy section IDs, if possible. All the other browsers get HTML5 if the wiki is configured for it, to spread the new style links more efficiently.

Parameters

string $text

Returns: string

Definition at line 4833 of file EditPage.php.

Referenced by internalAttemptSave(), and newSectionSummary().

◆ handleStatus()

EditPage::handleStatus	(	Status	$status,
			$resultDetails
	)

private

Handle status, such as after attempt save.

Parameters

Status	$status
array \| bool	$resultDetails

Exceptions

ErrorPageError

Returns: bool False, if output is done, true if rest of the form should be displayed

Definition at line 1771 of file EditPage.php.

Referenced by edit().

◆ importContentFormData()

EditPage::importContentFormData ( & $request )

protected

Subpage overridable method for extracting the page content data from the posted form to be placed in $this->textbox1, if using customized input this method should be overridden and return the page text that will be used for saving, preview parsing and so on...

Parameters

WebRequest &$request

Returns: string|null

Definition at line 1161 of file EditPage.php.

Referenced by importFormData().

◆ importFormData()

EditPage::importFormData ( & $request )

This function collects the form data and uses it to populate various member variables.

Parameters

WebRequest &$request

Exceptions

ErrorPageError

Definition at line 923 of file EditPage.php.

References $changeTags, $diff, $preview, $textbox1, $undidRev, $undoAfter, edit(), getContext(), ContentHandler\getLocalizedName(), importContentFormData(), isSectionEditSupported(), NS_USER, NS_USER_TALK, tokenOk(), wfDebug(), wfEscapeWikiText(), and wfTimestampNow().

Referenced by edit().

◆ incrementConflictStats()

EditPage::incrementConflictStats ( )

protected

Definition at line 4027 of file EditPage.php.

References getEditConflictHelper().

Referenced by showConflict().

◆ incrementEditFailureStats()

EditPage::incrementEditFailureStats ( $failureType )

private

Definition at line 4301 of file EditPage.php.

Referenced by getPreviewText().

◆ incrementResolvedConflicts()

EditPage::incrementResolvedConflicts ( )

private

Log when a page was successfully saved after the edit conflict view.

Definition at line 1754 of file EditPage.php.

References getEditConflictHelper().

Referenced by handleStatus().

◆ initialiseForm()

EditPage::initialiseForm ( )

Initialise form fields in the object Called on the first invocation, e.g.

when a user clicks an edit link

Returns: bool If the requested section is valid

Definition at line 1170 of file EditPage.php.

References $content, getContentObject(), getContext(), getTitle(), isSupportedContentModel(), noSuchSectionPage(), Message\plaintextParam(), Html\rawElement(), and toEditText().

Referenced by edit().

◆ internalAttemptSave()

EditPage::internalAttemptSave	(	&	$result,
			$markAsBot = `false`
	)

Attempt submission (no UI)

Parameters

array	&$result	Array to add statuses to, currently with the possible keys: spam (string): Spam string from content if any spam is detected by matchSpamRegex. sectionanchor (string): Section anchor for a section save. nullEdit (bool): Set if doEditContent is OK. True if null edit, false otherwise. redirect (bool): Set if doEditContent is OK. True if resulting revision is a redirect.
bool	$markAsBot	True if edit is being made under the bot right and the bot wishes the edit to be marked as such.

Returns: Status Status object, possibly with a message, but always with one of the AS_* constants in $status->value,

Todo:: FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g. AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.

Definition at line 2031 of file EditPage.php.

Referenced by attemptSave().

◆ isPageExistingAndViewable()

EditPage::isPageExistingAndViewable	(		$title,
		User	$user
	)

private

Verify if a given title exists and the given user is allowed to view it.

See also: EditPage::getPreloadedContent()

Parameters

Title \| null	$title
User	$user

Returns: bool

Exceptions

Exception

Definition at line 1681 of file EditPage.php.

References $title.

Referenced by getPreloadedContent(), and showCustomIntro().

◆ isSectionEditSupported()

EditPage::isSectionEditSupported ( )

protected

Section editing is supported when the page content model allows section edit and we are editing current revision.

Returns: bool True if this edit page supports sections, false otherwise.

Definition at line 904 of file EditPage.php.

Referenced by importFormData(), and showEditForm().

◆ isSupportedContentModel()

EditPage::isSupportedContentModel ( $modelId )

Returns if the given content model is editable.

Parameters

string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.

Returns: bool

Exceptions

MWException If $modelId has no known handler

Definition at line 541 of file EditPage.php.

Referenced by getContentObject(), initialiseForm(), toEditContent(), and toEditText().

◆ isUndoClean()

EditPage::isUndoClean ( Content $content )

private

Does sanity checks and compares the automatically generated undo content with the one that was submitted by the user.

If they match, the undo is considered "clean". Otherwise there is no guarantee if anything was reverted at all, as the user could even swap out entire content.

Parameters

Content $content

Returns: bool

Definition at line 2534 of file EditPage.php.

References $content, getUndoContent(), and ParserOptions\newFromUserAndLang().

Referenced by internalAttemptSave().

◆ isWrongCaseUserConfigPage()

EditPage::isWrongCaseUserConfigPage ( )

protected

Checks whether the user entered a skin name in uppercase, e.g.

"User:Example/Monobook.css" instead of "monobook.css"

Returns: bool

Definition at line 883 of file EditPage.php.

Referenced by showHeader().

◆ makeTemplatesOnThisPageList()

EditPage::makeTemplatesOnThisPageList ( array $templates )

Wrapper around TemplatesOnThisPageFormatter to make a "templates on this page" list.

Parameters

Title[] $templates

Returns: string HTML

Definition at line 3296 of file EditPage.php.

References $type, and Html\rawElement().

Referenced by displayViewSourcePage(), and showEditForm().

◆ matchSpamRegex()

static EditPage::matchSpamRegex ( $text )

static

Check given input text against $wgSpamRegex, and return the text of the first match.

Deprecated:: since 1.35, use the new SpamChecker service

Parameters

string $text

Returns: string|bool Matching string or false

Definition at line 2729 of file EditPage.php.

References wfDeprecated().

◆ matchSummarySpamRegex()

static EditPage::matchSummarySpamRegex ( $text )

static

Check given input text against $wgSummarySpamRegex, and return the text of the first match.

Deprecated:: since 1.35, use the new SpamChecker service

Parameters

string $text

Returns: string|bool Matching string or false

Definition at line 2743 of file EditPage.php.

References wfDeprecated().

◆ mergeChangesIntoContent()

EditPage::mergeChangesIntoContent ( & $editContent )

private

Attempts to do 3-way merge of edit content with a base revision and current content, in case of edit conflict, in whichever way appropriate for the content type.

Since: 1.21

Parameters

Content &$editContent

Returns: bool

Definition at line 2630 of file EditPage.php.

References getExpectedParentRevision().

Referenced by internalAttemptSave().

◆ newSectionSummary()

EditPage::newSectionSummary ( & $sectionanchor = null )

private

Return the summary to be used for a new section.

Parameters

string | null &$sectionanchor Set to the section anchor text

Returns: string

Definition at line 1982 of file EditPage.php.

References $summary, and guessSectionName().

Referenced by internalAttemptSave().

◆ newTextConflictHelper()

EditPage::newTextConflictHelper ( $submitButtonLabel )

private

Parameters

string $submitButtonLabel

Returns: TextConflictHelper

Exceptions

MWUnknownContentModelException

Definition at line 4878 of file EditPage.php.

References getContext(), and getTitle().

◆ noSuchSectionPage()

EditPage::noSuchSectionPage ( )

Creates a basic error page which informs the user that they have attempted to edit a nonexistent section.

Definition at line 4646 of file EditPage.php.

References $res.

Referenced by initialiseForm().

◆ previewOnOpen()

EditPage::previewOnOpen ( )

protected

Should we show a preview when the edit form is first shown?

Returns: bool

Definition at line 842 of file EditPage.php.

Referenced by edit().

◆ runPostMergeFilters()

EditPage::runPostMergeFilters	(	Content	$content,
		Status	$status,
		User	$user
	)

protected

Run hooks that can filter edits just before they get saved.

Parameters

Content	$content	The Content to filter.
Status	$status	For reporting the outcome to the caller
User	$user	The user performing the edit

Returns: bool

Definition at line 1913 of file EditPage.php.

References $content, MediaWiki\EditPage\IEditObject\AS_HOOK_ERROR, MediaWiki\EditPage\IEditObject\AS_HOOK_ERROR_EXPECTED, StatusValue\fatal(), formatStatusErrors(), StatusValue\getErrors(), StatusValue\isGood(), and StatusValue\isOK().

Referenced by internalAttemptSave().

◆ setApiEditOverride()

EditPage::setApiEditOverride ( $enableOverride )

Allow editing of content that supports API direct editing, but not general direct editing.

Set to false by default.

Parameters

bool $enableOverride

Definition at line 552 of file EditPage.php.

◆ setContextTitle()

EditPage::setContextTitle ( $title )

Set the context Title object.

Parameters

Title | null $title Title object or null

Definition at line 516 of file EditPage.php.

References $title.

◆ setEditConflictHelperFactory()

EditPage::setEditConflictHelperFactory ( callable $factory )

Set a factory function to create an EditConflictHelper.

Parameters

callable $factory Factory function

Since: 1.31

Definition at line 4854 of file EditPage.php.

◆ setHeaders()

EditPage::setHeaders ( )

Definition at line 2748 of file EditPage.php.

References getContextTitle(), and NS_MEDIAWIKI.

Referenced by showEditForm().

◆ setPostEditCookie()

EditPage::setPostEditCookie ( $statusValue )

protected

Sets post-edit cookie indicating the user just saved a particular revision.

This uses a temporary cookie for each revision ID so separate saves will never interfere with each other.

Article::view deletes the cookie on server-side after the redirect and converts the value to the global JavaScript variable wgPostEdit.

If the variable were set on the server, it would be cached, which is unwanted since the post-edit state should only apply to the load right after the save.

Parameters

int $statusValue The status value (to check for new article status)

Definition at line 1714 of file EditPage.php.

Referenced by handleStatus().

◆ setPreloadedContent()

EditPage::setPreloadedContent ( Content $content )

Use this method before edit() to preload some content into the edit box.

Parameters

Content $content

Since: 1.21

Definition at line 1600 of file EditPage.php.

References $content.

◆ showConflict()

EditPage::showConflict ( )

protected

Show an edit conflict.

textbox1 is already shown in showEditForm(). If you want to use another entry point to this function, be careful.

Definition at line 4016 of file EditPage.php.

References getEditConflictHelper(), and incrementConflictStats().

Referenced by showEditForm().

◆ showContentForm()

EditPage::showContentForm ( )

protected

Subpage overridable method for printing the form for page content editing By default this simply outputs wpTextbox1 Subclasses can override this to provide a custom UI for editing; be it a form, or simply wpTextbox1 with a modified content that will be reverse modified when extracted from the post data.

Note that this is basically the inverse for importContentFormData

Definition at line 3652 of file EditPage.php.

References showTextbox1().

Referenced by showEditForm().

◆ showCustomIntro()

EditPage::showCustomIntro ( )

protected

Attempt to show a custom editing introduction, if supplied.

Returns: bool

Definition at line 2941 of file EditPage.php.

References $title, isPageExistingAndViewable(), and Title\newFromText().

Referenced by showIntro().

◆ showDiff()

EditPage::showDiff ( )

Get a diff between the current contents of the edit box and the version of the page we're editing from.

If this is a section edit, we'll replace the section as for final save and then make a comparison.

Definition at line 3779 of file EditPage.php.

References getCurrentContent(), ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, and toEditContent().

Referenced by displayPreviewArea(), and spamPageWithContent().

◆ showEditForm()

EditPage::showEditForm ( $formCallback = null )

Send the edit form and related headers to OutputPage.

Parameters

callable | null $formCallback That takes an OutputPage parameter; will be called during form output near the top, for captchas and the like.

The $formCallback parameter is deprecated since MediaWiki 1.25. Please use the EditPage::showEditForm:fields hook instead.

Definition at line 3026 of file EditPage.php.

References $content, $editConflictHelper, $textbox1, addEditNotices(), addTalkPageText(), Xml\checkLabel(), Xml\closeElement(), displayPreviewArea(), Xml\element(), Linker\formatHiddenCategories(), getActionURL(), getContextTitle(), getCurrentContent(), getEditConflictHelper(), MediaWiki\EditPage\TextConflictHelper\getEditConflictMainTextBox(), MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlAfterContent(), MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlBeforeContent(), getParentRevId(), getPreviewText(), CommentStore\getStore(), getSummaryPreview(), getTemplates(), Html\hidden(), isSectionEditSupported(), makeTemplatesOnThisPageList(), Xml\openElement(), Html\openElement(), Html\rawElement(), MediaWiki\EditPage\TextConflictHelper\setContentFormat(), MediaWiki\EditPage\TextConflictHelper\setContentModel(), setHeaders(), MediaWiki\EditPage\TextConflictHelper\setTextboxes(), showConflict(), showContentForm(), showEditTools(), showFormAfterText(), showFormBeforeText(), showHeader(), showStandardInputs(), showSummaryInput(), showTosSummary(), Linker\titleAttrib(), toEditText(), wasDeletedSinceLastEdit(), and wfWarn().

Referenced by edit().

◆ showEditTools()

EditPage::showEditTools ( )

protected

Inserts optional text shown below edit and upload forms.

Can be used to offer special characters not present on most keyboards for copying/pasting.

Definition at line 3872 of file EditPage.php.

Referenced by showEditForm().

◆ showFormAfterText()

EditPage::showFormAfterText ( )

protected

Definition at line 3624 of file EditPage.php.

References Html\hidden().

Referenced by showEditForm().

◆ showFormBeforeText()

EditPage::showFormBeforeText ( )

protected

Definition at line 3615 of file EditPage.php.

References Html\hidden().

Referenced by showEditForm().

◆ showHeader()

EditPage::showHeader ( )

protected

Definition at line 3329 of file EditPage.php.

References addExplainConflictHeader(), addLongPageWarningHeader(), addPageProtectionWarningHeaders(), extractSectionTitle(), getSubmitButtonLabel(), getTitle(), SpecialPage\getTitleFor(), isWrongCaseUserConfigPage(), showHeaderCopyrightWarning(), Html\warningBox(), wfArrayToCgi(), wfReadOnly(), and wfReadOnlyReason().

Referenced by showEditForm().

◆ showHeaderCopyrightWarning()

EditPage::showHeaderCopyrightWarning ( )

protected

Show the header copyright warning.

Definition at line 3841 of file EditPage.php.

Referenced by showHeader().

◆ showIntro()

EditPage::showIntro ( )

protected

Show all applicable editing introductions.

Definition at line 2817 of file EditPage.php.

References $dbr, $file, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, CONTENT_MODEL_JSON, DB_REPLICA, User\isIP(), Skin\makeInternalOrExternalUrl(), User\newFromName(), NS_FILE, NS_MEDIAWIKI, NS_USER, NS_USER_TALK, showCustomIntro(), LogEventsList\showLogExtract(), wfEscapeWikiText(), wfExpandUrl(), and wfGetDB().

Referenced by edit().

◆ showPreview()

EditPage::showPreview ( $text )

protected

Append preview output to OutputPage.

Includes category rendering if this is a category page.

Parameters

string $text The HTML to be output for the preview.

Definition at line 3758 of file EditPage.php.

Referenced by displayPreviewArea().

◆ showStandardInputs()

EditPage::showStandardInputs ( & $tabindex = 2 )

protected

Definition at line 3966 of file EditPage.php.

References getCancelLink(), getCheckboxesWidget(), getCopywarn(), getEditButtons(), getSummaryPreview(), Html\linkButton(), Skin\makeInternalOrExternalUrl(), and showSummaryInput().

Referenced by showEditForm().

◆ showSummaryInput()

EditPage::showSummaryInput	(	$isSubjectPreview,
		$summary = `""`
	)

protected

Parameters

bool	$isSubjectPreview	True if this is the section subject/title up top, or false if this is the comment summary down below the textarea
string	$summary	The text of the summary to display

Definition at line 3568 of file EditPage.php.

References getSummaryInputWidget().

Referenced by showEditForm(), and showStandardInputs().

◆ showTextbox()

EditPage::showTextbox	(	$text,
		$name,
		$customAttribs = `[]`
	)

protected

Definition at line 3699 of file EditPage.php.

References Html\textarea().

Referenced by displayViewSourcePage(), showTextbox1(), and showTextbox2().

◆ showTextbox1()

EditPage::showTextbox1	(	$customAttribs = `null`,
		$textoverride = `null`
	)

protected

Method to output wpTextbox1 The $textoverride method can be used by subclasses overriding showContentForm to pass back to this method.

Parameters

array \| null	$customAttribs	Array of html attributes to use in the textarea
string \| null	$textoverride	Optional text to override $this->textarea1 with

Definition at line 3664 of file EditPage.php.

References getTitle(), showTextbox(), and wasDeletedSinceLastEdit().

Referenced by showContentForm().

◆ showTextbox2()

EditPage::showTextbox2 ( )

protected

Definition at line 3695 of file EditPage.php.

References showTextbox().

Referenced by spamPageWithContent().

◆ showTosSummary()

EditPage::showTosSummary ( )

protected

Give a chance for site and per-namespace customizations of terms of service summary link that might exist separately from the copyright notice.

This will display between the save button and the edit tools, so should remain short!

Definition at line 3857 of file EditPage.php.

Referenced by showEditForm().

◆ spamPageWithContent()

EditPage::spamPageWithContent ( $match = false )

Show "your edit contains spam" page with your diff and text.

Parameters

string | array | bool $match Text (or array of texts) which triggered one or more filters

Definition at line 4663 of file EditPage.php.

References $textbox1, getContextTitle(), showDiff(), showTextbox2(), and wfEscapeWikiText().

Referenced by handleStatus().

◆ toEditContent()

EditPage::toEditContent ( $text )

protected

Turns the given text into a Content object by unserializing it.

If the resulting Content object is not of a type that can be edited using the text base EditPage, an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual content.

Parameters

string | null | bool $text Text to unserialize

Returns: Content|bool|null The content object created from $text. If $text was false or null, then false or null will be returned instead.

Exceptions

MWException If unserializing the text results in a Content object that is not an instance of TextContent and $this->allowNonTextContent is not true.

Definition at line 3003 of file EditPage.php.

References $content, getTitle(), isSupportedContentModel(), and ContentHandler\makeContent().

Referenced by getContentObject(), getPreviewText(), internalAttemptSave(), and showDiff().

◆ toEditText()

EditPage::toEditText ( $content )

protected

Gets an editable textual representation of $content.

The textual representation can be turned by into a Content object by the toEditContent() method.

If $content is null or false or a string, $content is returned unchanged.

If the given Content object is not of a type that can be edited using the text base EditPage, an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual content.

Parameters

Content | null | bool | string $content

Returns: string|false|null The editable text form of the content.

Exceptions

MWException If $content is not an instance of TextContent and $this->allowNonTextContent is not true.

Definition at line 2975 of file EditPage.php.

References $content, and isSupportedContentModel().

Referenced by displayViewSourcePage(), initialiseForm(), internalAttemptSave(), and showEditForm().

◆ tokenOk()

EditPage::tokenOk ( & $request )

Make sure the form isn't faking a user's credentials.

Parameters

WebRequest &$request

Returns: bool

Definition at line 1692 of file EditPage.php.

References $mTokenOk.

Referenced by importFormData().

◆ updateWatchlist()

EditPage::updateWatchlist ( )

protected

Register the change of watch status.

Definition at line 2596 of file EditPage.php.

References $mTitle, $title, $watchlistExpiry, $watchthis, WatchAction\doWatchOrUnwatch(), and getContext().

Referenced by internalAttemptSave().

◆ wasDeletedSinceLastEdit()

EditPage::wasDeletedSinceLastEdit ( )

protected

Check if a page was deleted while the user was editing it, before submit.

Note that we rely on the logging table, which hasn't been always there, but that doesn't matter, because this only applies to brand new deletes.

Returns: bool

Definition at line 4074 of file EditPage.php.

References $deletedSinceEdit, getLastDelete(), and wfTimestamp().

Referenced by internalAttemptSave(), showEditForm(), and showTextbox1().

Member Data Documentation

◆ $action

string EditPage::$action = 'submit'

Definition at line 116 of file EditPage.php.

Referenced by displayPermissionsError().

◆ $allowBlankArticle

bool EditPage::$allowBlankArticle = false

protected

Definition at line 200 of file EditPage.php.

◆ $allowBlankSummary

bool EditPage::$allowBlankSummary = false

Definition at line 194 of file EditPage.php.

◆ $allowSelfRedirect

bool EditPage::$allowSelfRedirect = false

protected

Definition at line 206 of file EditPage.php.

◆ $autoSumm

string EditPage::$autoSumm = ''

Definition at line 212 of file EditPage.php.

◆ $blankArticle

bool EditPage::$blankArticle = false

protected

Definition at line 197 of file EditPage.php.

◆ $changeTags

null array EditPage::$changeTags = null

private

Definition at line 377 of file EditPage.php.

Referenced by importFormData().

◆ $contentFormat

null string EditPage::$contentFormat = null

Definition at line 374 of file EditPage.php.

◆ $contentHandlerFactory

IContentHandlerFactory EditPage::$contentHandlerFactory

private

Definition at line 441 of file EditPage.php.

◆ $contentLength

bool int EditPage::$contentLength = false

protected

Definition at line 404 of file EditPage.php.

◆ $contentModel

string EditPage::$contentModel

Definition at line 371 of file EditPage.php.

◆ $context

IContextSource EditPage::$context

protected

Definition at line 414 of file EditPage.php.

Referenced by getContext().

◆ $deletedSinceEdit

bool EditPage::$deletedSinceEdit

Definition at line 131 of file EditPage.php.

Referenced by wasDeletedSinceLastEdit().

◆ $didSave

EditPage::$didSave = false

Definition at line 394 of file EditPage.php.

◆ $diff

bool EditPage::$diff = false

Definition at line 259 of file EditPage.php.

Referenced by importFormData().

◆ $edit

bool EditPage::$edit

protected

Definition at line 401 of file EditPage.php.

◆ $editConflictHelper

TextConflictHelper null EditPage::$editConflictHelper

private

Definition at line 436 of file EditPage.php.

Referenced by getEditConflictHelper(), and showEditForm().

◆ $editConflictHelperFactory

callable EditPage::$editConflictHelperFactory

private

Factory function to create an edit conflict helper.

Definition at line 431 of file EditPage.php.

◆ $editFormPageTop

string EditPage::$editFormPageTop = ''

Before even the preview.

Definition at line 383 of file EditPage.php.

◆ $editFormTextAfterContent

EditPage::$editFormTextAfterContent = ''

Definition at line 389 of file EditPage.php.

◆ $editFormTextAfterTools

EditPage::$editFormTextAfterTools = ''

Definition at line 387 of file EditPage.php.

◆ $editFormTextAfterWarn

EditPage::$editFormTextAfterWarn = ''

Definition at line 386 of file EditPage.php.

◆ $editFormTextBeforeContent

EditPage::$editFormTextBeforeContent = ''

Definition at line 385 of file EditPage.php.

◆ $editFormTextBottom

EditPage::$editFormTextBottom = ''

Definition at line 388 of file EditPage.php.

◆ $editFormTextTop

EditPage::$editFormTextTop = ''

Definition at line 384 of file EditPage.php.

◆ $editintro

string EditPage::$editintro = ''

Definition at line 356 of file EditPage.php.

◆ $editRevId

int EditPage::$editRevId = null

private

Revision ID of the latest revision of the page when editing was initiated on the client.

This is used to detect and resolve edit conflicts.

Note: 0 if the page did not exist at that time.; When starting an edit from an old revision, this still records the current revision at the time, not the one the edit is based on.

See also: $oldid; getExpectedParentRevision()

Definition at line 323 of file EditPage.php.

◆ $edittime

string EditPage::$edittime = ''

Timestamp of the latest revision of the page when editing was initiated on the client.

Definition at line 310 of file EditPage.php.

◆ $enableApiEditOverride

bool EditPage::$enableApiEditOverride = false

private

Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing.

Definition at line 409 of file EditPage.php.

◆ $firsttime

bool EditPage::$firsttime

True the first time the edit form is rendered, false after re-rendering with diff, save prompts, etc.

Definition at line 140 of file EditPage.php.

◆ $formtype

string EditPage::$formtype

Definition at line 134 of file EditPage.php.

◆ $hasPresetSummary

bool EditPage::$hasPresetSummary = false

Has a summary been preset using GET parameter &summary= ?

Definition at line 227 of file EditPage.php.

◆ $hookError

string EditPage::$hookError = ''

private

Definition at line 215 of file EditPage.php.

◆ $incompleteForm

bool EditPage::$incompleteForm = false

Definition at line 170 of file EditPage.php.

◆ $isConflict

bool EditPage::$isConflict = false

Whether an edit conflict needs to be resolved.

Detected based on whether $editRevId is different than the latest revision. When a conflict has successfully been resolved by a 3-way-merge, this field is set to false.

Definition at line 122 of file EditPage.php.

◆ $isNew

bool EditPage::$isNew = false

New page or new section.

Definition at line 125 of file EditPage.php.

◆ $isOldRev

bool EditPage::$isOldRev = false

private

Whether an old revision is edited.

Definition at line 419 of file EditPage.php.

◆ $lastDelete

bool stdClass EditPage::$lastDelete

Definition at line 146 of file EditPage.php.

◆ $markAsBot

bool EditPage::$markAsBot = true

Definition at line 368 of file EditPage.php.

Referenced by attemptSave(), and internalAttemptSave().

◆ $mArticle

Article EditPage::$mArticle

Deprecated:: for public usage since 1.30 use EditPage::getArticle()

Definition at line 101 of file EditPage.php.

Referenced by getArticle().

◆ $mBaseRevision

Revision bool null EditPage::$mBaseRevision = false

protected

A revision object corresponding to $this->editRevId.

Formerly public as part of using Revision objects

Deprecated:: since 1.35

Definition at line 237 of file EditPage.php.

Referenced by getBaseRevision().

◆ $mContextTitle

null Title EditPage::$mContextTitle = null

private

Definition at line 113 of file EditPage.php.

Referenced by getContextTitle().

◆ $mExpectedParentRevision

RevisionRecord bool null EditPage::$mExpectedParentRevision = false

private

A RevisionRecord corresponding to $this->editRevId or $this->edittime Replaced $mBaseRevision.

Definition at line 245 of file EditPage.php.

Referenced by getExpectedParentRevision().

◆ $minoredit

bool EditPage::$minoredit = false

Definition at line 265 of file EditPage.php.

◆ $missingComment

bool EditPage::$missingComment = false

Definition at line 182 of file EditPage.php.

◆ $missingSummary

bool EditPage::$missingSummary = false

Definition at line 188 of file EditPage.php.

◆ $mParserOutput

ParserOutput EditPage::$mParserOutput

Definition at line 221 of file EditPage.php.

◆ $mPreloadContent

EditPage::$mPreloadContent = null

Definition at line 391 of file EditPage.php.

Referenced by getPreloadedContent().

◆ $mShowSummaryField

bool EditPage::$mShowSummaryField = true

Definition at line 248 of file EditPage.php.

◆ $mTitle

Title EditPage::$mTitle

Deprecated:: for public usage since 1.30 use EditPage::getTitle()

Definition at line 110 of file EditPage.php.

Referenced by getTitle(), internalAttemptSave(), and updateWatchlist().

◆ $mTokenOk

bool EditPage::$mTokenOk = false

Definition at line 152 of file EditPage.php.

Referenced by tokenOk().

◆ $mTokenOkExceptSuffix

bool EditPage::$mTokenOkExceptSuffix = false

Definition at line 158 of file EditPage.php.

◆ $mTriedSave

bool EditPage::$mTriedSave = false

Definition at line 164 of file EditPage.php.

◆ $nosummary

bool EditPage::$nosummary = false

Definition at line 304 of file EditPage.php.

◆ $oldid

int EditPage::$oldid = 0

Revision ID the edit is based on, or 0 if it's the current revision.

FIXME: This isn't used in conflict resolution–provide a better justification or merge with parentRevId.

See also: $editRevId

Definition at line 341 of file EditPage.php.

Referenced by getCancelLink().

◆ $page

WikiPage EditPage::$page

private

Definition at line 104 of file EditPage.php.

Referenced by addPageProtectionWarningHeaders(), and getPreloadedContent().

◆ $parentRevId

int EditPage::$parentRevId = 0

Revision ID the edit is based on, adjusted when an edit conflict is resolved.

Definition at line 350 of file EditPage.php.

Referenced by getParentRevId().

◆ $permManager

PermissionManager EditPage::$permManager

private

Definition at line 446 of file EditPage.php.

◆ $preview

bool EditPage::$preview = false

Definition at line 256 of file EditPage.php.

Referenced by importFormData().

◆ $previewTextAfterContent

EditPage::$previewTextAfterContent = ''

Definition at line 390 of file EditPage.php.

Referenced by getPreviewText().

◆ $recreate

bool EditPage::$recreate = false

Definition at line 286 of file EditPage.php.

◆ $revisionStore

RevisionStore EditPage::$revisionStore

private

Definition at line 451 of file EditPage.php.

◆ $save

bool EditPage::$save = false

Definition at line 253 of file EditPage.php.

◆ $scrolltop

int null EditPage::$scrolltop = null

Definition at line 362 of file EditPage.php.

◆ $section

string EditPage::$section = ''

Definition at line 326 of file EditPage.php.

◆ $sectiontitle

string EditPage::$sectiontitle = ''

Definition at line 329 of file EditPage.php.

Referenced by internalAttemptSave().

◆ $selfRedirect

bool EditPage::$selfRedirect = false

protected

Definition at line 203 of file EditPage.php.

◆ $starttime

string EditPage::$starttime = ''

Timestamp from the first time the edit form was rendered.

Definition at line 334 of file EditPage.php.

◆ $summary

string EditPage::$summary = ''

Definition at line 297 of file EditPage.php.

Referenced by getContentObject(), getSummaryInputWidget(), getSummaryPreview(), internalAttemptSave(), and newSectionSummary().

◆ $suppressIntro

EditPage::$suppressIntro = false

Definition at line 398 of file EditPage.php.

◆ $textbox1

string EditPage::$textbox1 = ''

Page content input field.

Definition at line 291 of file EditPage.php.

Referenced by displayViewSourcePage(), importFormData(), showEditForm(), and spamPageWithContent().

◆ $textbox2

string EditPage::$textbox2 = ''

Definition at line 294 of file EditPage.php.

◆ $tooBig

bool EditPage::$tooBig = false

Definition at line 176 of file EditPage.php.

◆ $undidRev

EditPage::$undidRev = 0

Definition at line 395 of file EditPage.php.

Referenced by importFormData().

◆ $undoAfter

EditPage::$undoAfter = 0

Definition at line 396 of file EditPage.php.

Referenced by importFormData().

◆ $unicodeCheck

string null EditPage::$unicodeCheck

private

What the user submitted in the 'wpUnicodeCheck' field.

Definition at line 424 of file EditPage.php.

◆ $watchedItemStore

WatchedItemStoreInterface EditPage::$watchedItemStore

private

Definition at line 277 of file EditPage.php.

◆ $watchlistExpiry

string null EditPage::$watchlistExpiry

private

The expiry time of the watch item, or null if it is not watched temporarily.

Definition at line 280 of file EditPage.php.

Referenced by updateWatchlist().

◆ $watchlistExpiryEnabled

bool EditPage::$watchlistExpiryEnabled = false

private

Corresponds to $wgWatchlistExpiry.

Definition at line 274 of file EditPage.php.

◆ $watchthis

bool EditPage::$watchthis = false

Definition at line 271 of file EditPage.php.

Referenced by updateWatchlist().

◆ EDITFORM_ID

const EditPage::EDITFORM_ID = 'editform'

HTML id and name for the beginning of the edit form.

Definition at line 74 of file EditPage.php.

◆ POST_EDIT_COOKIE_DURATION

const EditPage::POST_EDIT_COOKIE_DURATION = 1200

Duration of PostEdit cookie, in seconds.

The cookie will be removed instantly if the JavaScript runs.

Otherwise, though, we don't want the cookies to accumulate. RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible limit of only 20 cookies per domain. This still applies at least to some versions of IE without full updates: https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx

A value of 20 minutes should be enough to take into account slow loads and minor clock skew while still avoiding cookie accumulation when JavaScript is turned off.

Definition at line 95 of file EditPage.php.

◆ POST_EDIT_COOKIE_KEY_PREFIX

const EditPage::POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision'

Prefix of key for cookie used to pass post-edit state.

The revision id edited is added after this

Definition at line 80 of file EditPage.php.

Referenced by Article\view().

◆ UNICODE_CHECK

const EditPage::UNICODE_CHECK = 'ℳ𝒲♥𝓊𝓃𝒾𝒸ℴ𝒹ℯ'

Used for Unicode support checks.

Definition at line 69 of file EditPage.php.

Referenced by ApiEditPage\execute().

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

includes/EditPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addContentModelChangeLogEntry()

◆ addEditNotices()

◆ addExplainConflictHeader()

◆ addLongPageWarningHeader()

◆ addNewLineAtEnd()

◆ addPageProtectionWarningHeaders()

◆ addTalkPageText()

◆ attemptSave()

◆ buildTextboxAttribs()

◆ displayPermissionsError()

◆ displayPreviewArea()

◆ displayViewSourcePage()

◆ doPreviewParse()

◆ edit()

◆ extractSectionTitle()

◆ formatStatusErrors()

◆ getActionURL()

◆ getArticle()

◆ getBaseRevision()

◆ getCancelLink()

◆ getCheckboxesDefinition()

◆ getCheckboxesDefinitionForWatchlist()

◆ getCheckboxesWidget()

◆ getContentObject()

◆ getContext()

◆ getContextTitle()

◆ getCopyrightWarning()

◆ getCopywarn()

◆ getCurrentContent()

◆ getEditButtons()

◆ getEditConflictHelper()

◆ getEditPermissionErrors()

◆ getEditToolbar()

◆ getExpectedParentRevision()

◆ getLastDelete()

◆ getOriginalContent()

◆ getParentRevId()

◆ getPreloadedContent()

◆ getPreviewLimitReport()

◆ getPreviewParserOptions()

◆ getPreviewText()

◆ getSubmitButtonLabel()

◆ getSummaryInputAttributes()

◆ getSummaryInputWidget()

◆ getSummaryPreview()

◆ getTemplates()

◆ getTitle()

◆ getUndoContent()

◆ guessSectionName()

◆ handleStatus()

◆ importContentFormData()

◆ importFormData()

◆ incrementConflictStats()

◆ incrementEditFailureStats()

◆ incrementResolvedConflicts()

◆ initialiseForm()

◆ internalAttemptSave()

◆ isPageExistingAndViewable()

◆ isSectionEditSupported()

◆ isSupportedContentModel()

◆ isUndoClean()

◆ isWrongCaseUserConfigPage()

◆ makeTemplatesOnThisPageList()

◆ matchSpamRegex()

◆ matchSummarySpamRegex()

◆ mergeChangesIntoContent()

◆ newSectionSummary()

◆ newTextConflictHelper()

◆ noSuchSectionPage()