Represents a title within MediaWiki. More...

Inheritance diagram for Title:

Collaboration diagram for Title:

[legend]

Public Attributes
const	CACHE_MAX = 1000
	Title::newFromText maintains a cache to avoid expensive re-normalization of commonly used titles.

const	GAID_FOR_UPDATE = 1
	Used to be GAID_FOR_UPDATE define.

Static Private Attributes
static MapCacheLRU	$titleCache = null

Private member variables
Please use the accessor functions instead. Access:\n private
string	$mTextform = ''
	Text form (spaces not underscores) of the main part.

string	$mUrlform = ''
	URL-encoded form of the main part.

string	$mDbkeyform = ''
	Main part with underscores.

int	$mNamespace = NS_MAIN
	Namespace index, i.e.

string	$mInterwiki = ''
	Interwiki prefix.

string	$mFragment = ''
	Title fragment (i.e.

int	$mArticleID = -1
	Article ID, fetched from the link cache on demand.

array	$mRestrictions = []
	Array of groups allowed to edit this article.

bool	$mCascadeRestriction
	Cascade restrictions on this page to included templates and images?

	$mCascadingRestrictions
	Caching the results of getCascadeProtectionSources.

array	$mCascadeSources
	Where are the cascading restrictions coming from on this page?

bool	$mRestrictionsLoaded = false
	Boolean for initialisation on demand.

string	$prefixedText = null
	Text form including namespace/interwiki, initialised on demand.

mixed	$mTitleProtection
	Cached value for getTitleProtection (create protection)

int	$mDefaultNamespace = NS_MAIN
	Namespace index when there is no namespace.

null	$mRedirect = null
	Is the article at this title a redirect?

string	$mUserCaseDBKey
	Database key with the initial letter in the case specified by the user.

bool int	$mLatestID = false
	ID of most recent revision.

string bool	$mOldRestrictions = false
	Comma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows.

array	$mRestrictionsExpiry = []
	When do the restrictions on this page expire?

bool	$mHasCascadingRestrictions
	Are cascading restrictions in effect on this page?

int	$mLength = -1
	The page length, 0 for special pages.

bool	$mLocalInterwiki = false
	Was this Title created from a string with a local interwiki prefix?

bool string	$mContentModel = false
	ID of the page's content model, i.e.

bool	$mForcedContentModel = false
	If a content model was forced via setContentModel() this will be true to avoid having other code paths reset it.

int	$mEstimateRevisions
	Estimated number of revisions; null of not loaded.

array	$mNotificationTimestamp = []
	Associative array of user ID -> timestamp/false.

bool	$mHasSubpages
	Whether a page has any subpages.

bool	$mPageLanguage = false
	The (string) language code of the page's language and content code.

string bool null	$mDbPageLanguage = false
	The page language code from the database, null if not saved in the database or false if not loaded, yet.

TitleValue	$mTitleValue = null
	A corresponding TitleValue object.

bool	$mIsBigDeletion = null
	Would deleting this page be a big deletion?

static	getTitleFormatter ()
	B/C kludge: provide a TitleParser for use by Title.

static	getInterwikiLookup ()
	B/C kludge: provide an InterwikiLookup for use by Title.

static	getTitleCache ()

static	fixUrlQueryArgs ( $query, $query2=false)
	Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional second argument named variant.

	__construct ()

	loadFromRow ( $row)
	Load Title object fields from a DB row.

	isValid ()
	Returns true if the title is valid, false if it is invalid.

	isLocal ()
	Determine whether the object refers to a page within this project (either this wiki or a wiki with a local interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )

	isExternal ()
	Is this Title interwiki?

	getInterwiki ()
	Get the interwiki prefix.

	wasLocalInterwiki ()
	Was this a local interwiki link?

	isTrans ()
	Determine whether the object refers to a page within this project and is transcludable.

	getTransWikiID ()
	Returns the DB name of the distant wiki which owns the object.

	getTitleValue ()
	Get a TitleValue object representing this Title.

	getText ()
	Get the text form (spaces not underscores) of the main part.

	getPartialURL ()
	Get the URL-encoded form of the main part.

	getDBkey ()
	Get the main part with underscores.

	getUserCaseDBKey ()
	Get the DB key with the initial letter case as specified by the user.

	getNamespace ()
	Get the namespace index, i.e.

	getContentModel ( $flags=0)
	Get the page's content model id, see the CONTENT_MODEL_XXX constants.

	hasContentModel ( $id)
	Convenience method for checking a title's content model name.

	setContentModel ( $model)
	Set a proposed content model for the page for permissions checking.

	getNsText ()
	Get the namespace text.

	getSubjectNsText ()
	Get the namespace text of the subject (rather than talk) page.

	getTalkNsText ()
	Get the namespace text of the talk page.

	canTalk ()
	Can this title have a corresponding talk page?

	canHaveTalkPage ()
	Can this title have a corresponding talk page?

	canExist ()
	Is this in a namespace that allows actual pages?

	isWatchable ()
	Can this title be added to a user's watchlist?

	isSpecialPage ()
	Returns true if this is a special page.

	isSpecial ( $name)
	Returns true if this title resolves to the named special page.

	fixSpecialName ()
	If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary.

	inNamespace ( $ns)
	Returns true if the title is inside the specified namespace.

	inNamespaces ()
	Returns true if the title is inside one of the specified namespaces.

	hasSubjectNamespace ( $ns)
	Returns true if the title has the same subject namespace as the namespace specified.

	isContentPage ()
	Is this Title in a namespace which contains content? In other words, is this a content page, for the purposes of calculating statistics, etc?

	isMovable ()
	Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable.

	isMainPage ()
	Is this the mainpage?

	isSubpage ()
	Is this a subpage?

	isConversionTable ()
	Is this a conversion table for the LanguageConverter?

	isWikitextPage ()
	Does that page contain wikitext, or it is JS, CSS or whatever?

	isSiteConfigPage ()
	Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI.

	isCssOrJsPage ()

	isUserConfigPage ()
	Is this a "config" (.css, .json, or .js) sub-page of a user page?

	isCssJsSubpage ()

	getSkinFromConfigSubpage ()
	Trim down a .css, .json, or .js subpage title to get the corresponding skin name.

	getSkinFromCssJsSubpage ()

	isUserCssConfigPage ()
	Is this a CSS "config" sub-page of a user page?

	isCssSubpage ()

	isUserJsonConfigPage ()
	Is this a JSON "config" sub-page of a user page?

	isUserJsConfigPage ()
	Is this a JS "config" sub-page of a user page?

	isJsSubpage ()

	isSiteCssConfigPage ()
	Is this a sitewide CSS "config" page?

	isSiteJsonConfigPage ()
	Is this a sitewide JSON "config" page?

	isSiteJsConfigPage ()
	Is this a sitewide JS "config" page?

	isRawHtmlMessage ()
	Is this a message which can contain raw HTML?

	isTalkPage ()
	Is this a talk page of some sort?

	getTalkPage ()
	Get a Title object associated with the talk page of this article.

	getTalkPageIfDefined ()
	Get a Title object associated with the talk page of this article, if such a talk page can exist.

	getSubjectPage ()
	Get a title object associated with the subject page of this talk page.

	getOtherPage ()
	Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page.

	getDefaultNamespace ()
	Get the default namespace index, for when there is no namespace.

	getFragment ()
	Get the Title fragment (i.e.

	hasFragment ()
	Check if a Title fragment is set.

	getFragmentForURL ()
	Get the fragment in URL form, including the "#" character if there is one.

	setFragment ( $fragment)
	Set the fragment for this title.

	createFragmentTarget ( $fragment)
	Creates a new Title for a different fragment of the same page.

	getPrefixedDBkey ()
	Get the prefixed database key form.

	getPrefixedText ()
	Get the prefixed title with spaces.

	__toString ()
	Return a string representation of this title.

	getFullText ()
	Get the prefixed title with spaces, plus any fragment (part beginning with '#')

	getRootText ()
	Get the root page name text without a namespace, i.e.

	getRootTitle ()
	Get the root page name title, i.e.

	getBaseText ()
	Get the base page name without a namespace, i.e.

	getBaseTitle ()
	Get the base page name title, i.e.

	getSubpageText ()
	Get the lowest-level subpage name, i.e.

	getSubpage ( $text)
	Get the title for a subpage of the current page.

	getSubpageUrlForm ()
	Get a URL-encoded form of the subpage text.

	getPrefixedURL ()
	Get a URL-encoded title (not an actual URL) including interwiki.

	getFullURL ( $query='', $query2=false, $proto=PROTO_RELATIVE)
	Get a real URL referring to this title, with interwiki link and fragment.

	getFullUrlForRedirect ( $query='', $proto=PROTO_CURRENT)
	Get a url appropriate for making redirects based on an untrusted url arg.

	getLocalURL ( $query='', $query2=false)
	Get a URL with no fragment or server name (relative URL) from a Title object.

	getLinkURL ( $query='', $query2=false, $proto=false)
	Get a URL that's the simplest URL that will be valid to link, locally, to the current Title.

	getInternalURL ( $query='', $query2=false)
	Get the URL form for an internal link.

	getCanonicalURL ( $query='', $query2=false)
	Get the URL for a canonical link, for use in things like IRC and e-mail notifications.

	getEditURL ()
	Get the edit URL for this Title.

	quickUserCan ( $action, $user=null)
	Can $user perform $action on this page? This skips potentially expensive cascading permission checks as well as avoids expensive error formatting.

	userCan ( $action, $user=null, $rigor='secure')
	Can $user perform $action on this page?

	getUserPermissionsErrors ( $action, $user, $rigor='secure', $ignoreErrors=[])
	Can $user perform $action on this page?

	getRestrictionTypes ()
	Returns restriction types for the current Title.

	getTitleProtection ()
	Is this title subject to title protection? Title protection is the one applied against creation of such title.

	deleteTitleProtection ()
	Remove any title protection due to page existing.

	isSemiProtected ( $action='edit')
	Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?

	isProtected ( $action='')
	Does the title correspond to a protected article?

	isNamespaceProtected (User $user)
	Determines if $user is unable to edit this page because it has been protected by $wgNamespaceProtection.

	isCascadeProtected ()
	Cascading protection: Return true if cascading restrictions apply to this page, false if not.

	areCascadeProtectionSourcesLoaded ( $getPages=true)
	Determines whether cascading protection sources have already been loaded from the database.

	getCascadeProtectionSources ( $getPages=true)
	Cascading protection: Get the source of any cascading restrictions on this page.

	areRestrictionsLoaded ()
	Accessor for mRestrictionsLoaded.

	getRestrictions ( $action)
	Accessor/initialisation for mRestrictions.

	getAllRestrictions ()
	Accessor/initialisation for mRestrictions.

	getRestrictionExpiry ( $action)
	Get the expiry time for the restriction against a given action.

	areRestrictionsCascading ()
	Returns cascading restrictions for the current article.

	loadRestrictionsFromRows ( $rows, $oldFashionedRestrictions=null)
	Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page.

	loadRestrictions ( $oldFashionedRestrictions=null)
	Load restrictions from the page_restrictions table.

	flushRestrictions ()
	Flush the protection cache in this object and force reload from the database.

	hasSubpages ()
	Does this have subpages? (Warning, usually requires an extra DB query.)

	getSubpages ( $limit=-1)
	Get all subpages of this page.

	isDeleted ()
	Is there a version of this page in the deletion archive?

	isDeletedQuick ()
	Is there a version of this page in the deletion archive?

	getArticleID ( $flags=0)
	Get the article ID for this Title from the link cache, adding it if necessary.

	isRedirect ( $flags=0)
	Is this an article that is a redirect page? Uses link cache, adding it if necessary.

	getLength ( $flags=0)
	What is the length of this page? Uses link cache, adding it if necessary.

	getLatestRevID ( $flags=0)
	What is the page_latest field for this page?

	resetArticleID ( $newid)
	This clears some fields in this object, and clears any associated keys in the "bad links" section of the link cache.

	getLinksTo ( $options=[], $table='pagelinks', $prefix='pl')
	Get an array of Title objects linking to this Title Also stores the IDs in the link cache.

	getTemplateLinksTo ( $options=[])
	Get an array of Title objects using this Title as a template Also stores the IDs in the link cache.

	getLinksFrom ( $options=[], $table='pagelinks', $prefix='pl')
	Get an array of Title objects linked from this Title Also stores the IDs in the link cache.

	getTemplateLinksFrom ( $options=[])
	Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache.

	getBrokenLinksFrom ()
	Get an array of Title objects referring to non-existent articles linked from this page.

	getCdnUrls ()
	Get a list of URLs to purge from the CDN cache when this page changes.

	getSquidURLs ()

	purgeSquid ()
	Purge all applicable CDN URLs.

	isValidMoveOperation (&$nt, $auth=true, $reason='')
	Check whether a given move operation would be valid.

	moveTo (&$nt, $auth=true, $reason='', $createRedirect=true, array $changeTags=[])
	Move a title to a new location.

	moveSubpages ( $nt, $auth=true, $reason='', $createRedirect=true, array $changeTags=[])
	Move this page's subpages to be subpages of $nt.

	isSingleRevRedirect ()
	Checks if this page is just a one-rev redirect.

	isValidMoveTarget ( $nt)
	Checks if $this can be moved to a given Title.

	getParentCategories ()
	Get categories to which this Title belongs and return an array of categories' names.

	getParentCategoryTree ( $children=[])
	Get a tree of parent categories.

	pageCond ()
	Get an associative array for selecting this title from the "page" table.

	getPreviousRevisionID ( $revId, $flags=0)
	Get the revision ID of the previous revision.

	getNextRevisionID ( $revId, $flags=0)
	Get the revision ID of the next revision.

	getFirstRevision ( $flags=0)
	Get the first revision of the page.

	getEarliestRevTime ( $flags=0)
	Get the oldest revision timestamp of this page.

	isNewPage ()
	Check if this is a new page.

	isBigDeletion ()
	Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.

	estimateRevisionCount ()
	Get the approximate revision count of this page.

	countRevisionsBetween ( $old, $new, $max=null)
	Get the number of revisions between the given revision.

	getAuthorsBetween ( $old, $new, $limit, $options=[])
	Get the authors between the given revisions or revision IDs.

	countAuthorsBetween ( $old, $new, $limit, $options=[])
	Get the number of authors between the given revisions or revision IDs.

	equals (Title $title)
	Compare with another title.

	isSubpageOf (Title $title)
	Check if this title is a subpage of another title.

	exists ( $flags=0)
	Check if page exists.

	isAlwaysKnown ()
	Should links to this title be shown as potentially viewable (i.e.

	isKnown ()
	Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).

	hasSourceText ()
	Does this page have source text?

	getDefaultMessageText ()
	Get the default (plain) message contents for an page that overrides an interface message key.

	invalidateCache ( $purgeTime=null)
	Updates page_touched for this page; called from LinksUpdate.php.

	touchLinks ()
	Update page_touched timestamps and send CDN purge messages for pages linking to this title.

	getTouched ( $db=null)
	Get the last touched timestamp.

	getNotificationTimestamp ( $user=null)
	Get the timestamp when this page was updated since the user last saw it.

	getNamespaceKey ( $prepend='nstab-')
	Generate strings used for xml 'id' names in monobook tabs.

	getRedirectsHere ( $ns=null)
	Get all extant redirects to this Title.

	isValidRedirectTarget ()
	Check if this Title is a valid redirect target.

	getBacklinkCache ()
	Get a backlink cache object.

	canUseNoindex ()
	Whether the magic words INDEX and NOINDEX function for this page.

	getCategorySortkey ( $prefix='')
	Returns the raw sort key to be used for categories, with the specified prefix.

	getPageLanguage ()
	Get the language in which the content of this page is written in wikitext.

	getPageViewLanguage ()
	Get the language in which the content of this page is written when viewed by user.

	getEditNotices ( $oldid=0)
	Get a list of rendered edit notices for this page.

	__sleep ()

	__wakeup ()
	Text form (spaces not underscores) of the main part.

static	newFromDBkey ( $key)
	Create a new Title from a prefixed DB key.

static	newFromTitleValue (TitleValue $titleValue)
	Create a new Title from a TitleValue.

static	newFromLinkTarget (LinkTarget $linkTarget)
	Create a new Title from a LinkTarget.

static	newFromText ( $text, $defaultNamespace=NS_MAIN)
	Create a new Title from text, such as what one would find in a link.

static	newFromTextThrow ( $text, $defaultNamespace=NS_MAIN)
	Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.

static	newFromURL ( $url)
	THIS IS NOT THE FUNCTION YOU WANT.

static	newFromID ( $id, $flags=0)
	Create a new Title from an article ID.

static	newFromIDs ( $ids)
	Make an array of titles from an array of IDs.

static	newFromRow ( $row)
	Make a Title object from a DB row.

static	makeTitle ( $ns, $title, $fragment='', $interwiki='')
	Create a new Title from a namespace index and a DB key.

static	makeTitleSafe ( $ns, $title, $fragment='', $interwiki='')
	Create a new Title from a namespace index and a DB key.

static	newMainPage ()
	Create a new Title for the Main Page.

static	nameOf ( $id)
	Get the prefixed DB key associated with an ID.

static	legalChars ()
	Get a regex character class describing the legal characters in a link.

static	convertByteClassToUnicodeClass ( $byteClass)
	Utility method for converting a character sequence from bytes to Unicode.

static	makeName ( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
	Make a prefixed DB key from a DB key and a namespace index.

static	escapeFragmentForURL ( $fragment)
	Escape a text fragment, say from a link, for a URL.

static	compare (LinkTarget $a, LinkTarget $b)
	Callback for usort() to do title sorts by (namespace, title)

static	getFilteredRestrictionTypes ( $exists=true)
	Get a filtered list of all restriction types supported by this wiki.

static	purgeExpiredRestrictions ()
	Purge expired restrictions from the page_restrictions table.

static	clearCaches ()
	Text form (spaces not underscores) of the main part.

static	capitalize ( $text, $ns=NS_MAIN)
	Capitalize a text string for a title if it belongs to a namespace that capitalizes.

static	getSelectFields ()
	Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries.

	prefix ( $name)
	Prefix some arbitrary text with the namespace or interwiki prefix of this object.

	checkQuickPermissions ( $action, $user, $errors, $rigor, $short)
	Permissions checks that fail most often, and which are easiest to test.

	resultToError ( $errors, $result)
	Add the resulting error code to the errors array.

	checkPermissionHooks ( $action, $user, $errors, $rigor, $short)
	Check various permission hooks.

	checkSpecialsAndNSPermissions ( $action, $user, $errors, $rigor, $short)
	Check permissions on special pages & namespaces.

	checkSiteConfigPermissions ( $action, $user, $errors, $rigor, $short)
	Check sitewide CSS/JSON/JS permissions.

	checkUserConfigPermissions ( $action, $user, $errors, $rigor, $short)
	Check CSS/JSON/JS sub-page permissions.

	checkPageRestrictions ( $action, $user, $errors, $rigor, $short)
	Check against page_restrictions table requirements on this page.

	checkCascadingSourcesRestrictions ( $action, $user, $errors, $rigor, $short)
	Check restrictions on cascading pages.

	checkActionPermissions ( $action, $user, $errors, $rigor, $short)
	Check action permissions not already checked in checkQuickPermissions.

	checkUserBlock ( $action, $user, $errors, $rigor, $short)
	Check that the user isn't blocked from editing.

	checkReadPermissions ( $action, $user, $errors, $rigor, $short)
	Check that the user is allowed to read this page.

	missingPermissionError ( $action, $short)
	Get a description array when the user doesn't have the right to perform $action (i.e.

	secureAndSplit ()
	Secure and split - main initialisation function for this object.

	getRelativeRevisionID ( $revId, $flags, $dir)
	Get next/previous revision ID relative to another revision ID.

	getDbPageLanguageCode ()
	Returns the page language code saved in the database, if $wgPageLanguageUseDB is set to true in LocalSettings.php, otherwise returns false.

	getUserPermissionsErrorsInternal ( $action, $user, $rigor='secure', $short=false)
	Can $user perform $action on this page? This is an internal function, with multiple levels of checks depending on performance needs; see $rigor below.

	getTitleProtectionInternal ()
	Fetch title protection settings.

	validateFileMoveOperation ( $nt)
	Check if the requested move target is a valid file move target.

Additional Inherited Members

Detailed Description

Represents a title within MediaWiki.

Optionally may contain an interwiki designation or namespace.

Note: This class can fetch various kinds of data from the database; however, it does so inefficiently.; Consider using a TitleValue object instead. TitleValue is more lightweight and does not rely on global state or the database.

Definition at line 39 of file Title.php.

Constructor & Destructor Documentation

◆ __construct()

Title::__construct ( )

Access:\n protected

Definition at line 210 of file Title.php.

Member Function Documentation

◆ __sleep()

Title::__sleep ( )

Returns: array

Definition at line 5272 of file Title.php.

◆ __toString()

Title::__toString ( )

Return a string representation of this title.

Returns: string Representation of this title

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1712 of file Title.php.

References getPrefixedText().

◆ __wakeup()

Title::__wakeup ( )

Text form (spaces not underscores) of the main part.

Definition at line 5284 of file Title.php.

References wfUrlencode().

◆ areCascadeProtectionSourcesLoaded()

Title::areCascadeProtectionSourcesLoaded ( $getPages = true )

Determines whether cascading protection sources have already been loaded from the database.

Parameters

bool $getPages True to check if the pages are loaded, or false to check if the status is loaded.

Returns: bool Whether or not the specified information has been loaded

Since: 1.23

Definition at line 3106 of file Title.php.

◆ areRestrictionsCascading()

Title::areRestrictionsCascading ( )

Returns cascading restrictions for the current article.

Returns: bool

Definition at line 3262 of file Title.php.

References loadRestrictions().

◆ areRestrictionsLoaded()

Title::areRestrictionsLoaded ( )

Accessor for mRestrictionsLoaded.

Returns: bool Whether or not the page's restrictions have already been loaded from the database

Since: 1.23

Definition at line 3209 of file Title.php.

◆ canExist()

Title::canExist ( )

Is this in a namespace that allows actual pages?

Returns: bool

Definition at line 1099 of file Title.php.

References NS_MAIN.

◆ canHaveTalkPage()

Title::canHaveTalkPage ( )

Can this title have a corresponding talk page?

See also: MWNamespace::hasTalkNamespace

Since: 1.30

Returns: bool True if this title either is a talk page or can have a talk page associated.

Definition at line 1090 of file Title.php.

Referenced by canTalk(), getOtherPage(), and getTalkPageIfDefined().

◆ canTalk()

Title::canTalk ( )

Can this title have a corresponding talk page?

Deprecated:: since 1.30, use canHaveTalkPage() instead.

Returns: bool True if this title either is a talk page or can have a talk page associated.

Definition at line 1078 of file Title.php.

References canHaveTalkPage().

◆ canUseNoindex()

Title::canUseNoindex ( )

Whether the magic words INDEX and NOINDEX function for this page.

Returns: bool

Definition at line 5051 of file Title.php.

References $wgExemptFromUserRobotsControl.

◆ capitalize()

static Title::capitalize	(	$text,
		$ns = `NS_MAIN`
	)

static

Capitalize a text string for a title if it belongs to a namespace that capitalizes.

Parameters

string	$text	Containing title to capitalize
int	$ns	Namespace index, defaults to NS_MAIN

Returns: string Containing capitalized title

Definition at line 3724 of file Title.php.

◆ checkActionPermissions()

Title::checkActionPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check action permissions not already checked in checkQuickPermissions.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2597 of file Title.php.

References $user, $wgDeleteRevisionsLimit, $wgLang, checkCascadingSourcesRestrictions(), checkPageRestrictions(), exists(), getNsText(), getTitleProtection(), getUserPermissionsErrorsInternal(), isBigDeletion(), isMovable(), userCan(), and User\whoIs().

◆ checkCascadingSourcesRestrictions()

Title::checkCascadingSourcesRestrictions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check restrictions on cascading pages.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2550 of file Title.php.

References $user, as, getCascadeProtectionSources(), isUserConfigPage(), and list.

Referenced by checkActionPermissions().

◆ checkPageRestrictions()

Title::checkPageRestrictions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check against page_restrictions table requirements on this page.

The user must possess all required rights for this action.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2516 of file Title.php.

References $user, as, and getRestrictions().

Referenced by checkActionPermissions().

◆ checkPermissionHooks()

Title::checkPermissionHooks	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check various permission hooks.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2338 of file Title.php.

References $user, and resultToError().

◆ checkQuickPermissions()

Title::checkQuickPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Permissions checks that fail most often, and which are easiest to test.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2237 of file Title.php.

References $user, User\groupHasPermission(), isTalkPage(), missingPermissionError(), NS_CATEGORY, NS_FILE, and NS_USER.

◆ checkReadPermissions()

Title::checkReadPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check that the user is allowed to read this page.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2719 of file Title.php.

References $name, $user, $wgWhitelistRead, $wgWhitelistReadRegexp, as, getPrefixedDBkey(), getPrefixedText(), User\isEveryoneAllowed(), isSpecial(), isSpecialPage(), list, missingPermissionError(), and NS_MAIN.

◆ checkSiteConfigPermissions()

Title::checkSiteConfigPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check sitewide CSS/JSON/JS permissions.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2404 of file Title.php.

References $user, isRawHtmlMessage(), isSiteCssConfigPage(), isSiteJsConfigPage(), isSiteJsonConfigPage(), and wfMessage().

◆ checkSpecialsAndNSPermissions()

Title::checkSpecialsAndNSPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check permissions on special pages & namespaces.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2375 of file Title.php.

References $user, getNsText(), isNamespaceProtected(), isSpecialPage(), NS_MAIN, NS_MEDIAWIKI, and wfMessage().

◆ checkUserBlock()

Title::checkUserBlock	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check that the user isn't blocked from editing.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2674 of file Title.php.

References $user, $wgBlockDisablesLogin, and $wgEmailConfirmToEdit.

◆ checkUserConfigPermissions()

Title::checkUserConfigPermissions	(	$action,
		$user,
		$errors,
		$rigor,
		$short
	)

private

Check CSS/JSON/JS sub-page permissions.

Parameters

string	$action	The action to check
User	$user	User to check
array	$errors	List of current errors
string	$rigor	Same format as Title::getUserPermissionsErrors()
bool	$short	Short circuit on first error

Returns: array List of errors

Definition at line 2449 of file Title.php.

References $user, isUserCssConfigPage(), isUserJsConfigPage(), and isUserJsonConfigPage().

◆ clearCaches()

static Title::clearCaches ( )

static

Text form (spaces not underscores) of the main part.

Definition at line 3709 of file Title.php.

References MapCacheLRU\clear().

◆ compare()

static Title::compare	(	LinkTarget	$a,
		LinkTarget	$b
	)

static

Callback for usort() to do title sorts by (namespace, title)

Parameters

LinkTarget	$a
LinkTarget	$b

Returns: int Result of string comparison, or namespace comparison

Definition at line 795 of file Title.php.

References MediaWiki\Linker\LinkTarget\getNamespace(), and MediaWiki\Linker\LinkTarget\getText().

◆ convertByteClassToUnicodeClass()

static Title::convertByteClassToUnicodeClass ( $byteClass )

static

Utility method for converting a character sequence from bytes to Unicode.

Primary usecase being converting $wgLegalTitleChars to a sequence usable in javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.

Parameters

string $byteClass

Returns: string

Definition at line 648 of file Title.php.

References $out.

◆ countAuthorsBetween()

Title::countAuthorsBetween	(	$old,
		$new,
		$limit,
		$options = `[]`
	)

Get the number of authors between the given revisions or revision IDs.

Used for diffs and other things that really need it.

Parameters

int \| Revision	$old	Old revision or rev ID (first before range by default)
int \| Revision	$new	New revision or rev ID (first after range by default)
int	$limit	Maximum number of authors
string \| array	$options	(Optional): Single option, or an array of options: 'include_old' Include $old in the range; $new is excluded. 'include_new' Include $new in the range; $old is excluded. 'include_both' Include both $old and $new in the range. Unknown option values are ignored.

Returns: int Number of revision authors in the range; zero if not both revisions exist

Definition at line 4637 of file Title.php.

References $options, and getAuthorsBetween().

◆ countRevisionsBetween()

Title::countRevisionsBetween	(	$old,
		$new,
		$max = `null`
	)

Get the number of revisions between the given revision.

Used for diffs and other things that really need it.

Parameters

int \| Revision	$old	Old revision or rev ID (first before range)
int \| Revision	$new	New revision or rev ID (first after range)
int \| null	$max	Limit of Revisions to count, will be incremented to detect truncations

Returns: int Number of revisions between these revisions.

Definition at line 4519 of file Title.php.

References $dbr, DB_REPLICA, getArticleID(), Revision\newFromTitle(), and wfGetDB().

◆ createFragmentTarget()

Title::createFragmentTarget ( $fragment )

Creates a new Title for a different fragment of the same page.

Since: 1.27

Parameters

string $fragment

Returns: Title

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1644 of file Title.php.

References getText().

◆ deleteTitleProtection()

Title::deleteTitleProtection ( )

Remove any title protection due to page existing.

Definition at line 2996 of file Title.php.

References DB_MASTER, and wfGetDB().

◆ equals()

Title::equals ( Title $title )

Compare with another title.

Parameters

Title $title

Returns: bool

Definition at line 4648 of file Title.php.

References $title.

Referenced by getLocalURL(), isMainPage(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\Revision\RenderedRevision\setRevisionInternal().

◆ escapeFragmentForURL()

static Title::escapeFragmentForURL ( $fragment )

static

Escape a text fragment, say from a link, for a URL.

Deprecated:: since 1.30, use Sanitizer::escapeIdForLink() or escapeIdForExternalInterwiki()

Parameters

string $fragment Containing a URL or link fragment (after the "#")

Returns: string Escaped string

Definition at line 778 of file Title.php.

References wfDeprecated().

◆ estimateRevisionCount()

Title::estimateRevisionCount ( )

Get the approximate revision count of this page.

Returns: int

Definition at line 4496 of file Title.php.

References $dbr, DB_REPLICA, exists(), getArticleID(), and wfGetDB().

◆ exists()

Title::exists ( $flags = 0 )

Check if page exists.

For historical reasons, this function simply checks for the existence of the title in the page table, and will thus return false for interwiki links, special pages and the like. If you want to know if a title can be meaningfully viewed, you should probably call the isKnown() method instead.

Parameters

int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check from master/for update

Returns: bool

Definition at line 4678 of file Title.php.

References getArticleID().

Referenced by checkActionPermissions(), estimateRevisionCount(), getRestrictionTypes(), getTitleProtectionInternal(), SpecialUpload\getUploadForm(), hasSourceText(), isAlwaysKnown(), and isKnown().

◆ fixSpecialName()

Title::fixSpecialName ( )

If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary.

Otherwise, return $this

Returns: Title

Definition at line 1145 of file Title.php.

References isSpecialPage(), list, and NS_SPECIAL.

◆ fixUrlQueryArgs()

static Title::fixUrlQueryArgs	(	$query,
		$query2 = `false`
	)

staticprivate

Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional second argument named variant.

This was deprecated in favor of passing an array of option with a "variant" key Once $query2 is removed for good, this helper can be dropped and the wfArrayToCgi moved to getLocalURL();

Since: 1.19 (r105919)

Parameters

array \| string	$query
string \| string[] \| bool	$query2

Returns: string

Definition at line 1877 of file Title.php.

References $query, wfArrayToCgi(), and wfDeprecated().

◆ flushRestrictions()

Title::flushRestrictions ( )

Flush the protection cache in this object and force reload from the database.

This is used when updating protection from WikiPage::doUpdateRestrictions().

Definition at line 3409 of file Title.php.

◆ getAllRestrictions()

Title::getAllRestrictions ( )

Accessor/initialisation for mRestrictions.

Returns: array Keys are actions, values are arrays as returned by Title::getRestrictions()

Since: 1.23

Definition at line 3236 of file Title.php.

References loadRestrictions().

◆ getArticleID()

Title::getArticleID ( $flags = 0 )

Get the article ID for this Title from the link cache, adding it if necessary.

Parameters

int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update

Returns: int The ID

Definition at line 3566 of file Title.php.

Referenced by MergeHistoryPager\__construct(), countRevisionsBetween(), estimateRevisionCount(), exists(), getAuthorsBetween(), getBrokenLinksFrom(), getContentModel(), getFirstRevision(), getLatestRevID(), getLength(), getLinksFrom(), MediaWiki\Tests\Revision\RevisionRendererTest\getMockTitle(), getParentCategories(), getRelativeRevisionID(), isBigDeletion(), isRedirect(), loadRestrictions(), loadRestrictionsFromRows(), NamespaceDupes\mergePage(), and RecentChange\newForCategorization().

◆ getAuthorsBetween()

Title::getAuthorsBetween	(	$old,
		$new,
		$limit,
		$options = `[]`
	)

Get the authors between the given revisions or revision IDs.

Used for diffs and other things that really need it.

Since: 1.23

Parameters

int \| Revision	$old	Old revision or rev ID (first before range by default)
int \| Revision	$new	New revision or rev ID (first after range by default)
int	$limit	Maximum number of authors
string \| array	$options	(Optional): Single option, or an array of options: 'include_old' Include $old in the range; $new is excluded. 'include_new' Include $new in the range; $old is excluded. 'include_both' Include both $old and $new in the range. Unknown option values are ignored.

Returns: array|null Names of revision authors in the range; null if not both revisions exist

Definition at line 4562 of file Title.php.

References $dbr, $options, $revQuery, array(), DB_REPLICA, getArticleID(), Revision\getQueryInfo(), Revision\newFromTitle(), Revision\RAW, and wfGetDB().

Referenced by countAuthorsBetween().

◆ getBacklinkCache()

Title::getBacklinkCache ( )

Get a backlink cache object.

Returns: BacklinkCache

Definition at line 5042 of file Title.php.

References BacklinkCache\get().

◆ getBaseText()

Title::getBaseText ( )

Get the base page name without a namespace, i.e.

the part before the subpage name

Example:: Title::newFromText('User:Foo/Bar/Baz')->getBaseText();

# returns: 'Foo/Bar'

Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:280

Returns: string Base name

Definition at line 1777 of file Title.php.

References getText().

Referenced by getBaseTitle().

◆ getBaseTitle()

Title::getBaseTitle ( )

Get the base page name title, i.e.

the part before the subpage name

Example:: Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();

# returns: Title{User:Foo/Bar}

Returns: Title Base title

Since: 1.20

Definition at line 1802 of file Title.php.

References getBaseText().

◆ getBrokenLinksFrom()

Title::getBrokenLinksFrom ( )

Get an array of Title objects referring to non-existent articles linked from this page.

Todo:: check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case).

Returns: Title[] Array of Title the Title objects

Definition at line 3909 of file Title.php.

References $dbr, $res, as, DB_REPLICA, getArticleID(), and wfGetDB().

◆ getCanonicalURL()

Title::getCanonicalURL	(	$query = `''`,
		$query2 = `false`
	)

Get the URL for a canonical link, for use in things like IRC and e-mail notifications.

Uses $wgCanonicalServer and the GetCanonicalURL hook.

NOTE: Unlike getInternalURL(), the canonical URL includes the fragment

See also: self::getLocalURL for the arguments.

Parameters

string	$query
string \| bool	$query2

Returns: string The URL

Since: 1.18

Definition at line 2132 of file Title.php.

References $query, getFragmentForURL(), getLocalURL(), PROTO_CANONICAL, and wfExpandUrl().

◆ getCascadeProtectionSources()

Title::getCascadeProtectionSources ( $getPages = true )

Cascading protection: Get the source of any cascading restrictions on this page.

Parameters

bool $getPages Whether or not to retrieve the actual pages that the restrictions have come from and the actual restrictions themselves.

Returns: array Two elements: First is an array of Title objects of the pages from which cascading restrictions have come, false for none, or true if such restrictions exist but $getPages was not set. Second is an array like that returned by Title::getAllRestrictions(), or an empty array if $getPages is false.

Definition at line 3123 of file Title.php.

References $dbr, $res, $tables, as, DB_REPLICA, NS_FILE, wfGetDB(), and wfTimestampNow().

Referenced by checkCascadingSourcesRestrictions(), and isCascadeProtected().

◆ getCategorySortkey()

Title::getCategorySortkey ( $prefix = '' )

Returns the raw sort key to be used for categories, with the specified prefix.

This will be fed to Collation::getSortKey() to get a binary sortkey that can be used for actual sorting.

Parameters

string $prefix The prefix to be used, specified using {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no prefix.

Returns: string

Definition at line 5071 of file Title.php.

References getText().

Referenced by CategoryViewer\doCategoryQuery().

◆ getCdnUrls()

Title::getCdnUrls ( )

Get a list of URLs to purge from the CDN cache when this page changes.

Returns: string[] Array of String the URLs

Definition at line 3945 of file Title.php.

References $urls, as, getInternalURL(), getPageLanguage(), isUserCssConfigPage(), isUserJsConfigPage(), and isUserJsonConfigPage().

Referenced by getSquidURLs(), HTMLCacheUpdateJob\invalidateTitles(), MediaWiki\performAction(), and purgeSquid().

◆ getContentModel()

Title::getContentModel ( $flags = 0 )

Get the page's content model id, see the CONTENT_MODEL_XXX constants.

Parameters

int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update

Returns: string Content model id

Definition at line 984 of file Title.php.

References article, getArticleID(), and in.

Referenced by MediaWiki\EditPage\TextConflictHelper\__construct(), SpecialChangeContentModel\getOptionsForTitle(), hasContentModel(), loadFromRow(), and makeTitle().

◆ getDBkey()

Title::getDBkey ( )

Get the main part with underscores.

Returns: string Main part of the title, with underscores

Implements MediaWiki\Linker\LinkTarget.

Definition at line 951 of file Title.php.

Referenced by ArchivedFile\__construct(), CategoryViewer\addFragmentToTitle(), LinksUpdateTest\assertRecentChangeByCategorization(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), CategoryViewer\getSubcategorySortChar(), WikiPage\insertRedirectEntry(), isRawHtmlMessage(), LogPager\limitTitle(), PageArchive\listPagesByPrefix(), PageArchive\listPagesBySearch(), RecentChange\newForCategorization(), ForeignAPIFile\newFromTitle(), RefreshLinks\refreshCategory(), SpecialWhatLinksHere\showIndirectLinks(), LanguageConverter\updateConversionTable(), and MessageCache\updateMessageOverride().

◆ getDbPageLanguageCode()

Title::getDbPageLanguageCode ( )

private

Returns the page language code saved in the database, if $wgPageLanguageUseDB is set to true in LocalSettings.php, otherwise returns false.

If there is no language saved in the db, it will return NULL.

Returns: string|null|bool

Definition at line 5097 of file Title.php.

References $wgPageLanguageUseDB.

Referenced by getPageLanguage(), and getPageViewLanguage().

◆ getDefaultMessageText()

Title::getDefaultMessageText ( )

Get the default (plain) message contents for an page that overrides an interface message key.

Primary use cases:

Article:
- Show default when viewing the page. The Article::getSubstituteContent method displays the default message content, instead of the 'noarticletext' placeholder message normally used.
EditPage:
- Title of edit page. When creating an interface message override, the editor is told they are "Editing the page", instead of "Creating the page". (EditPage::setHeaders)
- Edit notice. The 'translateinterface' edit notice is shown when creating or editing a an interface message override. (EditPage::showIntro)
- Opening the editor. The contents of the localisation message are used as contents of the editor when creating a new page in the MediaWiki namespace. This simplifies the process for editors when "changing" an interface message by creating an override. (EditPage::getContentObject)
- Showing a diff. The left-hand side of a diff when an editor is previewing their changes before saving the creation of a page in the MediaWiki namespace. (EditPage::showDiff)
- Disallowing a save. When attempting to create a a MediaWiki-namespace page with the proposed content matching the interface message default, the save is rejected, the same way we disallow blank pages from being created. (EditPage::internalAttemptSave)
ApiEditPage:
- Default content, when using the 'prepend' or 'append' feature.
SkinTemplate:
- Label the create action as "Edit", if the page can be an override.

Returns: string|bool

Definition at line 4821 of file Title.php.

References $lang, $name, getText(), list, NS_MEDIAWIKI, and wfMessage().

◆ getDefaultNamespace()

Title::getDefaultNamespace ( )

Get the default namespace index, for when there is no namespace.

Returns: int Default namespace index

Definition at line 1576 of file Title.php.

◆ getEarliestRevTime()

Title::getEarliestRevTime ( $flags = 0 )

Get the oldest revision timestamp of this page.

Parameters

int $flags Title::GAID_FOR_UPDATE

Returns: string MW timestamp

Definition at line 4447 of file Title.php.

References $rev, and getFirstRevision().

◆ getEditNotices()

Title::getEditNotices ( $oldid = 0 )

Get a list of rendered edit notices for this page.

Array is keyed by the original message key, and values are rendered using parseAsBlock, so they will already be wrapped in paragraphs.

Since: 1.21

Parameters

int $oldid Revision ID that's being edited

Returns: array

Definition at line 5201 of file Title.php.

References $html, and wfMessage().

◆ getEditURL()

Title::getEditURL ( )

Get the edit URL for this Title.

Returns: string The URL, or a null string if this is an interwiki link

Definition at line 2146 of file Title.php.

References $s, getLocalURL(), and isExternal().

◆ getFilteredRestrictionTypes()

static Title::getFilteredRestrictionTypes ( $exists = true )

static

Get a filtered list of all restriction types supported by this wiki.

Parameters

bool $exists True to get all restriction types that apply to titles that do exist, False for all restriction types that apply to titles that do not exist

Returns: array

Definition at line 2881 of file Title.php.

References $wgRestrictionTypes.

◆ getFirstRevision()

Title::getFirstRevision ( $flags = 0 )

Get the first revision of the page.

Parameters

int $flags Title::GAID_FOR_UPDATE

Returns: Revision|null If page doesn't exist

Definition at line 4420 of file Title.php.

References $revQuery, DB_MASTER, DB_REPLICA, getArticleID(), Revision\getQueryInfo(), and wfGetDB().

Referenced by getEarliestRevTime().

◆ getFragment()

Title::getFragment ( )

Get the Title fragment (i.e.

\ the bit after the #) in text form

Use Title::hasFragment to check for a fragment

Returns: string Title fragment

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1587 of file Title.php.

Referenced by WikiPage\insertRedirectEntry().

◆ getFragmentForURL()

Title::getFragmentForURL ( )

Get the fragment in URL form, including the "#" character if there is one.

Returns: string Fragment in URL form

Definition at line 1606 of file Title.php.

References hasFragment(), and isExternal().

Referenced by getCanonicalURL(), getFullURL(), and getLinkURL().

◆ getFullText()

Title::getFullText ( )

Get the prefixed title with spaces, plus any fragment (part beginning with '#')

Returns: string The prefixed title, with spaces and the fragment, including '#'

Definition at line 1722 of file Title.php.

References getPrefixedText(), and hasFragment().

Referenced by getParentCategories(), WikitextContentHandler\makeRedirectContent(), and WikitextContent\updateRedirect().

◆ getFullURL()

Title::getFullURL	(	$query = `''`,
		$query2 = `false`,
		$proto = `PROTO_RELATIVE`
	)

Get a real URL referring to this title, with interwiki link and fragment.

See also: self::getLocalURL for the arguments.; wfExpandUrl

Parameters

string \| string[]	$query
string \| string[] \| bool	$query2
string \| int \| null	$proto	Protocol type to use in URL

Returns: string The URL

Definition at line 1915 of file Title.php.

References $query, getFragmentForURL(), getLocalURL(), and wfExpandUrl().

Referenced by getLinkURL(), CssContentHandler\makeRedirectContent(), and JavaScriptContentHandler\makeRedirectContent().

◆ getFullUrlForRedirect()

Title::getFullUrlForRedirect	(	$query = `''`,
		$proto = `PROTO_CURRENT`
	)

Get a url appropriate for making redirects based on an untrusted url arg.

This is basically the same as getFullUrl(), but in the case of external interwikis, we send the user to a landing page, to prevent possible phishing attacks and the like.

Note: Uses current protocol by default, since technically relative urls aren't allowed in redirects per HTTP spec, so this is not suitable for places where the url gets cached, as might pollute between https and non-https users.

See also: self::getLocalURL for the arguments.

Parameters

array \| string	$query
string	$proto	Protocol type to use in URL

Returns: string A url suitable to use in an HTTP location header.

Definition at line 1950 of file Title.php.

References $query, getPrefixedDBkey(), and isExternal().

◆ getInternalURL()

Title::getInternalURL	(	$query = `''`,
		$query2 = `false`
	)

Get the URL form for an internal link.

Used in various CDN-related code, in case we have a different internal hostname for the server from the exposed one.

This uses $wgInternalServer to qualify the path, or $wgServer if $wgInternalServer is not set. If the server variable used is protocol-relative, the URL will be expanded to http://

See also: self::getLocalURL for the arguments.

Parameters

string	$query
string \| bool	$query2

Returns: string The URL

Definition at line 2108 of file Title.php.

References $query, $wgInternalServer, $wgServer, getLocalURL(), PROTO_HTTP, and wfExpandUrl().

Referenced by getCdnUrls().

◆ getInterwiki()

Title::getInterwiki ( )

Get the interwiki prefix.

Use Title::isExternal to check if a interwiki is set

Returns: string Interwiki prefix

Implements MediaWiki\Linker\LinkTarget.

Definition at line 861 of file Title.php.

Referenced by WikiPage\insertRedirectEntry(), and WikitextContentHandler\makeRedirectContent().

◆ getInterwikiLookup()

static Title::getInterwikiLookup ( )

staticprivate

B/C kludge: provide an InterwikiLookup for use by Title.

Ideally, Title would have no methods that need this. Avoid usage of this singleton by using TitleValue and the associated services when possible.

Returns: InterwikiLookup

Definition at line 203 of file Title.php.

◆ getLatestRevID()

Title::getLatestRevID ( $flags = 0 )

What is the page_latest field for this page?

Parameters

int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update

Returns: int Int or 0 if the page doesn't exist

Definition at line 3655 of file Title.php.

References article, getArticleID(), and in.

Referenced by RefreshLinksJob\runForTitle().

◆ getLength()

Title::getLength ( $flags = 0 )

What is the length of this page? Uses link cache, adding it if necessary.

Parameters

int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update

Returns: int

Definition at line 3627 of file Title.php.

References article, getArticleID(), and in.

◆ getLinksFrom()

Title::getLinksFrom	(	$options = `[]`,
		$table = `'pagelinks'`,
		$prefix = `'pl'`
	)

Get an array of Title objects linked from this Title Also stores the IDs in the link cache.

WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.

Parameters

array	$options	Query option to Database::select()
string	$table	Table name
string	$prefix	Fields prefix

Returns: array Array of Title objects linking here

Definition at line 3843 of file Title.php.

References $options, $res, as, DB_REPLICA, getArticleID(), and wfGetDB().

Referenced by getTemplateLinksFrom().

◆ getLinksTo()

Title::getLinksTo	(	$options = `[]`,
		$table = `'pagelinks'`,
		$prefix = `'pl'`
	)

Get an array of Title objects linking to this Title Also stores the IDs in the link cache.

WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.

Parameters

array	$options	May be FOR UPDATE
string	$table	Table name
string	$prefix	Fields prefix

Returns: Title[] Array of Title objects linking here

Definition at line 3785 of file Title.php.

References $options, $res, as, DB_MASTER, DB_REPLICA, and wfGetDB().

Referenced by getTemplateLinksTo().

◆ getLinkURL()

Title::getLinkURL	(	$query = `''`,
		$query2 = `false`,
		$proto = `false`
	)

Get a URL that's the simplest URL that will be valid to link, locally, to the current Title.

It includes the fragment, but does not include the server unless action=render is used (or the link is external). If there's a fragment but the prefixed text is empty, we just return a link to the fragment.

The result obviously should not be URL-escaped, but does need to be HTML-escaped if it's being output in HTML.

Parameters

string \| string[]	$query
bool	$query2
string \| int \| bool	$proto	A PROTO_* constant on how the URL should be expanded, or false (default) for no expansion

See also: self::getLocalURL for the arguments.

Returns: string The URL

Definition at line 2083 of file Title.php.

References $query, $ret, getFragmentForURL(), getFullURL(), getLocalURL(), getPrefixedText(), hasFragment(), and isExternal().

◆ getLocalURL()

Title::getLocalURL	(	$query = `''`,
		$query2 = `false`
	)

Get a URL with no fragment or server name (relative URL) from a Title object.

If this page is generated with action=render, however, $wgServer is prepended to make an absolute URL.

See also: self::getFullURL to always get an absolute URL.; self::getLinkURL to always get a URL that's the simplest URL that will be valid to link, locally, to the current Title.; self::newFromText to produce a Title object.

Parameters

string \| string[]	$query	An optional query string, not used for interwiki links. Can be specified as an associative array as well, e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped). Some query patterns will trigger various shorturl path replacements.
string \| string[] \| bool	$query2	An optional secondary query array. This one MUST be an array. If a string is passed it will be interpreted as a deprecated variant argument and urlencoded into a variant= argument. This second query argument will be added to the $query The second parameter is deprecated since 1.19. Pass it as a key,value pair in the first parameter array instead.

Returns: string String of the URL.

Definition at line 1984 of file Title.php.

References $matches, $query, $wgActionPaths, $wgArticlePath, $wgRequest, $wgScript, $wgServer, $wgVariantArticlePath, equals(), getNsText(), getPageLanguage(), getPrefixedDBkey(), wfAppendQuery(), and wfUrlencode().

Referenced by getCanonicalURL(), getEditURL(), getFullURL(), getInternalURL(), and getLinkURL().

◆ getNamespace()

Title::getNamespace ( )

Get the namespace index, i.e.

one of the NS_xxxx constants.

Returns: int Namespace index

Implements MediaWiki\Linker\LinkTarget.

Definition at line 974 of file Title.php.

Referenced by SubpageImportTitleFactory\__construct(), EmailNotification\actuallyNotifyOnPageChange(), CategoryViewer\addFragmentToTitle(), EmailNotification\canSendUserTalkEmail(), CategoryViewer\doCategoryQuery(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), WikiPage\insertRedirectEntry(), LogPager\limitTitle(), PageArchive\listPagesByPrefix(), PageArchive\listPagesBySearch(), WikitextContentHandler\makeRedirectContent(), RecentChange\newForCategorization(), EmailNotification\notifyOnPageChange(), MovePageForm\showForm(), SpecialWhatLinksHere\showIndirectLinks(), and LanguageConverter\updateConversionTable().

◆ getNamespaceKey()

Title::getNamespaceKey ( $prepend = 'nstab-' )

Generate strings used for xml 'id' names in monobook tabs.

Parameters

string $prepend Defaults to 'nstab-'

Returns: string XML 'id' name

Definition at line 4954 of file Title.php.

References getSubjectNsText().

◆ getNextRevisionID()

Title::getNextRevisionID	(	$revId,
		$flags = `0`
	)

Get the revision ID of the next revision.

Parameters

int	$revId	Revision ID. Get the revision that was after this one.
int	$flags	Title::GAID_FOR_UPDATE

Returns: int|bool Next revision ID, or false if none exists

Definition at line 4410 of file Title.php.

References getRelativeRevisionID().

◆ getNotificationTimestamp()

Title::getNotificationTimestamp ( $user = null )

Get the timestamp when this page was updated since the user last saw it.

Parameters

User | null $user

Returns: string|null

Definition at line 4916 of file Title.php.

References $user.

◆ getNsText()

Title::getNsText ( )

Get the namespace text.

Returns: string|false Namespace text

Definition at line 1032 of file Title.php.

References isExternal(), and wfDebug().

Referenced by checkActionPermissions(), checkSpecialsAndNSPermissions(), getLocalURL(), getSubjectNsText(), getTalkNsText(), and prefix().

◆ getOtherPage()

Title::getOtherPage ( )

Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page.

Since: 1.25

Exceptions

MWException If the page doesn't have an other page

Returns: Title

Definition at line 1557 of file Title.php.

References canHaveTalkPage(), getSubjectPage(), getTalkPage(), isSpecialPage(), and isTalkPage().

◆ getPageLanguage()

Title::getPageLanguage ( )

Get the language in which the content of this page is written in wikitext.

Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).

Since: 1.18

Returns: Language

Definition at line 5119 of file Title.php.

References $wgLang, $wgLanguageCode, getDbPageLanguageCode(), isSpecialPage(), and wfGetLangObj().

Referenced by getCdnUrls(), and getLocalURL().

◆ getPageViewLanguage()

Title::getPageViewLanguage ( )

Get the language in which the content of this page is written when viewed by user.

Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).

Since: 1.20

Returns: Language

Definition at line 5157 of file Title.php.

References $wgLang, getDbPageLanguageCode(), isSpecialPage(), and wfGetLangObj().

◆ getParentCategories()

Title::getParentCategories ( )

Get categories to which this Title belongs and return an array of categories' names.

Returns: array Array of parents in the form: $parent => $currentarticle

Definition at line 4265 of file Title.php.

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

Referenced by getParentCategoryTree().

◆ getParentCategoryTree()

Title::getParentCategoryTree ( $children = [] )

Get a tree of parent categories.

Parameters

array $children Array with the children in the keys, to check for circular refs

Returns: array Tree of parent categories

Definition at line 4300 of file Title.php.

References $parent, as, and getParentCategories().

◆ getPartialURL()

Title::getPartialURL ( )

Get the URL-encoded form of the main part.

Returns: string Main part of the title, URL-encoded

Definition at line 942 of file Title.php.

◆ getPrefixedDBkey()

Title::getPrefixedDBkey ( )

Get the prefixed database key form.

Returns: string The prefixed title, with underscores and any interwiki and namespace prefixes

Definition at line 1686 of file Title.php.

References $s, and prefix().

Referenced by checkReadPermissions(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), getFullUrlForRedirect(), getLocalURL(), and RecentChange\newForCategorization().

◆ getPrefixedText()

Title::getPrefixedText ( )

Get the prefixed title with spaces.

This is the form usually used for display

Returns: string The prefixed title, with spaces

Definition at line 1698 of file Title.php.

References $s, and prefix().

Referenced by __toString(), checkReadPermissions(), FileDeleteForm\doDelete(), getFullText(), getLinkURL(), MediaWiki\Tests\Revision\RenderedRevisionTest\getMockTitle(), getRestrictionTypes(), CategoryViewer\getSubcategorySortChar(), getTitleValue(), LogPager\limitTitle(), CleanupCaps\movePage(), LocalFile\recordUpload2(), SpecialChangeContentModel\setParameter(), MovePageForm\showForm(), SpecialWhatLinksHere\whatlinkshereForm(), and SpecialWhatLinksHere\wlhLink().

◆ getPrefixedURL()

Title::getPrefixedURL ( )

Get a URL-encoded title (not an actual URL) including interwiki.

Returns: string The URL-encoded form

Definition at line 1858 of file Title.php.

References $s, prefix(), and wfUrlencode().

◆ getPreviousRevisionID()

Title::getPreviousRevisionID	(	$revId,
		$flags = `0`
	)

Get the revision ID of the previous revision.

Parameters

int	$revId	Revision ID. Get the revision that was before this one.
int	$flags	Title::GAID_FOR_UPDATE

Returns: int|bool Old revision ID, or false if none exists

Definition at line 4399 of file Title.php.

References getRelativeRevisionID().

◆ getRedirectsHere()

Title::getRedirectsHere ( $ns = null )

Get all extant redirects to this Title.

Parameters

int | null $ns Single namespace to consider; null to consider all namespaces

Returns: Title[] Array of Title redirects to this title

Definition at line 4982 of file Title.php.

References $dbr, $res, as, DB_REPLICA, isExternal(), and wfGetDB().

◆ getRelativeRevisionID()

Title::getRelativeRevisionID	(	$revId,
		$flags,
		$dir
	)

private

Get next/previous revision ID relative to another revision ID.

Parameters

int	$revId	Revision ID. Get the revision that was before this one.
int	$flags	Title::GAID_FOR_UPDATE
string	$dir	'next' or 'prev'

Returns: int|bool New revision ID, or false if none exists

Definition at line 4343 of file Title.php.

References $sort, DB_MASTER, DB_REPLICA, getArticleID(), and wfGetDB().

Referenced by getNextRevisionID(), and getPreviousRevisionID().

◆ getRestrictionExpiry()

Title::getRestrictionExpiry ( $action )

Get the expiry time for the restriction against a given action.

Parameters

string $action

Returns: string|bool 14-char timestamp, or 'infinity' if the page is protected forever or not protected at all, or false if the action is not recognised.

Definition at line 3250 of file Title.php.

References loadRestrictions().

◆ getRestrictions()

Title::getRestrictions ( $action )

Accessor/initialisation for mRestrictions.

Parameters

string $action Action that permission needs to be checked for

Returns: array Restriction levels needed to take the action. All levels are required. Note that restriction levels are normally user rights, but 'sysop' and 'autoconfirmed' are also allowed for backwards compatibility. These should be mapped to 'editprotected' and 'editsemiprotected' respectively.

Definition at line 3222 of file Title.php.

References loadRestrictions().

Referenced by checkPageRestrictions(), isProtected(), and isSemiProtected().

◆ getRestrictionTypes()

Title::getRestrictionTypes ( )

Returns restriction types for the current Title.

Returns: array Applicable restriction types

Definition at line 2899 of file Title.php.

References exists(), getPrefixedText(), isSpecialPage(), NS_FILE, and wfDebug().

Referenced by isProtected(), and loadRestrictionsFromRows().

◆ getRootText()

Title::getRootText ( )

Get the root page name text without a namespace, i.e.

the leftmost part before any slashes

Example:: Title::newFromText('User:Foo/Bar/Baz')->getRootText();

# returns: 'Foo'

Returns: string Root name

Since: 1.20

Definition at line 1742 of file Title.php.

References getText().

Referenced by getRootTitle().

◆ getRootTitle()

Title::getRootTitle ( )

Get the root page name title, i.e.

the leftmost part before any slashes

Example:: Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();

# returns: Title{User:Foo}

Returns: Title Root title

Since: 1.20

Definition at line 1762 of file Title.php.

References getRootText().

Referenced by isRawHtmlMessage().

◆ getSelectFields()

static Title::getSelectFields ( )

staticprotected

Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries.

Uses $wgContentHandlerUseDB to determine whether to include page_content_model.

Returns: array

Definition at line 401 of file Title.php.

References $wgContentHandlerUseDB, and $wgPageLanguageUseDB.

◆ getSkinFromConfigSubpage()

Title::getSkinFromConfigSubpage ( )

Trim down a .css, .json, or .js subpage title to get the corresponding skin name.

Returns: string Containing skin name from .css, .json, or .js subpage title

Since: 1.31

Definition at line 1350 of file Title.php.

References in, and names.

Referenced by getSkinFromCssJsSubpage().

◆ getSkinFromCssJsSubpage()

Title::getSkinFromCssJsSubpage ( )

Deprecated:: Since 1.31; use ::getSkinFromConfigSubpage() instead

Returns: string Containing skin name from .css, .json, or .js subpage title

Definition at line 1364 of file Title.php.

References getSkinFromConfigSubpage(), and wfDeprecated().

◆ getSquidURLs()

Title::getSquidURLs ( )

Deprecated:: since 1.27 use getCdnUrls()

Definition at line 3975 of file Title.php.

References getCdnUrls().

◆ getSubjectNsText()

Title::getSubjectNsText ( )

Get the namespace text of the subject (rather than talk) page.

Returns: string Namespace text

Definition at line 1056 of file Title.php.

References getNsText().

Referenced by getNamespaceKey().

◆ getSubjectPage()

Title::getSubjectPage ( )

Get a title object associated with the subject page of this talk page.

Returns: Title The object for the subject page

Definition at line 1540 of file Title.php.

Referenced by getOtherPage().

◆ getSubpage()

Title::getSubpage ( $text )

Get the title for a subpage of the current page.

Example:: Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");

# returns: Title{User:Foo/Bar/Baz/Asdf}

Parameters

string $text The subpage name to add to the title

Returns: Title Subpage title

Since: 1.20

Definition at line 1838 of file Title.php.

References getText().

◆ getSubpages()

Title::getSubpages ( $limit = -1 )

Get all subpages of this page.

Parameters

int $limit Maximum number of subpages to fetch; -1 for no limit

Returns: TitleArray|array TitleArray, or empty array if this page's namespace doesn't allow subpages

Definition at line 3488 of file Title.php.

References $dbr, $options, DB_REPLICA, TitleArray\newFromResult(), and wfGetDB().

Referenced by hasSubpages(), and moveSubpages().

◆ getSubpageText()

Title::getSubpageText ( )

Get the lowest-level subpage name, i.e.

the rightmost part after any slashes

Example:: Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();

# returns: "Baz"

Returns: string Subpage name

Definition at line 1817 of file Title.php.

Referenced by getSubpageUrlForm().

◆ getSubpageUrlForm()

Title::getSubpageUrlForm ( )

Get a URL-encoded form of the subpage text.

Returns: string URL-encoded subpage name

Definition at line 1847 of file Title.php.

References getSubpageText(), and wfUrlencode().

◆ getTalkNsText()

Title::getTalkNsText ( )

Get the namespace text of the talk page.

Returns: string Namespace text

Definition at line 1066 of file Title.php.

References getNsText().

◆ getTalkPage()

Title::getTalkPage ( )

Get a Title object associated with the talk page of this article.

Returns: Title The object for the talk page

Definition at line 1513 of file Title.php.

Referenced by getOtherPage(), and getTalkPageIfDefined().

◆ getTalkPageIfDefined()

Title::getTalkPageIfDefined ( )

Get a Title object associated with the talk page of this article, if such a talk page can exist.

Since: 1.30

Returns: Title|null The object for the talk page, or null if no associated talk page can exist, according to canHaveTalkPage().

Definition at line 1526 of file Title.php.

References canHaveTalkPage(), and getTalkPage().

◆ getTemplateLinksFrom()

Title::getTemplateLinksFrom ( $options = [] )

Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache.

WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.

Parameters

array $options May be FOR UPDATE

Returns: Title[] Array of Title the Title objects used here

Definition at line 3897 of file Title.php.

References $options, and getLinksFrom().

◆ getTemplateLinksTo()

Title::getTemplateLinksTo ( $options = [] )

Get an array of Title objects using this Title as a template Also stores the IDs in the link cache.

WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.

Parameters

array $options Query option to Database::select()

Returns: Title[] Array of Title the Title objects linking here

Definition at line 3827 of file Title.php.

References $options, and getLinksTo().

◆ getText()

Title::getText ( )

Get the text form (spaces not underscores) of the main part.

Returns: string Main part of the title

Implements MediaWiki\Linker\LinkTarget.

Definition at line 933 of file Title.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), CategoryViewer\addSubcategoryObject(), EmailNotification\canSendUserTalkEmail(), createFragmentTarget(), getBaseText(), TraditionalImageGallery\getCaptionHtml(), getCategorySortkey(), getDefaultMessageText(), getRootText(), getSubpage(), isConversionTable(), isSubpage(), PageArchive\listPagesBySearch(), and MovePageForm\showForm().

◆ getTitleCache()

static Title::getTitleCache ( )

staticprivate

Returns: MapCacheLRU

Definition at line 387 of file Title.php.

◆ getTitleFormatter()

static Title::getTitleFormatter ( )

staticprivate

B/C kludge: provide a TitleParser for use by Title.

Ideally, Title would have no methods that need this. Avoid usage of this singleton by using TitleValue and the associated services when possible.

Returns: TitleFormatter

Definition at line 191 of file Title.php.

◆ getTitleProtection()

Title::getTitleProtection ( )

Is this title subject to title protection? Title protection is the one applied against creation of such title.

Returns: array|bool An associative array representing any existent title protection, or false if there's none.

Definition at line 2926 of file Title.php.

References getTitleProtectionInternal().

Referenced by checkActionPermissions().

◆ getTitleProtectionInternal()

Title::getTitleProtectionInternal ( )

protected

Fetch title protection settings.

To work correctly, $this->loadRestrictions() needs to have access to the actual protections in the database without munging 'sysop' => 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other callers probably want $this->getTitleProtection() instead.

Returns: array|bool

Definition at line 2949 of file Title.php.

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

Referenced by getTitleProtection(), and loadRestrictions().

◆ getTitleValue()

Title::getTitleValue ( )

Get a TitleValue object representing this Title.

Note: Not all valid Titles have a corresponding valid TitleValue (e.g. TitleValues cannot represent page-local links that have a fragment but no title text).

Returns: TitleValue|null

Definition at line 910 of file Title.php.

References getPrefixedText(), and wfDebug().

◆ getTouched()

Title::getTouched ( $db = null )

Get the last touched timestamp.

Parameters

IDatabase | null $db

Returns: string|false Last-touched timestamp

Definition at line 4902 of file Title.php.

References DB_REPLICA, pageCond(), and wfGetDB().

◆ getTransWikiID()

Title::getTransWikiID ( )

Returns the DB name of the distant wiki which owns the object.

Returns: string|false The DB name

Definition at line 893 of file Title.php.

References isExternal().

◆ getUserCaseDBKey()

Title::getUserCaseDBKey ( )

Get the DB key with the initial letter case as specified by the user.

Returns: string DB key

Definition at line 960 of file Title.php.

◆ getUserPermissionsErrors()

Title::getUserPermissionsErrors	(	$action,
		$user,
		$rigor = `'secure'`,
		$ignoreErrors = `[]`
	)

Can $user perform $action on this page?

Todo:: FIXME: This does not check throttles (User::pingLimiter()).

Parameters

string	$action	Action that permission needs to be checked for
User	$user	User to check
string	$rigor	One of (quick,full,secure) quick : does cheap permission checks from replica DBs (usable for GUI creation) full : does cheap and expensive checks possibly from a replica DB secure : does cheap and expensive checks, using the master as needed
array	$ignoreErrors	Array of Strings Set this to a list of message keys whose corresponding errors may be ignored.

Returns: array Array of arrays of the arguments to wfMessage to explain permissions problems.

Definition at line 2206 of file Title.php.

References $user, as, and getUserPermissionsErrorsInternal().

◆ getUserPermissionsErrorsInternal()

Title::getUserPermissionsErrorsInternal	(	$action,
		$user,
		$rigor = `'secure'`,
		$short = `false`
	)

protected

Can $user perform $action on this page? This is an internal function, with multiple levels of checks depending on performance needs; see $rigor below.

It does not check wfReadOnly().

Parameters

string	$action	Action that permission needs to be checked for
User	$user	User to check
string	$rigor	One of (quick,full,secure) quick : does cheap permission checks from replica DBs (usable for GUI creation) full : does cheap and expensive checks possibly from a replica DB secure : does cheap and expensive checks, using the master as needed
bool	$short	Set this to true to stop after the first permission error.

Returns: array Array of arrays of the arguments to wfMessage to explain permissions problems.

Definition at line 2819 of file Title.php.

References $user.

Referenced by checkActionPermissions(), getUserPermissionsErrors(), and userCan().

◆ hasContentModel()

Title::hasContentModel ( $id )

Convenience method for checking a title's content model name.

Parameters

string $id The content model ID (use the CONTENT_MODEL_XXX constants).

Returns: bool True if $this->getContentModel() == $id

Definition at line 1007 of file Title.php.

References getContentModel().

Referenced by isCssJsSubpage(), isCssOrJsPage(), isSiteCssConfigPage(), isSiteJsConfigPage(), isSiteJsonConfigPage(), isUserCssConfigPage(), isUserJsConfigPage(), isUserJsonConfigPage(), and isWikitextPage().

◆ hasFragment()

Title::hasFragment ( )

Check if a Title fragment is set.

Returns: bool

Since: 1.23

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1597 of file Title.php.

Referenced by getFragmentForURL(), getFullText(), and getLinkURL().

◆ hasSourceText()

Title::hasSourceText ( )

Does this page have source text?

Returns: bool

Definition at line 4763 of file Title.php.

References $name, exists(), list, NS_MEDIAWIKI, and wfMessage().

Referenced by isAlwaysKnown().

◆ hasSubjectNamespace()

Title::hasSubjectNamespace ( $ns )

Returns true if the title has the same subject namespace as the namespace specified.

For example this method will take NS_USER and return true if namespace is either NS_USER or NS_USER_TALK since both of them have NS_USER as their subject namespace.

This is MUCH simpler than individually testing for equivalence against both NS_USER and NS_USER_TALK, and is also forward compatible.

Since: 1.19

Parameters

int $ns

Returns: bool

Definition at line 1208 of file Title.php.

◆ hasSubpages()

Title::hasSubpages ( )

Does this have subpages? (Warning, usually requires an extra DB query.)

Returns: bool

Definition at line 3460 of file Title.php.

References getSubpages().

◆ inNamespace()

Title::inNamespace ( $ns )

Returns true if the title is inside the specified namespace.

Please make use of this instead of comparing to getNamespace() This function is much more resistant to changes we may make to namespaces than code that makes direct comparisons.

Parameters

int $ns The namespace

Returns: bool

Since: 1.19

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1169 of file Title.php.

Referenced by inNamespaces(), and isRawHtmlMessage().

◆ inNamespaces()

Title::inNamespaces ( )

Returns true if the title is inside one of the specified namespaces.

Parameters

int | int[] $namespaces,... The namespaces to check for

Returns: bool

Since: 1.19

Definition at line 1180 of file Title.php.

References $namespaces, as, and inNamespace().

◆ invalidateCache()

Title::invalidateCache ( $purgeTime = null )

Updates page_touched for this page; called from LinksUpdate.php.

Parameters

string | null $purgeTime [optional] TS_MW timestamp

Returns: bool True if the update succeeded

Definition at line 4844 of file Title.php.

References $fname, Wikimedia\Rdbms\IDatabase\addQuotes(), DB_MASTER, pageCond(), Wikimedia\Rdbms\IDatabase\timestamp(), Wikimedia\Rdbms\IDatabase\update(), use, wfGetDB(), and wfReadOnly().

Referenced by File\purgeDescription().

◆ isAlwaysKnown()

Title::isAlwaysKnown ( )

Should links to this title be shown as potentially viewable (i.e.

as "bluelinks"), even if there's no record by this title in the page table?

This function is semi-deprecated for public use, as well as somewhat misleadingly named. You probably just want to call isKnown(), which calls this function internally.

(ISSUE: Most of these checks are cheap, but the file existence check can potentially be quite expensive. Including it here fixes a lot of existing code, but we might want to add an optional parameter to skip it and any other expensive checks.)

Returns: bool

Definition at line 4700 of file Title.php.

References exists(), hasSourceText(), isExternal(), NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, NS_SPECIAL, and wfFindFile().

Referenced by isKnown().

◆ isBigDeletion()

Title::isBigDeletion ( )

Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.

Returns: bool

Definition at line 4467 of file Title.php.

References $dbr, $wgDeleteRevisionsLimit, DB_REPLICA, getArticleID(), and wfGetDB().

Referenced by checkActionPermissions().

◆ isCascadeProtected()

Title::isCascadeProtected ( )

Cascading protection: Return true if cascading restrictions apply to this page, false if not.

Returns: bool If the page is subject to cascading restrictions.

Definition at line 3092 of file Title.php.

References getCascadeProtectionSources(), and list.

◆ isContentPage()

Title::isContentPage ( )

Is this Title in a namespace which contains content? In other words, is this a content page, for the purposes of calculating statistics, etc?

Returns: bool

Definition at line 1219 of file Title.php.

◆ isConversionTable()

Title::isConversionTable ( )

Is this a conversion table for the LanguageConverter?

Returns: bool

Definition at line 1270 of file Title.php.

References getText(), and NS_MEDIAWIKI.

◆ isCssJsSubpage()

Title::isCssJsSubpage ( )

Returns: bool

Deprecated:: Since 1.31; use ::isUserConfigPage() instead (which also checks for JSON pages)

Definition at line 1337 of file Title.php.

References CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, hasContentModel(), isSubpage(), NS_USER, and wfDeprecated().

◆ isCssOrJsPage()

Title::isCssOrJsPage ( )

Returns: bool

Deprecated:: Since 1.31; use ::isSiteConfigPage() instead (which also checks for JSON pages)

Definition at line 1312 of file Title.php.

References CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, hasContentModel(), NS_MEDIAWIKI, and wfDeprecated().

◆ isCssSubpage()

Title::isCssSubpage ( )

Deprecated:: Since 1.31; use ::isUserCssConfigPage()

Returns: bool

Definition at line 1387 of file Title.php.

References isUserCssConfigPage(), and wfDeprecated().

◆ isDeleted()

Title::isDeleted ( )

Is there a version of this page in the deletion archive?

Returns: int The number of archived revisions

Definition at line 3515 of file Title.php.

References $dbr, DB_REPLICA, NS_FILE, and wfGetDB().

◆ isDeletedQuick()

Title::isDeletedQuick ( )

Is there a version of this page in the deletion archive?

Returns: bool

Definition at line 3540 of file Title.php.

References $dbr, DB_REPLICA, NS_FILE, and wfGetDB().

Referenced by File\wasDeleted().

◆ isExternal()

Title::isExternal ( )

Is this Title interwiki?

Returns: bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 850 of file Title.php.

Referenced by getEditURL(), DoubleRedirectJob\getFinalDestination(), getFragmentForURL(), getFullUrlForRedirect(), getLinkURL(), getNsText(), getRedirectsHere(), getTransWikiID(), isAlwaysKnown(), isLocal(), isMovable(), isTrans(), isWatchable(), prefix(), and secureAndSplit().

◆ isJsSubpage()

Title::isJsSubpage ( )

Deprecated:: Since 1.31; use ::isUserJsConfigPage()

Returns: bool

Definition at line 1424 of file Title.php.

References isUserJsConfigPage(), and wfDeprecated().

◆ isKnown()

Title::isKnown ( )

Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).

