Class representing a MediaWiki article and history. More...

Inheritance diagram for WikiPage:

[legend]

Collaboration diagram for WikiPage:

[legend]

Public Member Functions
	__clone ()
	Makes sure that the mTitle object is cloned to the newly cloned WikiPage.

	__construct (Title $title)
	Constructor and clear the article.

	checkFlags ( $flags)
	Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.

	checkTouched ()
	Loads page_touched and returns a value indicating if it should be used.

	clear ()
	Clear the object.

	clearPreparedEdit ()
	Clear the mPreparedEdit cache field, as may be needed by mutable content types.

	commitRollback ( $fromP, $summary, $bot, &$resultDetails, User $guser, $tags=null)
	Backend implementation of doRollback(), please refer there for parameter and return value documentation.

	doDeleteArticle ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $user=null, $immediate=false)
	Same as doDeleteArticleReal(), but returns a simple boolean.

	doDeleteArticleBatched ( $reason, $suppress, User $deleter, $tags, $logsubtype, $immediate=false, $webRequestId=null)
	Back-end article deletion.

	doDeleteArticleReal ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $deleter=null, $tags=[], $logsubtype='delete', $immediate=false)
	Back-end article deletion Deletes the article with database consistency, writes logs, purges caches.

	doDeleteUpdates ( $id, Content $content=null, Revision $revision=null, User $user=null)
	Do some database updates after deletion.

	doEditContent (Content $content, $summary, $flags=0, $originalRevId=false, User $user=null, $serialFormat=null, $tags=[], $undidRevId=0)
	Change an existing article or create a new article.

	doEditUpdates (Revision $revision, User $user, array $options=[])
	Do standard deferred updates after page edit.

	doPurge ()
	Perform the actions of a page purging.

	doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags=null)
	Roll back the most recent consecutive set of edits to a page from the same user; fails if there are no eligible edits to roll back to, e.g.

	doSecondaryDataUpdates (array $options=[])
	Do secondary data updates (such as updating link tables).

	doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user, $tags=null)
	Update the article's restriction field, and leave a log entry.

	doViewUpdates (User $user, $oldid=0)
	Do standard deferred updates after page view (existing or missing page)

	exists ()

	followRedirect ()
	Get the Title object or URL this page redirects to.

	getActionOverrides ()

	getAutoDeleteReason (&$hasHistory)
	Auto-generates a deletion reason.

	getCategories ()
	Returns a list of categories this page is a member of.

	getComment ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)

	getContent ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)
	Get the content of the current revision.

	getContentHandler ()
	Returns the ContentHandler instance to be used to deal with the content of this WikiPage.

	getContentModel ()
	Returns the page's content model id (see the CONTENT_MODEL_XXX constants).

	getContributors ()
	Get a list of users who have edited this article, not including the user who made the most recent revision, which you can get from $article->getUser() if you want it.

	getCreator ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)
	Get the User object of the user who created the page.

	getDeletionUpdates ( $rev=null)
	Returns a list of updates to be performed when this page is deleted.

	getHiddenCategories ()
	Returns a list of hidden categories this page is a member of.

	getId ()

	getLatest ()
	Get the page_latest field.

	getLinksTimestamp ()
	Get the page_links_updated field.

	getMinorEdit ()
	Returns true if last revision was marked as "minor edit".

	getMutableCacheKeys (WANObjectCache $cache)

	getOldestRevision ()
	Get the Revision object of the oldest revision.

	getParserOutput (ParserOptions $parserOptions, $oldid=null, $forceParse=false)
	Get a ParserOutput for the given ParserOptions and revision ID.

	getRedirectTarget ()
	If this page is a redirect, get its target.

	getRedirectURL ( $rt)
	Get the Title object or URL to use for a redirect.

	getRevision ()
	Get the latest revision.

	getRevisionRecord ()
	Get the latest revision.

	getSourceURL ()
	Get the source URL for the content on this page, typically the canonical URL, but may be a remote link if the content comes from another site.

	getTimestamp ()

	getTitle ()
	Get the title object of the article.

	getTouched ()
	Get the page_touched field.

	getUndoContent (Revision $undo, Revision $undoafter)
	Get the content that needs to be saved in order to undo all revisions between $undo and $undoafter.

	getUser ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)

	getUserText ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)

	getWikiDisplayName ()
	The display name for the site this content come from.

	hasViewableContent ()
	Check if this page is something we're going to be showing some sort of sensible content for.

	insertOn ( $dbw, $pageId=null)
	Insert a new empty page record for this article.

	insertProtectNullRevision ( $revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null)
	Insert a new null revision for this page.

	insertRedirect ()
	Insert an entry for this page into the redirect table if the content is a redirect.

	insertRedirectEntry (Title $rt, $oldLatest=null)
	Insert or update the redirect table entry for this page to indicate it redirects to $rt.

	isBatchedDelete ( $safetyMargin=0)
	Determines if deletion of this page would be batched (executed over time by the job queue) or not (completed in the same request as the delete call).

	isCountable ( $editInfo=false)
	Determine whether a page would be suitable for being counted as an article in the site_stats table based on the title & its content.

	isLocal ()
	Whether this content displayed on this page comes from the local database.

	isRedirect ()
	Tests if the article content represents a redirect.

	loadFromRow ( $data, $from)
	Load the object from a database row.

	loadPageData ( $from='fromdb')
	Load the object from a given source by title.

	lockAndGetLatest ()
	Lock the page row for this title+id and return page_latest (or 0)

	makeParserOptions ( $context)
	Get parser options suitable for rendering the primary article wikitext.

	newPageUpdater (User $user, RevisionSlotsUpdate $forUpdate=null)
	Returns a PageUpdater for creating new revisions on this page (or creating the page).

	pageDataFromId ( $dbr, $id, $options=[])
	Fetch a page record matching the requested ID.

	pageDataFromTitle ( $dbr, $title, $options=[])
	Fetch a page record matching the Title object's namespace and title using a sanitized title string.

	prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
	Prepare content which is about to be saved.

	protectDescription (array $limit, array $expiry)
	Builds the description to serve as comment for the edit.

	protectDescriptionLog (array $limit, array $expiry)
	Builds the description to serve as comment for the log entry.

	replaceSectionAtRev ( $sectionId, Content $sectionContent, $sectionTitle='', $baseRevId=null)

	replaceSectionContent ( $sectionId, Content $sectionContent, $sectionTitle='', $edittime=null)

	setTimestamp ( $ts)
	Set the page timestamp (use only to avoid DB queries)

	shouldCheckParserCache (ParserOptions $parserOptions, $oldId)
	Should the parser cache be used?

	supportsSections ()
	Returns true if this page's content model supports sections.

	triggerOpportunisticLinksUpdate (ParserOutput $parserOutput)
	Opportunistically enqueue link update jobs given fresh parser output if useful.

	updateCategoryCounts (array $added, array $deleted, $id=0)
	Update all the appropriate counts in the category table, given that we've added the categories $added and deleted the categories $deleted.

	updateIfNewerOn ( $dbw, $revision)
	If the given revision is newer than the currently set page_latest, update the page record.

	updateParserCache (array $options=[])
	Update the parser cache.

	updateRedirectOn ( $dbw, $redirectTitle, $lastRevIsRedirect=null)
	Add row to the redirect table if this is a redirect, remove otherwise.

	updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)
	Update the page record to point to a newly saved revision.

	wasLoadedFrom ( $from)
	Checks whether the page data was loaded using the given database access mode (or better).

Static Public Member Functions
static	factory (Title $title)
	Create a WikiPage object of the appropriate class for the given title.

static	getQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new page object.

static	hasDifferencesOutsideMainSlot (Revision $a, Revision $b)
	Helper method for checking whether two revisions have differences that go beyond the main slot.

static	newFromID ( $id, $from='fromdb')
	Constructor from a page id.

static	newFromRow ( $row, $from='fromdb')
	Constructor from a database row.

static	onArticleCreate (Title $title)
	The onArticle*() functions are supposed to be a kind of hooks which should be called whenever any of the specified actions are done.

static	onArticleDelete (Title $title)
	Clears caches when article is deleted.

static	onArticleEdit (Title $title, Revision $revision=null, $slotsChanged=null)
	Purge caches on page update etc.

static	selectFields ()
	Return the list of revision fields that should be selected to create a new page.

Public Attributes
bool	$mDataLoaded = false

bool	$mIsRedirect = false

int false	$mLatest = false
	False means "not loaded".

PreparedEdit false	$mPreparedEdit = false
	Map of cache fields (text, parser output, ect) for a proposed/new edit.

Title	$mTitle = null

Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = self::READ_LATEST \| 2
	Constants for object loading bitfield flags (higher => higher QoS)

const	READ_NONE = -1