Adding something else to this function will cause inconsistency since LinkHolderArray calls isAlwaysKnown() and does its own page existence check.

Returns: bool

Definition at line 4754 of file Title.php.

References exists(), and isAlwaysKnown().

◆ isLocal()

Title::isLocal ( )

Determine whether the object refers to a page within this project (either this wiki or a wiki with a local interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )

Returns: bool True if this is an in-project interwiki link or a wikilink, false otherwise

Definition at line 835 of file Title.php.

References isExternal().

◆ isMainPage()

Title::isMainPage ( )

Is this the mainpage?

Note: Title::newFromText seems to be sufficiently optimized by the title cache that we don't need to over-optimize by doing direct comparisons and accidentally creating new bugs where $title->equals( Title::newFromText() ) ends up reporting something differently than $title->isMainPage();

Since: 1.18

Returns: bool

Definition at line 1250 of file Title.php.

References equals().

◆ isMovable()

Title::isMovable ( )

Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable.

Returns: bool

Definition at line 1229 of file Title.php.

References isExternal().

Referenced by checkActionPermissions().

◆ isNamespaceProtected()

Title::isNamespaceProtected ( User $user )

Determines if $user is unable to edit this page because it has been protected by $wgNamespaceProtection.

Parameters

User $user User object to check permissions

Returns: bool

Definition at line 3074 of file Title.php.

References $user, $wgNamespaceProtection, array(), and as.

Referenced by checkSpecialsAndNSPermissions().

◆ isNewPage()

Title::isNewPage ( )

Check if this is a new page.

Returns: bool

Definition at line 4457 of file Title.php.

References $dbr, DB_REPLICA, pageCond(), and wfGetDB().

◆ isProtected()

Title::isProtected ( $action = '' )

Does the title correspond to a protected article?

Parameters

string $action The action the page is protected from, by default checks all actions.

Returns: bool

Definition at line 3042 of file Title.php.

References $type, $wgRestrictionLevels, as, getRestrictions(), getRestrictionTypes(), and isSpecialPage().

◆ isRawHtmlMessage()

Title::isRawHtmlMessage ( )

Is this a message which can contain raw HTML?

Returns: bool

Since: 1.32

Definition at line 1489 of file Title.php.

References $wgRawHtmlMessages, getDBkey(), getRootTitle(), inNamespace(), and NS_MEDIAWIKI.

Referenced by checkSiteConfigPermissions().

◆ isRedirect()

Title::isRedirect ( $flags = 0 )

Is this an article that is a redirect page? Uses link cache, adding it if necessary.

Parameters

int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update

Returns: bool