Protected Member Functions
	archiveRevisions ( $dbw, $id, $suppress)
	Archives revisions as part of page deletion.

	clearCacheFields ()
	Clear the object cache fields.

	formatExpiry ( $expiry)

	loadLastEdit ()
	Loads everything except the text This isn't necessary for all uses, so it's only done if needed.

	pageData ( $dbr, $conditions, $options=[])
	Fetch a page record with the given conditions.

	setLastEdit (Revision $revision)
	Set the latest revision.

Static Protected Member Functions
static	convertSelectType ( $type)
	Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.

static	flattenRestrictions ( $limit)
	Take an array of page restrictions and flatten it to a string suitable for insertion into the page_restrictions field.

Protected Attributes
int	$mDataLoadedFrom = self::READ_NONE
	One of the READ_* constants.

int	$mId = null

Revision	$mLastRevision = null

string	$mLinksUpdated = '19700101000000'

Title	$mRedirectTarget = null

string	$mTimestamp = ''
	Timestamp of the current revision or empty string if not loaded.

string	$mTouched = '19700101000000'

Private Member Functions
	getDBLoadBalancer ()

	getDerivedDataUpdater (User $forUser=null, RevisionRecord $forRevision=null, RevisionSlotsUpdate $forUpdate=null, $forEdit=false)
	Returns a DerivedPageDataUpdater for use with the given target revision or new content.

	getParserCache ()

	getRevisionRenderer ()

	getRevisionStore ()

	getSlotRoleRegistry ()

	newDerivedDataUpdater ()

Static Private Member Functions
static	purgeInterwikiCheckKey (Title $title)
	#-

Private Attributes
DerivedPageDataUpdater null	$derivedDataUpdater = null

Detailed Description

Class representing a MediaWiki article and history.

Some fields are public only for backwards-compatibility. Use accessors. In the past, this class was part of Article.php and everything was public.

-file-suppress PhanAccessMethodInternal Due to the use of DerivedPageDataUpdater

Definition at line 47 of file WikiPage.php.

Constructor & Destructor Documentation

◆ __construct()

WikiPage::__construct ( Title $title )

Constructor and clear the article.

Parameters

Title $title Reference to a Title object.

Definition at line 122 of file WikiPage.php.

References $title.

Member Function Documentation

◆ __clone()

WikiPage::__clone ( )

Makes sure that the mTitle object is cloned to the newly cloned WikiPage.

Definition at line 130 of file WikiPage.php.

References $mTitle.

◆ archiveRevisions()

WikiPage::archiveRevisions	(	$dbw,
		$id,
		$suppress
	)

protected

Archives revisions as part of page deletion.

Parameters

IDatabase	$dbw
int	$id
bool	$suppress	Suppress all revisions and log the deletion in the suppression log instead of the deletion log

Returns: bool

Definition at line 2842 of file WikiPage.php.

References $res, $revQuery, $wgContentHandlerUseDB, $wgDeleteRevisionsBatchSize, $wgMultiContentRevisionSchemaMigrationStage, Revision\getQueryInfo(), getTitle(), User\newFromAnyId(), and SCHEMA_COMPAT_WRITE_OLD.

Referenced by doDeleteArticleBatched().

◆ checkFlags()

WikiPage::checkFlags ( $flags )

Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.

Deprecated:: since 1.32, use exists() instead, or simply omit the EDIT_UPDATE and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.

Parameters

int $flags

Returns: int Updated $flags

Definition at line 1681 of file WikiPage.php.

References EDIT_NEW, EDIT_UPDATE, and exists().

◆ checkTouched()

WikiPage::checkTouched ( )

Loads page_touched and returns a value indicating if it should be used.

Returns: bool True if this page exists and is not a redirect

Definition at line 681 of file WikiPage.php.

References loadPageData().

◆ clear()

WikiPage::clear ( )

Clear the object.

Returns: void

Definition at line 306 of file WikiPage.php.

References clearCacheFields().

◆ clearCacheFields()

WikiPage::clearCacheFields ( )

protected

Clear the object cache fields.

Returns: void

Definition at line 317 of file WikiPage.php.

Referenced by clear(), and loadFromRow().

◆ clearPreparedEdit()

WikiPage::clearPreparedEdit ( )

Clear the mPreparedEdit cache field, as may be needed by mutable content types.

Returns: void

Since: 1.23

Definition at line 337 of file WikiPage.php.

◆ commitRollback()

WikiPage::commitRollback	(		$fromP,
			$summary,
			$bot,
		&	$resultDetails,
		User	$guser,
			$tags = `null`
	)

Backend implementation of doRollback(), please refer there for parameter and return value documentation.

NOTE: This function does NOT check ANY permissions, it just commits the rollback to the DB. Therefore, you should only call this function direct- ly if you want to use custom permissions checks. If you don't, use doRollback() instead.

Parameters

string	$fromP	Name of the user whose edits to rollback.
string	$summary	Custom summary. Set to default summary if empty.
bool	$bot	If true, mark all reverted edits as bot.
array	&$resultDetails	Contains result-specific array of additional values
User	$guser	The user performing the rollback
array \| null	$tags	Change tags to apply to the rollback Callers are responsible for permission checks (with ChangeTags::canAddTagsAccompanyingChange)

Returns: array An array of error messages, as returned by Status::getErrorsArray()

Definition at line 3145 of file WikiPage.php.

References $args, $s, $wgDisableAnonTalk, $wgUseRCPatrol, DB_MASTER, EDIT_FORCE_BOT, EDIT_INTERNAL, EDIT_MINOR, EDIT_UPDATE, getRevisionStore(), ChangeTags\getSoftwareTags(), newPageUpdater(), wfGetDB(), wfMessage(), wfMsgReplaceArgs(), wfReadOnly(), and wfTimestamp().

Referenced by doRollback().

◆ convertSelectType()

static WikiPage::convertSelectType ( $type )

staticprotected

Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.

Parameters

object | string | int $type

Returns: mixed

Definition at line 222 of file WikiPage.php.

References $type.

◆ doDeleteArticle()

WikiPage::doDeleteArticle	(		$reason,
			$suppress = `false`,
			$u1 = `null`,
			$u2 = `null`,
		&	$error = `''`,
		User	$user = `null`,
			$immediate = `false`
	)

Same as doDeleteArticleReal(), but returns a simple boolean.

This is kept around for backwards compatibility, if you care about error reporting you should use doDeleteArticleReal() instead.

Deletes the article with database consistency, writes logs, purges caches

Parameters

string	$reason	Delete reason for deletion log
bool	$suppress	Suppress all revisions and log the deletion in the suppression log instead of the deletion log
int \| null	$u1	Unused
bool \| null	$u2	Unused
array \| string	&$error	Array of errors to append to
User \| null	$user	The deleting user
bool	$immediate	false allows deleting over time via the job queue

Returns: bool True if successful

Exceptions

FatalError
MWException

Definition at line 2604 of file WikiPage.php.

References doDeleteArticleReal().

◆ doDeleteArticleBatched()

WikiPage::doDeleteArticleBatched	(		$reason,
			$suppress,
		User	$deleter,
			$tags,
			$logsubtype,
			$immediate = `false`,
			$webRequestId = `null`
	)

Back-end article deletion.

Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize. Deletions can often be completed inline without involving the job queue.

Potentially called many times per deletion operation for pages with many revisions.

Definition at line 2675 of file WikiPage.php.

References $content, $job, $mTitle, archiveRevisions(), DB_MASTER, doDeleteUpdates(), getContent(), getId(), User\getId(), getLatest(), getRevision(), getTitle(), loadPageData(), lockAndGetLatest(), wfDebug(), wfEscapeWikiText(), wfGetDB(), and wfLogWarning().

Referenced by doDeleteArticleReal().

◆ doDeleteArticleReal()

WikiPage::doDeleteArticleReal	(		$reason,
			$suppress = `false`,
			$u1 = `null`,
			$u2 = `null`,
		&	$error = `''`,
		User	$deleter = `null`,
			$tags = `[]`,
			$logsubtype = `'delete'`,
			$immediate = `false`
	)

Back-end article deletion Deletes the article with database consistency, writes logs, purges caches.

Since: 1.19

Parameters

string	$reason	Delete reason for deletion log
bool	$suppress	Suppress all revisions and log the deletion in the suppression log instead of the deletion log
int \| null	$u1	Unused
bool \| null	$u2	Unused
array \| string	&$error	Array of errors to append to
User \| null	$deleter	The deleting user
array	$tags	Tags to apply to the deletion action
string	$logsubtype
bool	$immediate	false allows deleting over time via the job queue

Returns: Status Status object; if successful, $status->value is the log_id of the deletion log entry. If the page couldn't be deleted because it wasn't found, $status is a non-fatal 'cannotdelete' error

Exceptions

FatalError
MWException