Definition at line 3592 of file Title.php.

References article, getArticleID(), and in.

Referenced by CategoryViewer\addSubcategoryObject().

◆ isSemiProtected()

Title::isSemiProtected ( $action = 'edit' )

Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?

Parameters

string $action Action to check (default: edit)

Returns: bool

Definition at line 3014 of file Title.php.

References $wgSemiprotectedRestrictionLevels, as, and getRestrictions().

◆ isSingleRevRedirect()

Title::isSingleRevRedirect ( )

Checks if this page is just a one-rev redirect.

Adds lock, so don't use just for light purposes.

Returns: bool

Definition at line 4166 of file Title.php.

References $wgContentHandlerUseDB, DB_MASTER, pageCond(), and wfGetDB().

◆ isSiteConfigPage()

Title::isSiteConfigPage ( )

Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI.

This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.

This method does not return true for per-user JS/JSON/CSS. Use isUserConfigPage() for that!

Note that this method should not return true for pages that contain and show "inactive" CSS, JSON, or JS.

Returns: bool

Since: 1.31

Definition at line 1300 of file Title.php.

References isSiteCssConfigPage(), isSiteJsConfigPage(), and isSiteJsonConfigPage().

◆ isSiteCssConfigPage()

Title::isSiteCssConfigPage ( )

Is this a sitewide CSS "config" page?

Returns: bool

Since: 1.32

Definition at line 1435 of file Title.php.

References CONTENT_MODEL_CSS, hasContentModel(), and NS_MEDIAWIKI.

Referenced by checkSiteConfigPermissions(), and isSiteConfigPage().

◆ isSiteJsConfigPage()

Title::isSiteJsConfigPage ( )

Is this a sitewide JS "config" page?

Returns: bool

Since: 1.31

Definition at line 1471 of file Title.php.

References CONTENT_MODEL_JAVASCRIPT, hasContentModel(), and NS_MEDIAWIKI.

Referenced by checkSiteConfigPermissions(), and isSiteConfigPage().

◆ isSiteJsonConfigPage()

Title::isSiteJsonConfigPage ( )

Is this a sitewide JSON "config" page?

Returns: bool

Since: 1.32

Definition at line 1453 of file Title.php.

References CONTENT_MODEL_JSON, hasContentModel(), and NS_MEDIAWIKI.

Referenced by checkSiteConfigPermissions(), and isSiteConfigPage().

◆ isSpecial()

Title::isSpecial ( $name )

Returns true if this title resolves to the named special page.

Parameters

string $name The special page name

Returns: bool

Definition at line 1127 of file Title.php.

References $name, isSpecialPage(), and list.