Definition at line 2637 of file WikiPage.php.

References doDeleteArticleBatched(), and wfDebug().

Referenced by doDeleteArticle().

◆ doDeleteUpdates()

WikiPage::doDeleteUpdates	(		$id,
		Content	$content = `null`,
		Revision	$revision = `null`,
		User	$user = `null`
	)

Do some database updates after deletion.

Parameters

int	$id	The page_id value of the page being deleted
Content \| null	$content	Page content to be used when determining the required updates. This may be needed because $this->getContent() may already return null when the page proper was deleted.
Revision \| null	$revision	The current page revision at the time of deletion, used when determining the required updates. This may be needed because $this->getRevision() may already return null when the page proper was deleted.
User \| null	$user	The user that caused the deletion

Definition at line 3016 of file WikiPage.php.

References $content, getDeletionUpdates(), getId(), isCountable(), loadFromRow(), and NS_FILE.

Referenced by doDeleteArticleBatched().

◆ doEditContent()

WikiPage::doEditContent	(	Content	$content,
			$summary,
			$flags = `0`,
			$originalRevId = `false`,
		User	$user = `null`,
			$serialFormat = `null`,
			$tags = `[]`,
			$undidRevId = `0`
	)

Change an existing article or create a new article.

Updates RC and all necessary caches, optionally via the deferred update array.

Deprecated:: since 1.32, use PageUpdater::saveRevision instead. Note that the new method expects callers to take care of checking EDIT_MINOR against the minoredit right, and to apply the autopatrol right as appropriate.

Parameters

Content	$content	New content
string \| CommentStoreComment	$summary	Edit summary
int	$flags	Bitfield: EDIT_NEW Article is known or assumed to be non-existent, create a new one EDIT_UPDATE Article is known or assumed to be pre-existing, update it EDIT_MINOR Mark this edit minor, if the user is allowed to do so EDIT_SUPPRESS_RC Do not log the change in recentchanges EDIT_FORCE_BOT Mark the edit a "bot" edit regardless of user rights EDIT_AUTOSUMMARY Fill in blank summaries with generated text where possible EDIT_INTERNAL Signal that the page retrieve/save cycle happened entirely in this request.

If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected. If EDIT_UPDATE is specified and the article doesn't exist, the function will return an edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an edit-already-exists error will be returned. These two conditions are also possible with auto-detection due to MediaWiki's performance-optimised locking strategy.

Parameters

bool \| int	$originalRevId,	The ID of an original revision that the edit restores or repeats. The new revision is expected to have the exact same content as the given original revision. This is used with rollbacks and with dummy "null" revisions which are created to record things like page moves.
User \| null	$user	The user doing the edit
string \| null	$serialFormat	IGNORED.
array \| null	$tags	Change tags to apply to this edit Callers are responsible for permission checks (with ChangeTags::canAddTagsAccompanyingChange)
Int	$undidRevId	Id of revision that was undone or 0

Exceptions

MWException

Returns: Status Possible errors: edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status. edit-gone-missing: In update mode, but the article didn't exist. edit-conflict: In update mode, the article changed unexpectedly. edit-no-change: Warning that the text was the same as before. edit-already-exists: In creation mode, but the article already exists.

Extensions may define additional errors.

$return->value will contain an associative array with members as follows: new: Boolean indicating if the function attempted to create a new article. revision: The revision object for the inserted revision, or null.

Since: 1.21

Exceptions

MWException

Definition at line 1882 of file WikiPage.php.

References $content, $wgUseNPPatrol, $wgUseRCPatrol, EDIT_MINOR, exists(), newPageUpdater(), and setLastEdit().

◆ doEditUpdates()

WikiPage::doEditUpdates	(	Revision	$revision,
		User	$user,
		array	$options = `[]`
	)

Do standard deferred updates after page edit.

Update links tables, site stats, search index and message cache. Purges pages that include this page if the text was changed here. Every 100th edit, prune the recent changes table.

Deprecated:: since 1.32, use PageUpdater::doUpdates instead.

Parameters

Revision	$revision
User	$user	User object that did the revision
array	$options	Array of options, following indexes are used: changed: bool, whether the revision changed the content (default true) created: bool, whether the revision created the page (default false) moved: bool, whether the page was moved (default false) restored: bool, whether the page was undeleted (default false) oldrevision: Revision object for the pre-update revision (default null) oldcountable: bool, null, or string 'no-change' (default null): bool: whether the page was counted as an article before that revision, only used in changed is true and created is false null: if created is false, don't update the article count; if created is true, do update the article count 'no-change': don't update the article count, ever

causeAction: an arbitrary string identifying the reason for the update. See DataUpdate::getCauseAction(). (default 'edit-page')
causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent(). (string, defaults to the passed user)

Definition at line 2060 of file WikiPage.php.

References getDerivedDataUpdater(), User\getName(), and Revision\getRevisionRecord().

◆ doPurge()

WikiPage::doPurge ( )

Perform the actions of a page purging.

Returns: bool

Note: In 1.28 (and only 1.28), this took a $flags parameter that controlled how much purging was done.

Reimplemented in WikiFilePage.

Definition at line 1297 of file WikiPage.php.

References HTMLFileCache\clearFileCache(), getContent(), getTitle(), and NS_MEDIAWIKI.

◆ doRollback()

WikiPage::doRollback	(		$fromP,
			$summary,
			$token,
			$bot,
		&	$resultDetails,
		User	$user,
			$tags = `null`
	)

Roll back the most recent consecutive set of edits to a page from the same user; fails if there are no eligible edits to roll back to, e.g.

user is the sole contributor. This function performs permissions checks on $user, then calls commitRollback() to do the dirty work

Todo:

Separate the business/permission stuff out from backend code

Remove $token parameter. Already verified by RollbackAction and ApiRollback.

Parameters

string	$fromP	Name of the user whose edits to rollback.
string	$summary	Custom summary. Set to default summary if empty.
string	$token	Rollback token.
bool	$bot	If true, mark all reverted edits as bot.
array	&$resultDetails	Array contains result-specific array of additional values 'alreadyrolled' : 'current' (rev) success : 'summary' (str), 'current' (rev), 'target' (rev)
User	$user	The user performing the rollback
array \| null	$tags	Change tags to apply to the rollback Callers are responsible for permission checks (with ChangeTags::canAddTagsAccompanyingChange)

Returns: array Array of errors, each error formatted as [ messagekey, param1, param2, ... ]. On success, the array is empty. This array can also be passed to OutputPage::showPermissionsErrorPage().

Definition at line 3099 of file WikiPage.php.

References commitRollback(), User\matchEditToken(), User\pingLimiter(), and wfArrayDiff2().

◆ doSecondaryDataUpdates()

WikiPage::doSecondaryDataUpdates ( array $options = [] )

Do secondary data updates (such as updating link tables).

Secondary data updates are only a small part of the updates needed after saving a new revision; normally PageUpdater::doUpdates should be used instead (which includes secondary data updates). This method is provided for partial purges.

Note: This is a temporary workaround until there is a proper data updater class. It will become deprecated soon.

Parameters

array

$options

recursive (bool, default true): whether to do a recursive update (update pages that depend on this page, e.g. transclude it). This will set the $recursive parameter of Content::getSecondaryDataUpdates. Typically this should be true unless the update was something that did not really change the page, such as a null edit.
triggeringUser: The user triggering the update (UserIdentity, defaults to the user who created the revision)
causeAction: an arbitrary string identifying the reason for the update. See DataUpdate::getCauseAction(). (default 'unknown')
causeAgent: name of the user who caused the update (string, default 'unknown')
defer: one of the DeferredUpdates constants, or false to run immediately (default: false). Note that even when this is set to false, some updates might still get deferred (as some update might directly add child updates to DeferredUpdates).
known-revision-output: a combined canonical ParserOutput for the revision, perhaps from some cache. The caller is responsible for ensuring that the ParserOutput indeed matched the $rev and $options. This mechanism is intended as a temporary stop-gap, for the time until caches have been changed to store RenderedRevision states instead of ParserOutput objects. (default: null) (since 1.33)

Since: 1.32

Definition at line 2132 of file WikiPage.php.

References getDerivedDataUpdater(), getRevisionRecord(), and User\newFromIdentity().

◆ doUpdateRestrictions()

WikiPage::doUpdateRestrictions	(	array	$limit,
		array	$expiry,
		&	$cascade,
			$reason,
		User	$user,
			$tags = `null`
	)

Update the article's restriction field, and leave a log entry.

This works for protection both existing and non-existing pages.

Parameters

array	$limit	Set of restriction keys
array	$expiry	Per restriction type expiration
int	&$cascade	Set to false if cascading protection isn't allowed.
string	$reason
User	$user	The user updating the restrictions
string \| string[] \| null	$tags	Change tags to add to the pages and protection log entries ($user should be able to add the specified tags before this is called)