Referenced by checkReadPermissions(), and isValidRedirectTarget().

◆ isSpecialPage()

Title::isSpecialPage ( )

Returns true if this is a special page.

Returns: bool

Definition at line 1117 of file Title.php.

References NS_SPECIAL.

Referenced by SkinTemplate\buildPersonalUrls(), checkReadPermissions(), checkSpecialsAndNSPermissions(), fixSpecialName(), getOtherPage(), getPageLanguage(), getPageViewLanguage(), getRestrictionTypes(), isProtected(), isSpecial(), isValidRedirectTarget(), and secureAndSplit().

◆ isSubpage()

Title::isSubpage ( )

Is this a subpage?

Returns: bool

Definition at line 1259 of file Title.php.

References false, and getText().

Referenced by isCssJsSubpage(), isUserCssConfigPage(), isUserJsConfigPage(), and isUserJsonConfigPage().

◆ isSubpageOf()

Title::isSubpageOf ( Title $title )

Check if this title is a subpage of another title.

Parameters

Title $title

Returns: bool

Definition at line 4661 of file Title.php.

References $title.

◆ isTalkPage()

Title::isTalkPage ( )

Is this a talk page of some sort?

Returns: bool

Definition at line 1504 of file Title.php.

Referenced by checkQuickPermissions(), and getOtherPage().

◆ isTrans()

Title::isTrans ( )

Determine whether the object refers to a page within this project and is transcludable.

Returns: bool True if this is transcludable

Definition at line 880 of file Title.php.

References isExternal().

◆ isUserConfigPage()

Title::isUserConfigPage ( )

Is this a "config" (.css, .json, or .js) sub-page of a user page?

Returns: bool

Since: 1.31

Definition at line 1325 of file Title.php.

References isUserCssConfigPage(), isUserJsConfigPage(), and isUserJsonConfigPage().

Referenced by checkCascadingSourcesRestrictions().

◆ isUserCssConfigPage()

Title::isUserCssConfigPage ( )

Is this a CSS "config" sub-page of a user page?

Returns: bool

Since: 1.31

Definition at line 1375 of file Title.php.

References CONTENT_MODEL_CSS, hasContentModel(), isSubpage(), and NS_USER.

Referenced by checkUserConfigPermissions(), getCdnUrls(), isCssSubpage(), and isUserConfigPage().

◆ isUserJsConfigPage()

Title::isUserJsConfigPage ( )

Is this a JS "config" sub-page of a user page?

Returns: bool

Since: 1.31

Definition at line 1412 of file Title.php.

References CONTENT_MODEL_JAVASCRIPT, hasContentModel(), isSubpage(), and NS_USER.

Referenced by checkUserConfigPermissions(), getCdnUrls(), isJsSubpage(), and isUserConfigPage().

◆ isUserJsonConfigPage()

Title::isUserJsonConfigPage ( )

Is this a JSON "config" sub-page of a user page?

Returns: bool

Since: 1.31

Definition at line 1398 of file Title.php.

References CONTENT_MODEL_JSON, hasContentModel(), isSubpage(), and NS_USER.

Referenced by checkUserConfigPermissions(), getCdnUrls(), and isUserConfigPage().

◆ isValid()

Title::isValid ( )

Returns true if the title is valid, false if it is invalid.

Valid titles can be round-tripped via makeTitleSafe() and newFromText(). Invalid titles may get returned from makeTitle(), and it may be useful to allow them to exist, e.g. in order to process log entries about pages in namespaces that belong to extensions that are no longer installed.

Note: This method is relatively expensive. When constructing Title objects that need to be valid, use an instantiator method that is guaranteed to return valid titles, such as makeTitleSafe() or newFromText().

Returns: bool

Definition at line 814 of file Title.php.

References $parser.

◆ isValidMoveOperation()

Title::isValidMoveOperation	(	&	$nt,
			$auth = `true`,
			$reason = `''`
	)

Check whether a given move operation would be valid.

Returns true if ok, or a getUserPermissionsErrors()-like array otherwise

Deprecated:: since 1.25, use MovePage's methods instead

Parameters

Title	&$nt	The new title
bool	$auth	Whether to check user permissions (uses $wgUser)
string	$reason	Is the log summary of the move, used for spam checking

Returns: array|bool True on success, getUserPermissionsErrors()-like array on failure

Definition at line 3999 of file Title.php.

References wfMergeErrorArrays().

Referenced by moveTo(), and MovePageForm\showForm().

◆ isValidMoveTarget()

Title::isValidMoveTarget ( $nt )

Checks if $this can be moved to a given Title.

Selects for update, so don't call it unless you mean business

Deprecated:
since 1.25, use MovePage's methods instead

Parameters

Title $nt The new title to check

Returns
bool

Definition at line 4217 of file Title.php.

References $content, $rev, Revision\newFromTitle(), NS_FILE, wfDebug(), and wfLocalFile().

◆ isValidRedirectTarget()

Title::isValidRedirectTarget ( )

Check if this Title is a valid redirect target.

Returns: bool

Definition at line 5018 of file Title.php.

References $wgInvalidRedirectTargets, as, isSpecial(), and isSpecialPage().

Referenced by AbstractContent\getRedirectChain(), and XmlDumpWriter\openPage().

◆ isWatchable()

Title::isWatchable ( )

Can this title be added to a user's watchlist?

Returns: bool

Definition at line 1108 of file Title.php.

References isExternal().

◆ isWikitextPage()

Title::isWikitextPage ( )

Does that page contain wikitext, or it is JS, CSS or whatever?

Returns: bool

Definition at line 1282 of file Title.php.

References CONTENT_MODEL_WIKITEXT, and hasContentModel().

◆ legalChars()

static Title::legalChars ( )

static

Get a regex character class describing the legal characters in a link.

Returns: string The list of characters, not delimited

Definition at line 634 of file Title.php.

References $wgLegalTitleChars.

◆ loadFromRow()

Title::loadFromRow ( $row )

Load Title object fields from a DB row.

If false is given, the title will be treated as non-existing.

Parameters

stdClass | bool $row Database row

Definition at line 487 of file Title.php.

References getContentModel(), in, and string.

◆ loadRestrictions()

Title::loadRestrictions ( $oldFashionedRestrictions = null )

Load restrictions from the page_restrictions table.

Parameters

string | null $oldFashionedRestrictions Comma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows. Edit and move sections are separated by a colon Example: "edit=autoconfirmed,sysop:move=sysop"

Definition at line 3353 of file Title.php.

References $cache, $dbr, $fname, $rows, array(), DB_REPLICA, function, getArticleID(), getTitleProtectionInternal(), loadRestrictionsFromRows(), use, wfGetDB(), and wfTimestampNow().

Referenced by areRestrictionsCascading(), getAllRestrictions(), getRestrictionExpiry(), and getRestrictions().

◆ loadRestrictionsFromRows()

Title::loadRestrictionsFromRows	(	$rows,
		$oldFashionedRestrictions = `null`
	)

Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page.

Public for usage by LiquidThreads.

Parameters

array	$rows	Array of db result objects
string \| null	$oldFashionedRestrictions	Comma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows. Edit and move sections are separated by a colon Example: "edit=autoconfirmed,sysop:move=sysop"

Definition at line 3281 of file Title.php.

References $dbr, $rows, $type, as, DB_REPLICA, getArticleID(), getRestrictionTypes(), wfGetDB(), and wfTimestampNow().

Referenced by loadRestrictions().

◆ makeName()

static Title::makeName	(	$ns,
		$title,
		$fragment = `''`,
		$interwiki = `''`,
		$canonicalNamespace = `false`
	)

static

Make a prefixed DB key from a DB key and a namespace index.

Parameters

int	$ns	Numerical representation of the namespace
string	$title	The DB key form the title
string	$fragment	The link fragment (after the "#")
string	$interwiki	The interwiki prefix
bool	$canonicalNamespace	If true, use the canonical name for $ns instead of the localized version.

Returns: string The prefixed form of the title

Definition at line 752 of file Title.php.

References $name, and $title.

◆ makeTitle()

static Title::makeTitle	(	$ns,
		$title,
		$fragment = `''`,
		$interwiki = `''`
	)

static

Create a new Title from a namespace index and a DB key.

It's assumed that $ns and $title are safe, for instance when they came directly from the database or a special page name, not from user input.

No validation is applied. For convenience, spaces are normalized to underscores, so that e.g. user_text fields can be used directly.

Note: This method may return Title objects that are "invalid" according to the isValid() method. This is usually caused by configuration changes: e.g. a namespace that was once defined is no longer configured, or a character that was once allowed in titles is now forbidden.

Parameters

int	$ns	The namespace of the article
string	$title	The unprefixed database key form
string	$fragment	The link fragment (after the "#")
string	$interwiki	The interwiki prefix

Returns: Title The new object

Definition at line 545 of file Title.php.

References $t, $title, getContentModel(), in, and wfUrlencode().

◆ makeTitleSafe()

static Title::makeTitleSafe	(	$ns,
		$title,
		$fragment = `''`,
		$interwiki = `''`
	)

static

Create a new Title from a namespace index and a DB key.

The parameters will be checked for validity, which is a bit slower than makeTitle() but safer for user-provided data.

Title objects returned by makeTitleSafe() are guaranteed to be valid, that is, they return true from the isValid() method. If no valid Title can be constructed from the input, this method returns null.

Parameters

int	$ns	The namespace of the article
string	$title	Database key form
string	$fragment	The link fragment (after the "#")
string	$interwiki	Interwiki prefix

Returns: Title|null The new object, or null on an error

Definition at line 573 of file Title.php.

References $t, and $title.

◆ missingPermissionError()

Title::missingPermissionError	(	$action,
		$short
	)

private

Get a description array when the user doesn't have the right to perform $action (i.e.

when User::isAllowed() returns false)

Parameters

string	$action	The action to check
bool	$short	Short circuit on first error

Returns: array Array containing an error message key and any parameters

Definition at line 2796 of file Title.php.

References User\newFatalPermissionDeniedStatus().

Referenced by checkQuickPermissions(), and checkReadPermissions().

◆ moveSubpages()

Title::moveSubpages	(		$nt,
			$auth = `true`,
			$reason = `''`,
			$createRedirect = `true`,
		array	$changeTags = `[]`
	)

Move this page's subpages to be subpages of $nt.

Parameters

Title	$nt	Move target
bool	$auth	Whether $wgUser's permissions should be checked
string	$reason	The reason for the move
bool	$createRedirect	Whether to create redirects from the old subpages to the new ones Ignored if the user doesn't have the 'suppressredirect' right
array	$changeTags	Applied to the entry in the move log and redirect page revision

Returns: array Array with old page titles as keys, and strings (new page titles) or getUserPermissionsErrors()-like arrays (errors) as values, or a getUserPermissionsErrors()-like error array with numeric indices if no pages were moved

Definition at line 4093 of file Title.php.

References $retval, $success, $wgMaximumMovedPages, as, StringUtils\escapeRegexReplacement(), getSubpages(), and userCan().

◆ moveTo()

Title::moveTo	(	&	$nt,
			$auth = `true`,
			$reason = `''`,
			$createRedirect = `true`,
		array	$changeTags = `[]`
	)

Move a title to a new location.

Deprecated:: since 1.25, use the MovePage class instead

Parameters

Title	&$nt	The new title
bool	$auth	Indicates whether $wgUser's permissions should be checked
string	$reason	The reason for the move
bool	$createRedirect	Whether to create a redirect from the old title to the new title. Ignored if the user doesn't have the suppressredirect right.
array	$changeTags	Applied to the entry in the move log and redirect page revision

Returns: array|bool True on success, getUserPermissionsErrors()-like array on failure

Definition at line 4055 of file Title.php.

References isValidMoveOperation().

◆ nameOf()

static Title::nameOf ( $id )

static

Get the prefixed DB key associated with an ID.

Parameters

int $id The page_id of the article

Returns: Title|null An object representing the article, or null if no such article was found

Definition at line 612 of file Title.php.

References $dbr, $s, DB_REPLICA, and wfGetDB().

◆ newFromDBkey()

static Title::newFromDBkey ( $key )

static

Create a new Title from a prefixed DB key.

Parameters

string $key The database key, which has underscores instead of spaces, possibly including namespace and interwiki prefixes

Returns: Title|null Title, or null on an error

Definition at line 221 of file Title.php.

References $t.

◆ newFromID()

static Title::newFromID	(	$id,
		$flags = `0`
	)

static

Create a new Title from an article ID.

Parameters

int	$id	The page_id corresponding to the Title to create
int	$flags	Use Title::GAID_FOR_UPDATE to use master

Returns: Title|null The new object, or null on an error

Definition at line 427 of file Title.php.

References $title, DB_MASTER, DB_REPLICA, and wfGetDB().

◆ newFromIDs()

static Title::newFromIDs ( $ids )

static

Make an array of titles from an array of IDs.

Parameters

int[] $ids Array of IDs

Returns: Title[] Array of Titles

Definition at line 449 of file Title.php.

References $dbr, $res, $titles, as, DB_REPLICA, and wfGetDB().

◆ newFromLinkTarget()

static Title::newFromLinkTarget ( LinkTarget $linkTarget )

static

Create a new Title from a LinkTarget.

Parameters

LinkTarget $linkTarget Assumed to be safe.

Returns: Title

Definition at line 251 of file Title.php.

References MediaWiki\Linker\LinkTarget\getFragment(), MediaWiki\Linker\LinkTarget\getInterwiki(), MediaWiki\Linker\LinkTarget\getNamespace(), and MediaWiki\Linker\LinkTarget\getText().

◆ newFromRow()

static Title::newFromRow ( $row )

static

Make a Title object from a DB row.

Parameters

stdClass $row Object database row (needs at least page_title,page_namespace)

Returns: Title Corresponding Title

Definition at line 475 of file Title.php.

References $t.

◆ newFromText()

static Title::newFromText	(	$text,
		$defaultNamespace = `NS_MAIN`
	)

static

Create a new Title from text, such as what one would find in a link.

De- codes any HTML entities in the text.

Title objects returned by this method are guaranteed to be valid, and thus return true from the isValid() method.

Parameters

string \| int \| null	$text	The link text; spaces, prefixes, and an initial ':' indicating the main namespace are accepted.
int	$defaultNamespace	The namespace to use if none is specified by a prefix. If you want to force a specific namespace even if $text might begin with a namespace prefix, use makeTitle() or makeTitleSafe().

Exceptions

InvalidArgumentException

Returns: Title|null Title or null on an error.

Definition at line 280 of file Title.php.

◆ newFromTextThrow()

static Title::newFromTextThrow	(	$text,
		$defaultNamespace = `NS_MAIN`
	)

static

Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.

The exception subclasses encode detailed information about why the title is invalid.

Title objects returned by this method are guaranteed to be valid, and thus return true from the isValid() method.

See also: Title::newFromText

Since: 1.25

Parameters

string	$text	Title text to check
int	$defaultNamespace

Exceptions

MalformedTitleException If the title is invalid

Returns: Title

Definition at line 313 of file Title.php.

References $t, MapCacheLRU\get(), NS_MAIN, and MapCacheLRU\set().

◆ newFromTitleValue()

static Title::newFromTitleValue ( TitleValue $titleValue )

static

Create a new Title from a TitleValue.

Parameters

TitleValue $titleValue Assumed to be safe.

Returns: Title

Definition at line 240 of file Title.php.

◆ newFromURL()

static Title::newFromURL ( $url )

static

THIS IS NOT THE FUNCTION YOU WANT.

Use Title::newFromText().

Example of wrong and broken code: $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );

Example of right code: $title = Title::newFromText( $wgRequest->getVal( 'title' ) );

Create a new Title from URL-encoded text. Ensures that the given title's length does not exceed the maximum.

Parameters