Returns: Status Status object; if action is taken, $status->value is the log_id of the protection log entry.

Definition at line 2162 of file WikiPage.php.

References $wgCascadingRestrictionLevels, DB_MASTER, getId(), User\getId(), getLatest(), insertProtectNullRevision(), InfoAction\invalidateCache(), loadPageData(), protectDescriptionLog(), wfGetDB(), wfMessage(), wfReadOnly(), and wfReadOnlyReason().

◆ doViewUpdates()

WikiPage::doViewUpdates	(	User	$user,
			$oldid = `0`
	)

Do standard deferred updates after page view (existing or missing page)

Parameters

User	$user	The relevant user
int	$oldid	Revision id being viewed; if not given or 0, latest revision is assumed

Definition at line 1274 of file WikiPage.php.

References User\clearNotification(), and wfReadOnly().

◆ exists()

WikiPage::exists ( )

Returns: bool Whether or not the page exists in the database

Definition at line 610 of file WikiPage.php.

References loadPageData().

Referenced by LinksDeletionUpdate\__construct(), checkFlags(), doEditContent(), getContentModel(), and shouldCheckParserCache().

◆ factory()

static WikiPage::factory ( Title $title )

static

Create a WikiPage object of the appropriate class for the given title.

Parameters

Title $title

Exceptions

MWException

Returns: WikiPage|WikiCategoryPage|WikiFilePage

Definition at line 142 of file WikiPage.php.

References $title, NS_CATEGORY, NS_FILE, and NS_MEDIA.

Referenced by MediaWiki\Permissions\PermissionManager\checkUserBlock(), and RecentChange\newForCategorization().

◆ flattenRestrictions()

static WikiPage::flattenRestrictions ( $limit )

staticprotected

Take an array of page restrictions and flatten it to a string suitable for insertion into the page_restrictions field.

Parameters

string[] $limit

Exceptions

MWException

Returns: string

Definition at line 2548 of file WikiPage.php.

◆ followRedirect()

WikiPage::followRedirect ( )

Get the Title object or URL this page redirects to.

Returns: bool|Title|string False, Title of in-wiki target, or string with URL

Reimplemented in WikiFilePage.

Definition at line 1112 of file WikiPage.php.

References getRedirectTarget(), and getRedirectURL().

◆ formatExpiry()

WikiPage::formatExpiry ( $expiry )

protected

Parameters

string $expiry 14-char timestamp or "infinity", or false if the input was invalid

Returns: string

Definition at line 2461 of file WikiPage.php.

References wfMessage().

Referenced by protectDescription(), and protectDescriptionLog().

◆ getActionOverrides()

WikiPage::getActionOverrides ( )

Todo:: Move this UI stuff somewhere else

See also: ContentHandler::getActionOverrides

Returns: array

Definition at line 277 of file WikiPage.php.

References getContentHandler().

◆ getAutoDeleteReason()

WikiPage::getAutoDeleteReason ( & $hasHistory )

Auto-generates a deletion reason.

Parameters

bool &$hasHistory Whether the page has a history

Returns: string|bool String containing deletion reason or empty string, or boolean false if no revision occurred

Definition at line 3616 of file WikiPage.php.

References getContentHandler(), and getTitle().

◆ getCategories()

WikiPage::getCategories ( )

Returns a list of categories this page is a member of.

Results will include hidden categories

Returns: TitleArray

Definition at line 3562 of file WikiPage.php.

References $dbr, $res, DB_REPLICA, getId(), TitleArray\newFromResult(), NS_CATEGORY, and wfGetDB().

◆ getComment()

WikiPage::getComment	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: string|null Comment stored for the last article revision, or null if the specified audience does not have access to the comment.

Definition at line 915 of file WikiPage.php.

References loadLastEdit().

◆ getContent()

WikiPage::getContent	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Get the content of the current revision.

No side-effects...

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to $wgUser Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: Content|null The content of the current revision

Since: 1.21

Definition at line 820 of file WikiPage.php.

References loadLastEdit().

Referenced by doDeleteArticleBatched(), doPurge(), ContentHandler\getDataForSearchIndex(), TextContentHandler\getDataForSearchIndex(), ApiParse\getParsedContent(), EditPage\getPreloadedContent(), insertRedirect(), isCountable(), and replaceSectionAtRev().

◆ getContentHandler()

WikiPage::getContentHandler ( )

Returns the ContentHandler instance to be used to deal with the content of this WikiPage.

Shorthand for ContentHandler::getForModelID( $this->getContentModel() );

Returns: ContentHandler

Since: 1.21

Definition at line 290 of file WikiPage.php.

References getContentModel().

Referenced by getActionOverrides(), getAutoDeleteReason(), replaceSectionAtRev(), shouldCheckParserCache(), and supportsSections().

◆ getContentModel()

WikiPage::getContentModel ( )

Returns the page's content model id (see the CONTENT_MODEL_XXX constants).

Will use the revisions actual content model if the page exists, and the page's default if the page doesn't exist yet.

Returns: string

Since: 1.21

Definition at line 652 of file WikiPage.php.

References $cache, $title, exists(), getRevision(), and wfWarn().

Referenced by getContentHandler().

◆ getContributors()

WikiPage::getContributors ( )

Get a list of users who have edited this article, not including the user who made the most recent revision, which you can get from $article->getUser() if you want it.

Returns: UserArrayFromResult

Definition at line 1161 of file WikiPage.php.

References $dbr, $res, DB_REPLICA, getId(), getUser(), getUserText(), User\newFromId(), User\newFromName(), and wfGetDB().

◆ getCreator()

WikiPage::getCreator	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Get the User object of the user who created the page.

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: User|null

Definition at line 877 of file WikiPage.php.

References getOldestRevision(), and User\newFromName().

◆ getDBLoadBalancer()

WikiPage::getDBLoadBalancer ( )

private

Returns: LoadBalancer

Definition at line 267 of file WikiPage.php.

Referenced by loadPageData(), newPageUpdater(), and replaceSectionContent().

◆ getDeletionUpdates()

WikiPage::getDeletionUpdates ( $rev = null )

Returns a list of updates to be performed when this page is deleted.

The updates should remove any information about this page from secondary data stores such as links tables.

Parameters

RevisionRecord | Content | null $rev The revision being deleted. Also accepts a Content object for backwards compatibility.

Returns: DeferrableUpdate[]

Definition at line 3769 of file WikiPage.php.

References $content, MediaWiki\Revision\SlotRecord\getContent(), getId(), getRevisionRecord(), getTitle(), wfDebug(), and wfDeprecated().

Referenced by doDeleteUpdates().

◆ getDerivedDataUpdater()

WikiPage::getDerivedDataUpdater	(	User	$forUser = `null`,
		RevisionRecord	$forRevision = `null`,
		RevisionSlotsUpdate	$forUpdate = `null`,
			$forEdit = `false`
	)

private

Returns a DerivedPageDataUpdater for use with the given target revision or new content.

This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls. The parameters passed to this method are used to ensure that the DerivedPageDataUpdater returned matches that caller's expectations, allowing an existing instance to be re-used if the given parameters match that instance's internal state according to DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not match the existign one.

If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always created, replacing any DerivedPageDataUpdater currently cached.

MCR migration note: this replaces WikiPage::prepareContentForEdit.

Since: 1.32

Parameters

User \| null	$forUser	The user that will be used for, or was used for, PST.
RevisionRecord \| null	$forRevision	The revision created by the edit for which to perform updates, if the edit was already saved.
RevisionSlotsUpdate \| null	$forUpdate	The new content to be saved by the edit (pre PST), if the edit was not yet saved.
bool	$forEdit	Only re-use if the cached DerivedPageDataUpdater has the current revision as the edit's parent revision. This ensures that the same DerivedPageDataUpdater cannot be re-used for two consecutive edits.

Returns: DerivedPageDataUpdater

Definition at line 1745 of file WikiPage.php.

References newDerivedDataUpdater().

Referenced by doEditUpdates(), doSecondaryDataUpdates(), newPageUpdater(), prepareContentForEdit(), and updateParserCache().

◆ getHiddenCategories()

WikiPage::getHiddenCategories ( )

Returns a list of hidden categories this page is a member of.

Uses the page_props and categorylinks tables.

Returns: array Array of Title objects

Definition at line 3585 of file WikiPage.php.

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

◆ getId()

WikiPage::getId ( )

◆ getLatest()

WikiPage::getLatest ( )

Get the page_latest field.

Returns: int The rev_id of current revision

Definition at line 714 of file WikiPage.php.

References loadPageData().

Referenced by doDeleteArticleBatched(), doUpdateRestrictions(), ApiParse\getParsedContent(), getParserOutput(), insertRedirect(), loadLastEdit(), and shouldCheckParserCache().

◆ getLinksTimestamp()

WikiPage::getLinksTimestamp ( )

Get the page_links_updated field.

Returns: string|null Containing GMT timestamp

Definition at line 703 of file WikiPage.php.

References loadPageData().

Referenced by RefreshLinksJob\isAlreadyRefreshed(), and triggerOpportunisticLinksUpdate().

◆ getMinorEdit()

WikiPage::getMinorEdit ( )

Returns true if last revision was marked as "minor edit".

Returns: bool Minor edit indicator for the last article revision.

Definition at line 929 of file WikiPage.php.

References loadLastEdit().

◆ getMutableCacheKeys()

WikiPage::getMutableCacheKeys ( WANObjectCache $cache )

Parameters

WANObjectCache $cache

Returns: string[]

Since: 1.28

Definition at line 3871 of file WikiPage.php.

References $cache, and getTitle().

◆ getOldestRevision()

WikiPage::getOldestRevision ( )

Get the Revision object of the oldest revision.

Returns: Revision|null

Definition at line 725 of file WikiPage.php.

Referenced by getCreator().

◆ getParserCache()

WikiPage::getParserCache ( )

private

Returns: ParserCache

Definition at line 260 of file WikiPage.php.

Referenced by getParserOutput(), and newDerivedDataUpdater().

◆ getParserOutput()

WikiPage::getParserOutput	(	ParserOptions	$parserOptions,
			$oldid = `null`,
			$forceParse = `false`
	)

Get a ParserOutput for the given ParserOptions and revision ID.

The parser cache will be used if possible. Cache misses that result in parser runs are debounced with PoolCounter.

XXX merge this with updateParserCache()?

Since: 1.19

Parameters

ParserOptions	$parserOptions	ParserOptions to use for the parse operation
null \| int	$oldid	Revision ID to get the text from, passing null or 0 will get the current revision (default value)
bool	$forceParse	Force reindexing, regardless of cache settings

Returns: bool|ParserOutput ParserOutput or false if the revision was not found

Definition at line 1233 of file WikiPage.php.

References getLatest(), getParserCache(), ParserOptions\getStubThreshold(), ParserOptions\isSafeToCache(), shouldCheckParserCache(), wfDebug(), and wfIncrStats().

Referenced by ApiParse\getParsedContent(), and DifferenceEngine\getParserOutput().

◆ getQueryInfo()

static WikiPage::getQueryInfo ( )

static

Return the tables, fields, and join conditions to be selected to create a new page object.

Since: 1.31

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select()

Definition at line 387 of file WikiPage.php.

References $wgContentHandlerUseDB, and $wgPageLanguageUseDB.

◆ getRedirectTarget()

WikiPage::getRedirectTarget ( )

If this page is a redirect, get its target.

The target will be fetched from the redirect table if possible. If this page doesn't have an entry there, call insertRedirect()

Returns: Title|null Title object, or null if this page is not a redirect

Reimplemented in WikiFilePage.

Definition at line 999 of file WikiPage.php.

References $dbr, DB_REPLICA, getId(), insertRedirect(), NS_FILE, NS_MEDIA, and wfGetDB().

Referenced by followRedirect(), and EditPage\getPreloadedContent().

◆ getRedirectURL()

WikiPage::getRedirectURL ( $rt )

Get the Title object or URL to use for a redirect.

We use Title objects for same-wiki, non-special redirects and URLs for everything else.

Parameters

Title $rt Redirect target

Returns: bool|Title|string False, Title object of local target, or string with URL

Definition at line 1123 of file WikiPage.php.

References $source.

Referenced by followRedirect().

◆ getRevision()

WikiPage::getRevision ( )

Get the latest revision.

Returns: Revision|null

Definition at line 787 of file WikiPage.php.

References loadLastEdit().

Referenced by PoolWorkArticleView\__construct(), doDeleteArticleBatched(), getContentModel(), ContentHandler\getParserOutputForIndexing(), getUndoContent(), and MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision().

◆ getRevisionRecord()

WikiPage::getRevisionRecord ( )

Get the latest revision.

Returns: RevisionRecord|null

Definition at line 799 of file WikiPage.php.

References loadLastEdit().

Referenced by doSecondaryDataUpdates(), RefreshLinksJob\getCurrentRevisionIfUnchanged(), getDeletionUpdates(), and updateParserCache().

◆ getRevisionRenderer()

WikiPage::getRevisionRenderer ( )

private

Returns: RevisionRenderer

Definition at line 246 of file WikiPage.php.

Referenced by newDerivedDataUpdater().

◆ getRevisionStore()

WikiPage::getRevisionStore ( )

private

Returns: RevisionStore

Definition at line 239 of file WikiPage.php.

Referenced by commitRollback(), isBatchedDelete(), newDerivedDataUpdater(), and newPageUpdater().

◆ getSlotRoleRegistry()

WikiPage::getSlotRoleRegistry ( )

private

Returns: SlotRoleRegistry

Definition at line 253 of file WikiPage.php.

Referenced by newDerivedDataUpdater(), and newPageUpdater().

◆ getSourceURL()

WikiPage::getSourceURL ( )

Get the source URL for the content on this page, typically the canonical URL, but may be a remote link if the content comes from another site.

Since: 1.28

Returns: string

Reimplemented in WikiFilePage.

Definition at line 3862 of file WikiPage.php.

References getTitle().

◆ getTimestamp()

WikiPage::getTimestamp ( )

Returns: string MW timestamp of last article revision

Definition at line 831 of file WikiPage.php.

References loadLastEdit(), and wfTimestamp().

◆ getTitle()

WikiPage::getTitle ( )

Get the title object of the article.

Returns: Title Title object of this page

Definition at line 298 of file WikiPage.php.

References $mTitle.

Referenced by LinksDeletionUpdate\__construct(), PoolWorkArticleView\__construct(), RefreshLinksJob\getCurrentRevisionIfUnchanged(), TextContentHandler\getDataForSearchIndex(), FileContentHandler\getDataForSearchIndex(), WikitextContentHandler\getDataForSearchIndex(), ApiParse\getParsedContent(), WikiCategoryPage\isExpectedUnusedCategory(), WikiCategoryPage\isHidden(), ApiParse\makeParserOptions(), Article\newFromWikiPage(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), MediaWiki\Storage\PageEditStash\parseAndCache(), and RequestContext\setWikiPage().

◆ getTouched()

WikiPage::getTouched ( )

Get the page_touched field.

Returns: string Containing GMT timestamp

Definition at line 692 of file WikiPage.php.

References loadPageData().

Referenced by RefreshLinksJob\getParserOutputFromCache(), and triggerOpportunisticLinksUpdate().

◆ getUndoContent()

WikiPage::getUndoContent	(	Revision	$undo,
		Revision	$undoafter
	)

Get the content that needs to be saved in order to undo all revisions between $undo and $undoafter.

Revisions must belong to the same page, must exist and must not be deleted

Parameters

Revision	$undo
Revision	$undoafter	Must be an earlier revision than $undo

Returns: Content|bool Content on success, false on failure

Since: 1.21 Before we had the Content object, this was done in getUndoText

Definition at line 1556 of file WikiPage.php.

References Revision\getContentHandler(), and getRevision().

◆ getUser()

WikiPage::getUser	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: int User ID for the user that made the last article revision

Definition at line 858 of file WikiPage.php.

References loadLastEdit().

◆ getUserText()

WikiPage::getUserText	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: string Username of the user that made the last article revision

Definition at line 896 of file WikiPage.php.

References loadLastEdit().

Referenced by getContributors().

◆ getWikiDisplayName()

WikiPage::getWikiDisplayName ( )

The display name for the site this content come from.

If a subclass overrides isLocal(), this could return something other than the current site name

Since: 1.28

Returns: string

Reimplemented in WikiFilePage.

Definition at line 3849 of file WikiPage.php.

References $wgSitename.

◆ hasDifferencesOutsideMainSlot()

static WikiPage::hasDifferencesOutsideMainSlot	(	Revision	$a,
		Revision	$b
	)

static

Helper method for checking whether two revisions have differences that go beyond the main slot.

MCR migration note: this method should go away!

Deprecated:: Use only as a stop-gap before refactoring to support MCR.

Parameters

Revision	$a
Revision	$b

Returns: bool

Definition at line 1537 of file WikiPage.php.

References Revision\getRevisionRecord().

◆ hasViewableContent()

WikiPage::hasViewableContent ( )

Check if this page is something we're going to be showing some sort of sensible content for.

If we return false, page views (plain action=view) will return an HTTP 404 response, so spiders and robots can know they're following a bad link.

Returns: bool

Reimplemented in WikiCategoryPage.

Definition at line 625 of file WikiPage.php.

◆ insertOn()