string $url The title, as might be taken from a URL

Returns: Title|null The new object, or null on an error

Definition at line 364 of file Title.php.

References $t.

◆ newMainPage()

static Title::newMainPage ( )

static

Create a new Title for the Main Page.

Returns: Title The new object

Definition at line 597 of file Title.php.

References $title, text, and wfMessage().

◆ pageCond()

Title::pageCond ( )

Get an associative array for selecting this title from the "page" table.

Returns: array Array suitable for the $where parameter of DB::select()

Definition at line 4327 of file Title.php.

Referenced by getTouched(), invalidateCache(), isNewPage(), and isSingleRevRedirect().

◆ prefix()

Title::prefix ( $name )

private

Prefix some arbitrary text with the namespace or interwiki prefix of this object.

Parameters

string $name The text

Returns: string The prefixed text

Definition at line 1660 of file Title.php.

References $name, getNsText(), isExternal(), and NS_SPECIAL.

Referenced by getPrefixedDBkey(), getPrefixedText(), and getPrefixedURL().

◆ purgeExpiredRestrictions()

static Title::purgeExpiredRestrictions ( )

static

Purge expired restrictions from the page_restrictions table.

This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows

Definition at line 3419 of file Title.php.

References $fname, Wikimedia\Rdbms\IDatabase\addQuotes(), DB_MASTER, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\selectFieldValues(), Wikimedia\Rdbms\IDatabase\timestamp(), wfGetDB(), and wfReadOnly().

◆ purgeSquid()

Title::purgeSquid ( )

Purge all applicable CDN URLs.

Definition at line 3982 of file Title.php.

References getCdnUrls().

Referenced by File\purgeDescription().

◆ quickUserCan()

Title::quickUserCan	(	$action,
		$user = `null`
	)

Can $user perform $action on this page? This skips potentially expensive cascading permission checks as well as avoids expensive error formatting.

Suitable for use for nonessential UI controls in common cases, but not for functional access control.

May provide false positives, but should never provide a false negative.

Parameters

string	$action	Action that permission needs to be checked for
User \| null	$user	User to check (since 1.19); $wgUser will be used if not provided.

Returns: bool

Definition at line 2169 of file Title.php.

References $user, and userCan().

Referenced by TemplatesOnThisPageFormatter\buildEditLink(), and MovePageForm\showForm().

◆ resetArticleID()

Title::resetArticleID ( $newid )

This clears some fields in this object, and clears any associated keys in the "bad links" section of the link cache.

This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow loading of the new page_id. It's also called from WikiPage::doDeleteArticleReal()

Parameters

int $newid The new Article ID

Definition at line 3687 of file Title.php.

◆ resultToError()

Title::resultToError	(	$errors,
		$result
	)

private

Add the resulting error code to the errors array.

Parameters

array	$errors	List of current errors
array	$result	Result of errors

Returns: array List of errors

Definition at line 2307 of file Title.php.

Referenced by checkPermissionHooks().

◆ secureAndSplit()

Title::secureAndSplit ( )

private

Secure and split - main initialisation function for this object.

Assumes that mDbkeyform has been set, and is urldecoded and uses underscores, but not otherwise munged. This function removes illegal characters, splits off the interwiki and namespace prefixes, sets the other forms, and canonicalizes everything.

Exceptions

MalformedTitleException On invalid titles

Returns: bool True on success

Definition at line 3744 of file Title.php.

References isExternal(), isSpecialPage(), setFragment(), and wfUrlencode().

◆ setContentModel()

Title::setContentModel ( $model )

Set a proposed content model for the page for permissions checking.

This does not actually change the content model of a title!

Additionally, you should make sure you've checked ContentHandler::canBeUsedOn() first.

Since: 1.28

Parameters

string $model CONTENT_MODEL_XXX constant

Definition at line 1022 of file Title.php.

Referenced by EditPage\internalAttemptSave(), and SpecialChangeContentModel\onSubmit().

◆ setFragment()

Title::setFragment ( $fragment )

Set the fragment for this title.

Removes the first character from the specified fragment before setting, so it assumes you're passing it with an initial "#".

Deprecated for public use, use Title::makeTitle() with fragment parameter, or Title::createFragmentTarget(). Still in active use privately.

Access:\n private

Parameters

string $fragment Text

Definition at line 1633 of file Title.php.

Referenced by secureAndSplit().

◆ touchLinks()

Title::touchLinks ( )

Update page_touched timestamps and send CDN purge messages for pages linking to this title.

May be sent to the job queue depending on the number of links. Typically called on create and delete.

Definition at line 4887 of file Title.php.

References NS_CATEGORY.

◆ userCan()

Title::userCan	(	$action,
		$user = `null`,
		$rigor = `'secure'`
	)

Can $user perform $action on this page?

Parameters

string	$action	Action that permission needs to be checked for
User \| null	$user	User to check (since 1.19); $wgUser will be used if not provided.
string	$rigor	Same format as Title::getUserPermissionsErrors()

Returns: bool

Definition at line 2182 of file Title.php.

References $user, and getUserPermissionsErrorsInternal().

Referenced by checkActionPermissions(), moveSubpages(), and quickUserCan().

◆ validateFileMoveOperation()

Title::validateFileMoveOperation ( $nt )

protected

Check if the requested move target is a valid file move target.

Todo:: move this to MovePage

Parameters

Title $nt Target title

Returns: array List of errors

Definition at line 4026 of file Title.php.

References wfFindFile(), and wfLocalFile().

◆ wasLocalInterwiki()

Title::wasLocalInterwiki ( )

Was this a local interwiki link?

Returns: bool

Definition at line 870 of file Title.php.

Member Data Documentation

◆ $mArticleID

int Title::$mArticleID = -1

Article ID, fetched from the link cache on demand.

Definition at line 88 of file Title.php.

◆ $mCascadeRestriction

bool Title::$mCascadeRestriction

Cascade restrictions on this page to included templates and images?

Definition at line 120 of file Title.php.

◆ $mCascadeSources

array Title::$mCascadeSources

Where are the cascading restrictions coming from on this page?

Definition at line 132 of file Title.php.

◆ $mCascadingRestrictions

Title::$mCascadingRestrictions

Caching the results of getCascadeProtectionSources.

Definition at line 123 of file Title.php.

◆ $mContentModel

bool string Title::$mContentModel = false

private

ID of the page's content model, i.e.

one of the CONTENT_MODEL_XXX constants

Definition at line 97 of file Title.php.

◆ $mDbkeyform

string Title::$mDbkeyform = ''

Main part with underscores.

Definition at line 70 of file Title.php.

◆ $mDbPageLanguage

string bool null Title::$mDbPageLanguage = false

private

The page language code from the database, null if not saved in the database or false if not loaded, yet.

Definition at line 174 of file Title.php.

◆ $mDefaultNamespace

int Title::$mDefaultNamespace = NS_MAIN

Namespace index when there is no namespace.

Don't change the following default, NS_MAIN is hardcoded in several places. See T2696. Zero except in {{transclusion}} tags.

Definition at line 155 of file Title.php.

◆ $mEstimateRevisions

int Title::$mEstimateRevisions

private

Estimated number of revisions; null of not loaded.

Definition at line 106 of file Title.php.

◆ $mForcedContentModel

bool Title::$mForcedContentModel = false

private

If a content model was forced via setContentModel() this will be true to avoid having other code paths reset it.

Definition at line 103 of file Title.php.

◆ $mFragment

string Title::$mFragment = ''

Title fragment (i.e.

the bit after the #)

Definition at line 85 of file Title.php.

◆ $mHasCascadingRestrictions

bool Title::$mHasCascadingRestrictions

protected

Are cascading restrictions in effect on this page?

Definition at line 129 of file Title.php.

◆ $mHasSubpages

bool Title::$mHasSubpages

private

Whether a page has any subpages.

Definition at line 167 of file Title.php.

◆ $mInterwiki

string Title::$mInterwiki = ''

Interwiki prefix.

Definition at line 79 of file Title.php.

◆ $mIsBigDeletion

bool Title::$mIsBigDeletion = null

private

Would deleting this page be a big deletion?

Definition at line 180 of file Title.php.

◆ $mLatestID

bool int Title::$mLatestID = false

protected

ID of most recent revision.

Definition at line 91 of file Title.php.

◆ $mLength

int Title::$mLength = -1

protected

The page length, 0 for special pages.

Definition at line 158 of file Title.php.

◆ $mLocalInterwiki

bool Title::$mLocalInterwiki = false

private

Was this Title created from a string with a local interwiki prefix?

Definition at line 82 of file Title.php.

◆ $mNamespace

int Title::$mNamespace = NS_MAIN

Namespace index, i.e.

one of the NS_xxxx constants

Definition at line 76 of file Title.php.

◆ $mNotificationTimestamp

array Title::$mNotificationTimestamp = []

private

Associative array of user ID -> timestamp/false.

Definition at line 164 of file Title.php.

◆ $mOldRestrictions

string bool Title::$mOldRestrictions = false

protected

Comma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows.

Edit and move sections are separated by a colon Example: "edit=autoconfirmed,sysop:move=sysop"

Definition at line 117 of file Title.php.

◆ $mPageLanguage

bool Title::$mPageLanguage = false

private

The (string) language code of the page's language and content code.

Definition at line 170 of file Title.php.

◆ $mRedirect

null Title::$mRedirect = null

Is the article at this title a redirect?

Definition at line 161 of file Title.php.

◆ $mRestrictions

array Title::$mRestrictions = []

Array of groups allowed to edit this article.

Definition at line 109 of file Title.php.

◆ $mRestrictionsExpiry

array Title::$mRestrictionsExpiry = []

protected

When do the restrictions on this page expire?

Definition at line 126 of file Title.php.

◆ $mRestrictionsLoaded

bool Title::$mRestrictionsLoaded = false

Boolean for initialisation on demand.

Definition at line 135 of file Title.php.

◆ $mTextform

string Title::$mTextform = ''

Text form (spaces not underscores) of the main part.

Definition at line 64 of file Title.php.

◆ $mTitleProtection

mixed Title::$mTitleProtection

Cached value for getTitleProtection (create protection)

Definition at line 148 of file Title.php.

◆ $mTitleValue

TitleValue Title::$mTitleValue = null

private

A corresponding TitleValue object.

Definition at line 177 of file Title.php.

◆ $mUrlform

string Title::$mUrlform = ''

URL-encoded form of the main part.

Definition at line 67 of file Title.php.

◆ $mUserCaseDBKey

string Title::$mUserCaseDBKey

protected

Database key with the initial letter in the case specified by the user.

Definition at line 73 of file Title.php.

◆ $prefixedText

string Title::$prefixedText = null

Text form including namespace/interwiki, initialised on demand.

Only public to share cache with TitleFormatter

Access:\n private

Definition at line 145 of file Title.php.

◆ $titleCache

MapCacheLRU Title::$titleCache = null

staticprivate

Definition at line 41 of file Title.php.

◆ CACHE_MAX

const Title::CACHE_MAX = 1000

Title::newFromText maintains a cache to avoid expensive re-normalization of commonly used titles.

On a batch operation this can become a memory leak if not bounded. After hitting this many titles reset the cache.

Definition at line 48 of file Title.php.

◆ GAID_FOR_UPDATE

const Title::GAID_FOR_UPDATE = 1

Used to be GAID_FOR_UPDATE define.

Used with getArticleID() and friends to use the master DB

Definition at line 54 of file Title.php.

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

includes/Title.php

Public Attributes

Static Private Attributes

Private member variables

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __toString()

◆ __wakeup()

◆ areCascadeProtectionSourcesLoaded()

◆ areRestrictionsCascading()

◆ areRestrictionsLoaded()

◆ canExist()

◆ canHaveTalkPage()

◆ canTalk()

◆ canUseNoindex()

◆ capitalize()

◆ checkActionPermissions()

◆ checkCascadingSourcesRestrictions()

◆ checkPageRestrictions()

◆ checkPermissionHooks()

◆ checkQuickPermissions()

◆ checkReadPermissions()

◆ checkSiteConfigPermissions()

◆ checkSpecialsAndNSPermissions()

◆ checkUserBlock()

◆ checkUserConfigPermissions()

◆ clearCaches()

◆ compare()

◆ convertByteClassToUnicodeClass()

◆ countAuthorsBetween()

◆ countRevisionsBetween()

◆ createFragmentTarget()

◆ deleteTitleProtection()

◆ equals()

◆ escapeFragmentForURL()

◆ estimateRevisionCount()

◆ exists()

◆ fixSpecialName()

◆ fixUrlQueryArgs()

◆ flushRestrictions()

◆ getAllRestrictions()

◆ getArticleID()

◆ getAuthorsBetween()

◆ getBacklinkCache()

◆ getBaseText()

◆ getBaseTitle()

◆ getBrokenLinksFrom()

◆ getCanonicalURL()

◆ getCascadeProtectionSources()

◆ getCategorySortkey()

◆ getCdnUrls()

◆ getContentModel()

◆ getDBkey()

◆ getDbPageLanguageCode()

◆ getDefaultMessageText()

◆ getDefaultNamespace()

◆ getEarliestRevTime()

◆ getEditNotices()

◆ getEditURL()

◆ getFilteredRestrictionTypes()

◆ getFirstRevision()

◆ getFragment()

◆ getFragmentForURL()

◆ getFullText()

◆ getFullURL()

◆ getFullUrlForRedirect()

◆ getInternalURL()

◆ getInterwiki()

◆ getInterwikiLookup()

◆ getLatestRevID()

◆ getLength()

◆ getLinksFrom()

◆ getLinksTo()

◆ getLinkURL()

◆ getLocalURL()

◆ getNamespace()

◆ getNamespaceKey()