WikiPage::insertOn	(	$dbw,
		$pageId = `null`
	)

Insert a new empty page record for this article.

This must be followed up by creating a revision and running $this->updateRevisionOn( ... ); or else the record will be left in a funky state. Best if all done inside a transaction.

Todo:: Factor out into a PageStore service, to be used by PageUpdater.

Parameters

IDatabase	$dbw
int \| null	$pageId	Custom page ID that will be used for the insert statement

Returns: bool|int The newly created page_id key; false if the row was not inserted, e.g. because the title already existed or because the specified page ID is already in use.

Definition at line 1339 of file WikiPage.php.

References wfRandom().

Referenced by MediaWiki\Storage\PageUpdater\doCreate().

◆ insertProtectNullRevision()

WikiPage::insertProtectNullRevision	(		$revCommentMsg,
		array	$limit,
		array	$expiry,
			$cascade,
			$reason,
			$user = `null`
	)

Insert a new null revision for this page.

Parameters

string	$revCommentMsg	Comment message key for the revision
array	$limit	Set of restriction keys
array	$expiry	Per restriction type expiration
int	$cascade	Set to false if cascading protection isn't allowed.
string	$reason
User \| null	$user

Returns: Revision|null Null on error

Definition at line 2418 of file WikiPage.php.

References DB_MASTER, getId(), Revision\newNullRevision(), protectDescription(), updateRevisionOn(), wfGetDB(), and wfMessage().

Referenced by doUpdateRestrictions().

◆ insertRedirect()

WikiPage::insertRedirect ( )

Insert an entry for this page into the redirect table if the content is a redirect.

The database update will be deferred via DeferredUpdates

Don't call this function directly unless you know what you're doing.

Returns: Title|null Title object or null if not a redirect

Definition at line 1046 of file WikiPage.php.

References $content, DB_MASTER, getContent(), getLatest(), insertRedirectEntry(), and wfGetDB().

Referenced by getRedirectTarget().

◆ insertRedirectEntry()

WikiPage::insertRedirectEntry	(	Title	$rt,
			$oldLatest = `null`
	)

Insert or update the redirect table entry for this page to indicate it redirects to $rt.

Parameters

Title	$rt	Redirect target
int \| null	$oldLatest	Prior page_latest for check and set

Returns: bool Success

Definition at line 1072 of file WikiPage.php.

References $success, DB_MASTER, Title\getDBkey(), Title\getFragment(), getId(), Title\getInterwiki(), Title\getNamespace(), lockAndGetLatest(), and wfGetDB().

Referenced by insertRedirect(), and updateRedirectOn().

◆ isBatchedDelete()

WikiPage::isBatchedDelete ( $safetyMargin = 0 )

Determines if deletion of this page would be batched (executed over time by the job queue) or not (completed in the same request as the delete call).

It is unlikely but possible that an edit from another request could push the page over the batching threshold after this function is called, but before the caller acts upon the return value. Callers must decide for themselves how to deal with this. $safetyMargin is provided as an unreliable but situationally useful help for some common cases.

Parameters

int $safetyMargin Added to the revision count when checking for batching

Returns: bool True if deletion would be batched, false otherwise

Definition at line 2575 of file WikiPage.php.

References $dbr, $wgDeleteRevisionsBatchSize, DB_REPLICA, getId(), getRevisionStore(), and wfGetDB().

◆ isCountable()

WikiPage::isCountable ( $editInfo = false )

Determine whether a page would be suitable for being counted as an article in the site_stats table based on the title & its content.

Parameters

PreparedEdit | bool $editInfo (false): object returned by prepareTextForEdit(), if false, the current database state will be used

Returns: bool

Definition at line 946 of file WikiPage.php.

References $content, $wgArticleCountMethod, DB_REPLICA, getContent(), getId(), and wfGetDB().

Referenced by doDeleteUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision().

◆ isLocal()

WikiPage::isLocal ( )

Whether this content displayed on this page comes from the local database.

Since: 1.28

Returns: bool

Reimplemented in WikiFilePage.

Definition at line 3836 of file WikiPage.php.

◆ isRedirect()

WikiPage::isRedirect ( )

Tests if the article content represents a redirect.

Returns: bool

Reimplemented in WikiFilePage.

Definition at line 634 of file WikiPage.php.

References loadPageData().

Referenced by EditPage\getPreloadedContent(), and MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision().

◆ loadFromRow()

WikiPage::loadFromRow	(	$data,
		$from
	)

Load the object from a database row.

Since: 1.20

Parameters

object \| bool	$data	DB row containing fields returned by selectFields() or false
string \| int	$from	One of the following: "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB "forupdate" or WikiPage::READ_LOCKING if the data comes from the master DB using SELECT FOR UPDATE

Definition at line 560 of file WikiPage.php.

References clearCacheFields(), wfTimestamp(), and wfTimestampOrNull().

Referenced by doDeleteUpdates(), and loadPageData().

◆ loadLastEdit()

WikiPage::loadLastEdit ( )

protected

Loads everything except the text This isn't necessary for all uses, so it's only done if needed.

Definition at line 738 of file WikiPage.php.

References $dbr, DB_REPLICA, getId(), getLatest(), getTitle(), Revision\newFromPageId(), Revision\newKnownCurrent(), IDBAccessObject\READ_LOCKING, setLastEdit(), and wfGetDB().

Referenced by getComment(), getContent(), getMinorEdit(), getRevision(), getRevisionRecord(), getTimestamp(), getUser(), and getUserText().

◆ loadPageData()

WikiPage::loadPageData ( $from = 'fromdb' )

Load the object from a given source by title.

Parameters

object | string | int

$from

One of the following:

A DB query result object.
"fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
"fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
"forupdate" or WikiPage::READ_LOCKING to get from the master DB using SELECT FOR UPDATE.

Returns: void

Definition at line 489 of file WikiPage.php.

References DB_REPLICA, getDBLoadBalancer(), loadFromRow(), and pageDataFromTitle().

Referenced by checkTouched(), doDeleteArticleBatched(), doUpdateRestrictions(), exists(), getId(), getLatest(), getLinksTimestamp(), getTouched(), MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision(), and isRedirect().

◆ lockAndGetLatest()

WikiPage::lockAndGetLatest ( )

Lock the page row for this title+id and return page_latest (or 0)

Returns: int Returns 0 if no row was found with this title+id

Since: 1.27

Definition at line 2988 of file WikiPage.php.

References DB_MASTER, getId(), getTitle(), and wfGetDB().

Referenced by doDeleteArticleBatched(), MediaWiki\Storage\PageUpdater\doModify(), and insertRedirectEntry().

◆ makeParserOptions()

WikiPage::makeParserOptions ( $context )

Get parser options suitable for rendering the primary article wikitext.

See also: ParserOptions::newCanonical

Parameters

IContextSource | User | string

$context

One of the following:

IContextSource: Use the User and the Language of the provided context
User: Use the provided User object and $wgLang for the language, so use an IContextSource object if possible.
'canonical': Canonical options (anonymous user with default preferences and content language).

Returns: ParserOptions

Definition at line 1961 of file WikiPage.php.

References $context, and getTitle().

Referenced by CategoryMembershipChangeJob\getCategoriesAtRev(), RefreshLinksJob\getParserOutput(), DifferenceEngine\getParserOutput(), ContentHandler\getParserOutputForIndexing(), RefreshLinksJob\getParserOutputFromCache(), and ApiParse\makeParserOptions().

◆ newDerivedDataUpdater()

WikiPage::newDerivedDataUpdater ( )

private

Returns: DerivedPageDataUpdater

Definition at line 1696 of file WikiPage.php.

References $derivedDataUpdater, $wgArticleCountMethod, $wgRCWatchCategoryMembership, getParserCache(), getRevisionRenderer(), getRevisionStore(), getSlotRoleRegistry(), MediaWiki\Storage\DerivedPageDataUpdater\setArticleCountMethod(), MediaWiki\Storage\DerivedPageDataUpdater\setLogger(), and MediaWiki\Storage\DerivedPageDataUpdater\setRcWatchCategoryMembership().

Referenced by getDerivedDataUpdater().

◆ newFromID()

static WikiPage::newFromID	(	$id,
		$from = `'fromdb'`
	)

static

Constructor from a page id.

Parameters

int	$id	Article ID to load
string \| int	$from	One of the following values: "fromdb" or WikiPage::READ_NORMAL to select from a replica DB "fromdbmaster" or WikiPage::READ_LATEST to select from the master database

Returns: WikiPage|null

Definition at line 180 of file WikiPage.php.

References DB_MASTER, DB_REPLICA, and wfGetDB().

◆ newFromRow()

static WikiPage::newFromRow	(	$row,
		$from = `'fromdb'`
	)

static

Constructor from a database row.

Since: 1.20

Parameters

object	$row	Database row containing at least fields returned by selectFields().
string \| int	$from	Source of $data: "fromdb" or WikiPage::READ_NORMAL: from a replica DB "fromdbmaster" or WikiPage::READ_LATEST: from the master DB "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE

Returns: WikiPage

Definition at line 210 of file WikiPage.php.

◆ newPageUpdater()

WikiPage::newPageUpdater	(	User	$user,
		RevisionSlotsUpdate	$forUpdate = `null`
	)

Returns a PageUpdater for creating new revisions on this page (or creating the page).

The PageUpdater can also be used to detect the need for edit conflict resolution, and to protected such conflict resolution from concurrent edits using a check-and-set mechanism.

Since: 1.32

Parameters

User	$user
RevisionSlotsUpdate \| null	$forUpdate	If given, allows any cached ParserOutput that may already have been returned via getDerivedDataUpdater to be re-used.

Returns: PageUpdater

Definition at line 1801 of file WikiPage.php.

References $wgAjaxEditStash, $wgPageCreationLog, $wgUseAutomaticEditSummaries, getDBLoadBalancer(), getDerivedDataUpdater(), getRevisionStore(), and getSlotRoleRegistry().

Referenced by commitRollback(), and doEditContent().

◆ onArticleCreate()

static WikiPage::onArticleCreate ( Title $title )

static

The onArticle*() functions are supposed to be a kind of hooks which should be called whenever any of the specified actions are done.

This is a good place to put code to clear caches, for instance.

This is called on page move and undelete, as well as edit

Parameters

Title $title

Definition at line 3392 of file WikiPage.php.

References $job, $title, HTMLCacheUpdateJob\newForBacklinks(), and NS_CATEGORY.

◆ onArticleDelete()

static WikiPage::onArticleDelete ( Title $title )

static

Clears caches when article is deleted.

Parameters

Title $title

Definition at line 3428 of file WikiPage.php.

References $job, $title, HTMLFileCache\clearFileCache(), BacklinkCache\get(), InfoAction\invalidateCache(), HTMLCacheUpdateJob\newForBacklinks(), User\newFromName(), NS_FILE, NS_MEDIAWIKI, and NS_USER_TALK.

◆ onArticleEdit()

static WikiPage::onArticleEdit	(	Title	$title,
		Revision	$revision = `null`,
			$slotsChanged = `null`
	)

static

Purge caches on page update etc.

Parameters

Title	$title
Revision \| null	$revision	Revision that was just saved, may be null
string[] \| null	$slotsChanged	The role names of the slots that were changed. If not given, all slots are assumed to have changed.

Definition at line 3485 of file WikiPage.php.

References $title, HTMLFileCache\clearFileCache(), InfoAction\invalidateCache(), and HTMLCacheUpdateJob\newForBacklinks().

◆ pageData()

WikiPage::pageData	(	$dbr,
		$conditions,
		$options = `[]`
	)

protected

Fetch a page record with the given conditions.

Parameters

IDatabase	$dbr
array	$conditions
array	$options

Returns: object|bool Database result resource, or false on failure

Definition at line 426 of file WikiPage.php.

References $dbr.

Referenced by pageDataFromId(), and pageDataFromTitle().

◆ pageDataFromId()

WikiPage::pageDataFromId	(	$dbr,
		$id,
		$options = `[]`
	)

Fetch a page record matching the requested ID.

Parameters

IDatabase	$dbr
int	$id
array	$options

Returns: object|bool Database result resource, or false on failure

Definition at line 473 of file WikiPage.php.

References $dbr, and pageData().

◆ pageDataFromTitle()

WikiPage::pageDataFromTitle	(	$dbr,
		$title,
		$options = `[]`
	)

Fetch a page record matching the Title object's namespace and title using a sanitized title string.

Parameters

IDatabase	$dbr
Title	$title
array	$options

Returns: object|bool Database result resource, or false on failure

Definition at line 459 of file WikiPage.php.

References $dbr, $title, and pageData().

Referenced by loadPageData().

◆ prepareContentForEdit()

WikiPage::prepareContentForEdit	(	Content	$content,
			$revision = `null`,
		User	$user = `null`,
			$serialFormat = `null`,
			$useCache = `true`
	)

Prepare content which is about to be saved.

Prior to 1.30, this returned a stdClass.

Deprecated:: since 1.32, use getDerivedDataUpdater instead.

Parameters

Content	$content
Revision \| RevisionRecord \| null	$revision	Revision object. Used with vary-revision or vary-revision-id.
User \| null	$user
string \| null	$serialFormat	IGNORED
bool	$useCache	Check shared prepared edit cache

Returns: PreparedEdit

Since: 1.21

Definition at line 1991 of file WikiPage.php.

References $content, and getDerivedDataUpdater().

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

◆ protectDescription()

WikiPage::protectDescription	(	array	$limit,
		array	$expiry
	)

Builds the description to serve as comment for the edit.

Parameters

array	$limit	Set of restriction keys
array	$expiry	Per restriction type expiration

Returns: string

Definition at line 2483 of file WikiPage.php.

References formatExpiry(), and wfMessage().

Referenced by insertProtectNullRevision().

◆ protectDescriptionLog()

WikiPage::protectDescriptionLog	(	array	$limit,
		array	$expiry
	)

Builds the description to serve as comment for the log entry.

Some bots may parse IRC lines, which are generated from log entries which contain plain protect description text. Keep them in old format to avoid breaking compatibility. TODO: Fix protection log to store structured description and format it on-the-fly.

Parameters

array	$limit	Set of restriction keys
array	$expiry	Per restriction type expiration

Returns: string

Definition at line 2525 of file WikiPage.php.

References formatExpiry().

Referenced by doUpdateRestrictions().

◆ purgeInterwikiCheckKey()

static WikiPage::purgeInterwikiCheckKey ( Title $title )

staticprivate

#-

Purge the check key for cross-wiki cache entries referencing this page

Parameters

Title $title

Definition at line 3534 of file WikiPage.php.

References $cache, $title, and $wgEnableScaryTranscluding.

◆ replaceSectionAtRev()

WikiPage::replaceSectionAtRev	(		$sectionId,
		Content	$sectionContent,
			$sectionTitle = `''`,
			$baseRevId = `null`
	)

Parameters

string \| int \| null \| bool	$sectionId	Section identifier as a number or string (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page or 'new' for a new section.
Content	$sectionContent	New content of the section.
string	$sectionTitle	New section's subject, only if $section is "new".
int \| null	$baseRevId

Exceptions

MWException

Returns: Content|null New complete article content, or null if error.

Since: 1.24

Definition at line 1635 of file WikiPage.php.

References getContent(), getContentHandler(), getId(), Revision\newFromId(), supportsSections(), and wfDebug().

Referenced by replaceSectionContent().

◆ replaceSectionContent()

WikiPage::replaceSectionContent	(		$sectionId,
		Content	$sectionContent,
			$sectionTitle = `''`,
			$edittime = `null`
	)

Parameters

string \| int \| null \| bool	$sectionId	Section identifier as a number or string (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page or 'new' for a new section.
Content	$sectionContent	New content of the section.
string	$sectionTitle	New section's subject, only if $section is "new".
string	$edittime	Revision timestamp or null to use the current revision.

Exceptions

MWException

Returns: Content|null New complete article content, or null if error.

Since: 1.21

Deprecated:: since 1.24, use replaceSectionAtRev instead

Definition at line 1596 of file WikiPage.php.

References $dbr, DB_MASTER, DB_REPLICA, getDBLoadBalancer(), Revision\loadFromTimestamp(), and replaceSectionAtRev().

◆ selectFields()

static WikiPage::selectFields ( )

static

Return the list of revision fields that should be selected to create a new page.

Deprecated:: since 1.31, use self::getQueryInfo() instead.

Returns: array

Definition at line 348 of file WikiPage.php.

References $wgContentHandlerUseDB, $wgPageLanguageUseDB, and wfDeprecated().

◆ setLastEdit()

WikiPage::setLastEdit ( Revision $revision )

protected

Set the latest revision.

Parameters

Revision $revision

Definition at line 778 of file WikiPage.php.

References Revision\getTimestamp().

Referenced by doEditContent(), loadLastEdit(), and updateRevisionOn().

◆ setTimestamp()

WikiPage::setTimestamp ( $ts )

Set the page timestamp (use only to avoid DB queries)

Parameters

string $ts MW timestamp of last article revision

Returns: void

Definition at line 845 of file WikiPage.php.

References wfTimestamp().

◆ shouldCheckParserCache()

WikiPage::shouldCheckParserCache	(	ParserOptions	$parserOptions,
			$oldId
	)

Should the parser cache be used?

Parameters

ParserOptions	$parserOptions	ParserOptions to check
int	$oldId

Returns: bool

Definition at line 1211 of file WikiPage.php.

References exists(), getContentHandler(), getLatest(), and ParserOptions\getStubThreshold().

Referenced by getParserOutput().

◆ supportsSections()

WikiPage::supportsSections ( )

Returns true if this page's content model supports sections.

Returns: bool

Todo:

The skin should check this and not offer section functionality if sections are not supported.

The EditPage should check this and not offer section functionality if sections are not supported.

Definition at line 1578 of file WikiPage.php.

References getContentHandler().

Referenced by replaceSectionAtRev().

◆ triggerOpportunisticLinksUpdate()

WikiPage::triggerOpportunisticLinksUpdate ( ParserOutput $parserOutput )

Opportunistically enqueue link update jobs given fresh parser output if useful.

Parameters

ParserOutput $parserOutput Current version page output

Since: 1.25

Definition at line 3715 of file WikiPage.php.

References $cache, CacheTime\getCacheExpiry(), CacheTime\getCacheTime(), getId(), getLinksTimestamp(), getTouched(), ParserOutput\hasDynamicContent(), RefreshLinksJob\newDynamic(), RefreshLinksJob\newPrioritized(), and wfReadOnly().

◆ updateCategoryCounts()

WikiPage::updateCategoryCounts	(	array	$added,
		array	$deleted,
			$id = `0`
	)

Update all the appropriate counts in the category table, given that we've added the categories $added and deleted the categories $deleted.

This should only be called from deferred updates or jobs to avoid contention.

Parameters

array	$added	The names of categories that were added
array	$deleted	The names of categories that were deleted
int	$id	Page ID (this should be the original deleted page ID)

Definition at line 3630 of file WikiPage.php.

References $type, DB_MASTER, getId(), getTitle(), and wfGetDB().

◆ updateIfNewerOn()

WikiPage::updateIfNewerOn	(	$dbw,
		$revision
	)

If the given revision is newer than the currently set page_latest, update the page record.

Otherwise, do nothing.

Deprecated:: since 1.24, use updateRevisionOn instead

Parameters

IDatabase	$dbw
Revision	$revision

Returns: bool

Definition at line 1499 of file WikiPage.php.

References getId(), updateRevisionOn(), and wfTimestamp().

◆ updateParserCache()

WikiPage::updateParserCache ( array $options = [] )

Update the parser cache.

Note: This is a temporary workaround until there is a proper data updater class. It will become deprecated soon.

Parameters

array

$options

causeAction: an arbitrary string identifying the reason for the update. See DataUpdate::getCauseAction(). (default 'edit-page')
causeAgent: name of the user who caused the update (string, defaults to the user who created the revision)

Since: 1.32

Definition at line 2088 of file WikiPage.php.

References getDerivedDataUpdater(), getRevisionRecord(), and User\newFromIdentity().

◆ updateRedirectOn()

WikiPage::updateRedirectOn	(	$dbw,
		$redirectTitle,
		$lastRevIsRedirect = `null`
	)

Add row to the redirect table if this is a redirect, remove otherwise.

Parameters

IDatabase	$dbw
Title \| null	$redirectTitle	Title object pointing to the redirect target, or NULL if this is not a redirect
null \| bool	$lastRevIsRedirect	If given, will optimize adding and removing rows in redirect table.

Returns: bool True on success, false on failure

Access:\n private

Definition at line 1463 of file WikiPage.php.

References $success, getId(), getTitle(), insertRedirectEntry(), and NS_FILE.

Referenced by updateRevisionOn().

◆ updateRevisionOn()

WikiPage::updateRevisionOn	(	$dbw,
		$revision,
		$lastRevision = `null`,
		$lastRevIsRedirect = `null`
	)

Update the page record to point to a newly saved revision.

Todo:: Factor out into a PageStore service, or move into PageUpdater.

Parameters

IDatabase	$dbw
Revision	$revision	For ID number, and text used to set length and redirect status fields
int \| null	$lastRevision	If given, will not overwrite the page field when different from the currently set value. Giving 0 indicates the new page flag should be set on.
bool \| null	$lastRevIsRedirect	If given, will optimize adding and removing rows in redirect table.

Returns: bool Success; false if the page row was missing or page_latest changed

Definition at line 1384 of file WikiPage.php.

References $content, $wgContentHandlerUseDB, getId(), setLastEdit(), and updateRedirectOn().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), insertProtectNullRevision(), and updateIfNewerOn().

◆ wasLoadedFrom()

WikiPage::wasLoadedFrom ( $from )

Checks whether the page data was loaded using the given database access mode (or better).

Since: 1.32

Parameters

string | int

$from

One of the following:

"fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
"fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
"forupdate" or WikiPage::READ_LOCKING to get from the master DB using SELECT FOR UPDATE.

Returns: bool

Definition at line 534 of file WikiPage.php.

Member Data Documentation

◆ $derivedDataUpdater

DerivedPageDataUpdater null WikiPage::$derivedDataUpdater = null

private

Definition at line 116 of file WikiPage.php.

Referenced by newDerivedDataUpdater().

◆ $mDataLoaded

bool WikiPage::$mDataLoaded = false

Access:\n protected

Definition at line 59 of file WikiPage.php.

◆ $mDataLoadedFrom

int WikiPage::$mDataLoadedFrom = self::READ_NONE

protected

One of the READ_* constants.

Definition at line 86 of file WikiPage.php.

◆ $mId

int WikiPage::$mId = null

protected

Definition at line 81 of file WikiPage.php.

◆ $mIsRedirect

bool WikiPage::$mIsRedirect = false

Access:\n protected

Definition at line 65 of file WikiPage.php.

◆ $mLastRevision

Revision WikiPage::$mLastRevision = null

protected

Definition at line 96 of file WikiPage.php.

◆ $mLatest

int false WikiPage::$mLatest = false

False means "not loaded".

Access:\n protected

Definition at line 71 of file WikiPage.php.

◆ $mLinksUpdated

string WikiPage::$mLinksUpdated = '19700101000000'

protected

Definition at line 111 of file WikiPage.php.

◆ $mPreparedEdit

PreparedEdit false WikiPage::$mPreparedEdit = false

Map of cache fields (text, parser output, ect) for a proposed/new edit.

Definition at line 76 of file WikiPage.php.

◆ $mRedirectTarget

Title WikiPage::$mRedirectTarget = null

protected

Definition at line 91 of file WikiPage.php.

Referenced by WikiFilePage\getRedirectTarget().

◆ $mTimestamp

string WikiPage::$mTimestamp = ''

protected

Timestamp of the current revision or empty string if not loaded.

Definition at line 101 of file WikiPage.php.

◆ $mTitle

Title WikiPage::$mTitle = null

Definition at line 53 of file WikiPage.php.

Referenced by WikiFilePage\getForeignCategories().

◆ $mTouched

string WikiPage::$mTouched = '19700101000000'

protected

Definition at line 106 of file WikiPage.php.

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

includes/page/WikiPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ archiveRevisions()

◆ checkFlags()

◆ checkTouched()

◆ clear()

◆ clearCacheFields()

◆ clearPreparedEdit()

◆ commitRollback()

◆ convertSelectType()

◆ doDeleteArticle()

◆ doDeleteArticleBatched()

◆ doDeleteArticleReal()

◆ doDeleteUpdates()

◆ doEditContent()

◆ doEditUpdates()

◆ doPurge()

◆ doRollback()

◆ doSecondaryDataUpdates()

◆ doUpdateRestrictions()

◆ doViewUpdates()

◆ exists()

◆ factory()

◆ flattenRestrictions()

◆ followRedirect()

◆ formatExpiry()

◆ getActionOverrides()

◆ getAutoDeleteReason()

◆ getCategories()

◆ getComment()

◆ getContent()

◆ getContentHandler()

◆ getContentModel()

◆ getContributors()

◆ getCreator()

◆ getDBLoadBalancer()

◆ getDeletionUpdates()

◆ getDerivedDataUpdater()

◆ getHiddenCategories()

◆ getId()

◆ getLatest()

◆ getLinksTimestamp()

◆ getMinorEdit()

◆ getMutableCacheKeys()

◆ getOldestRevision()

◆ getParserCache()

◆ getParserOutput()

◆ getQueryInfo()

◆ getRedirectTarget()

◆ getRedirectURL()

◆ getRevision()

◆ getRevisionRecord()

◆ getRevisionRenderer()

◆ getRevisionStore()

◆ getSlotRoleRegistry()

◆ getSourceURL()

◆ getTimestamp()

◆ getTitle()

◆ getTouched()

◆ getUndoContent()

◆ getUser()

◆ getUserText()

◆ getWikiDisplayName()

◆ hasDifferencesOutsideMainSlot()

◆ hasViewableContent()

◆ insertOn()

◆ insertProtectNullRevision()

◆ insertRedirect()