Represents a title within MediaWiki. More...

Inheritance diagram for Title:

[legend]

Collaboration diagram for Title:

[legend]

Public Member Functions
	__clone ()

	__sleep ()

	__toString ()
	Return a string representation of this title.

	__wakeup ()

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

	areRestrictionsCascading ()
	Returns cascading restrictions for the current article.

	areRestrictionsLoaded ()
	Accessor for mRestrictionsLoaded.

	canExist ()
	Can this title represent a page in the wiki's database?

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

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

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

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

	equals (object $other)
	Compares with another Title.

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

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

	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.

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

	getAllRestrictions ()
	Accessor/initialisation for mRestrictions.

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

	getBacklinkCache ()
	Get a backlink cache object.

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

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

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

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

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

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

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

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

	getDBkey ()
	Get the main part with underscores.

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

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

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

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

	getEditURL ()
	Get the edit URL for this Title.

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

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

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

	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.

	getId ( $wikiId=self::LOCAL)
	Returns the page ID.

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

	getInterwiki ()
	Get the interwiki prefix.

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

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

	getLinksFrom ( $options=[], $table='pagelinks', $prefix='pl')
	Get an array of Title objects linked from this Title Also stores the IDs in 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.

	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.

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

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

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

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

	getNsText ()
	Get the namespace text.

	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.

	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.

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

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

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

	getPrefixedDBkey ()
	Get the prefixed database key form.

	getPrefixedText ()
	Get the prefixed title with spaces.

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

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

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

	getRestrictions ( $action)
	Accessor/initialisation for mRestrictions.

	getRestrictionTypes ()
	Returns restriction types for the current Title.

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

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

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

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

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

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

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

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

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

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

	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.

	getTemplateLinksFrom ( $options=[])
	Get an array of Title objects used on this Title as a template 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.

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

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

	getTitleValue ()
	Get a TitleValue object representing this Title.

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

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

	getWikiId ()
	Returns false to indicate that this Title belongs to the local wiki.

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

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

	hasFragment ()
	Check if a Title fragment is set.

	hasSourceText ()
	Does this page have source text?

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

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

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

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

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

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

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

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

	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?

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

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

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

	isExternal ()
	Is this Title interwiki?

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

	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 )

	isMainPage ()
	Is this the mainpage?

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

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

	isNewPage ()
	Check if this is a new page.

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

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

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

	isSameLinkAs (LinkTarget $other)

	isSamePageAs (PageReference $other)

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

	isSingleRevRedirect ()
	Locks the page row and check if this page is single revision redirect.

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

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

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

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

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

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

	isSubpage ()
	Is this a subpage?

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

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

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

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

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

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

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

	isValid ()
	Returns true if the title is a valid link target, and that it has been properly normalized.

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

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

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

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

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

	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.

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

	purgeSquid ()
	Purge all applicable CDN URLs.

	resetArticleID ( $id)
	Inject a page ID, reset DB-loaded fields, and clear the link cache for this title.

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

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

	toPageIdentity ()
	Returns the page represented by this Title as a ProperPageIdentity.

	toPageRecord ( $flags=0)
	Returns the page represented by this Title as a ProperPageRecord.

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

	wasLocalInterwiki ()
	Was this a local interwiki link?

Public Member Functions inherited from MediaWiki\Page\PageIdentity
	exists ()
	Checks if the page currently exists.

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
	assertWiki ( $wikiId)
	Throws if $wikiId is different from the return value of getWikiId().

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

static	castFromLinkTarget ( $linkTarget)
	Same as newFromLinkTarget, but if passed null, returns null.

static	castFromPageIdentity (?PageIdentity $pageIdentity)
	Return a Title for a given PageIdentity.

static	castFromPageReference (?PageReference $pageReference)
	Return a Title for a given Reference.

static	clearCaches ()

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

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

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

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

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

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	newFromDBkey ( $key)
	Create a new Title from a prefixed DB key.

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	newFromLinkTarget (LinkTarget $linkTarget, $forceClone='')
	Returns a Title given a LinkTarget.

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

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	newFromTitleValue (TitleValue $titleValue, $forceClone='')
	Returns a Title given a TitleValue.

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

static	newMainPage (MessageLocalizer $localizer=null)
	Create a new Title for the Main Page.

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

Public Attributes
const	GAID_FOR_UPDATE = 512
	Used to be GAID_FOR_UPDATE define().

const	NEW_CLONE = 'clone'
	Flag for use with factory methods like newFromLinkTarget() that have a $forceClone parameter.

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS)

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

Private Member Functions
	__construct ()

	assertProperPage ()
	Code that requires this Title to be a "proper page" in the sense defined by PageIdentity should call this method.

	findSubpageDivider ( $text, $dir)
	Finds the first or last subpage divider (slash) in the string.

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

	getLanguageConverter ( $language)
	Shorthand for getting a Language Converter for specific language.

	getPageLanguageConverter ()
	Shorthand for getting a Language Converter for page's language.

	hasSubpagesEnabled ()
	Whether this Title's namespace has subpages enabled.

	lazyFillContentModel ( $model)
	If the content model field is not frozen then update it with a retrieved value.

	loadFieldFromDB ( $field, $flags)

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

	secureAndSplit ( $text, $defaultNamespace=null)
	Secure and split - main initialisation function for this object.

	uncache ()
	Removes this instance from the internal title cache, so it can be modified in-place without polluting the cache (see T281337).

	warnIfPageCannotExist (Title $title, $method)

Static Private Member Functions
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.

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

static	getTitleCache ()

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

static	normalizeFragment ( $fragment)
	Normalizes fragment part of the title.

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

Static Private Attributes
static MapCacheLRU null	$titleCache = null

Private member variables
Please use the accessor functions instead. Access: internal
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.

bool	$mHasSubpages
	Whether a page has any subpages.

array null	$mPageLanguage
	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 null	$mTitleValue = null
	Was this Title created from a string with a local interwiki prefix?

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

bool null	$mIsValid = null
	Is the title known to be valid?

string null	$mInstanceCacheKey = null
	The key of this instance in the internal Title instance cache.

string	$mTextform = ''

string	$mUrlform = ''

string	$mDbkeyform = ''

int	$mNamespace = NS_MAIN

string	$mInterwiki = ''

string	$mFragment = ''

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

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

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

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

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

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

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 48 of file Title.php.

Constructor & Destructor Documentation

◆ __construct()

Title::__construct ( )

private

Definition at line 245 of file Title.php.

Member Function Documentation

◆ __clone()

Title::__clone ( )

Definition at line 4206 of file Title.php.

◆ __sleep()

Title::__sleep ( )

Returns: array

Definition at line 4189 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 1935 of file Title.php.

◆ __wakeup()

Title::__wakeup ( )

Definition at line 4200 of file Title.php.

References wfUrlencode().

◆ areCascadeProtectionSourcesLoaded()

Title::areCascadeProtectionSourcesLoaded ( )

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

Deprecated:: since 1.37, use RestrictionStore::areCascadeProtectionSourcesLoaded instead

Returns: bool

Since: 1.23

Definition at line 2580 of file Title.php.

◆ areRestrictionsCascading()

Title::areRestrictionsCascading ( )

Returns cascading restrictions for the current article.

Deprecated:: since 1.37, use RestrictionStore::areRestrictionsCascading instead

Returns: bool

Definition at line 2676 of file Title.php.

◆ areRestrictionsLoaded()

Title::areRestrictionsLoaded ( )

Accessor for mRestrictionsLoaded.

Deprecated:: since 1.37, use RestrictionStore::areRestrictionsLoaded instead

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

Since: 1.23

Definition at line 2620 of file Title.php.

◆ assertProperPage()

Title::assertProperPage ( )

private

Code that requires this Title to be a "proper page" in the sense defined by PageIdentity should call this method.

For the purpose of the Title class, a proper page is one that can exist in the page table. That is, a Title represents a proper page if canExist() returns true.

See also: canExist()

Exceptions

PreconditionException

Definition at line 4257 of file Title.php.

◆ canExist()

Title::canExist ( )

Can this title represent a page in the wiki's database?

Titles can exist as pages in the database if they are valid, and they are not Special pages, interwiki links, or fragment-only links.

See also: isValid()

Returns: bool true if and only if this title can be used to perform an edit.

Implements MediaWiki\Page\PageIdentity.

Definition at line 1236 of file Title.php.

Referenced by RequestContext\canUseWikiPage(), and UppercaseTitlesForUnicodeTransition\mungeTitle().

◆ canHaveTalkPage()

Title::canHaveTalkPage ( )

Can this title have a corresponding talk page?

False for relative section links (with getText() === ''), interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.

See also: NamespaceInfo::canHaveTalkPage

Since: 1.30

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

Definition at line 1222 of file Title.php.

◆ canUseNoindex()

Title::canUseNoindex ( )

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

Returns: bool

Definition at line 3938 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 3063 of file Title.php.

◆ castFromLinkTarget()

static Title::castFromLinkTarget ( $linkTarget )

static

Same as newFromLinkTarget, but if passed null, returns null.

Parameters

LinkTarget | null $linkTarget Assumed to be safe (if not null).

Returns: Title|null

Definition at line 319 of file Title.php.

◆ castFromPageIdentity()

static Title::castFromPageIdentity ( ?PageIdentity $pageIdentity )

static

Return a Title for a given PageIdentity.

If $pageIdentity is a Title, that Title is returned unchanged. If $pageIdentity is null, null is returned.

Since: 1.36

Parameters

PageIdentity | null $pageIdentity

Returns: Title|null

Definition at line 332 of file Title.php.

◆ castFromPageReference()

static Title::castFromPageReference ( ?PageReference $pageReference )

static

Return a Title for a given Reference.

If $pageReference is a Title, that Title is returned unchanged. If $pageReference is null, null is returned.

Since: 1.37

Parameters

PageReference | null $pageReference

Returns: Title|null

Definition at line 345 of file Title.php.

◆ clearCaches()

static Title::clearCaches ( )

static

Definition at line 3048 of file Title.php.

◆ compare()

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

static

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

Parameters

LinkTarget \| PageReference	$a
LinkTarget \| PageReference	$b

Returns: int Result of string comparison, or namespace comparison

Definition at line 893 of file Title.php.

◆ 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 760 of file Title.php.

◆ 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 1854 of file Title.php.

Referenced by SpecialWhatLinksHere\listItem().

◆ deleteTitleProtection()

Title::deleteTitleProtection ( )

Remove any title protection due to page existing.

Deprecated:: since 1.37, do not use (this is only for WikiPage::onArticleCreate)

Definition at line 2502 of file Title.php.

◆ equals()

Title::equals ( object $other )

Compares with another Title.

A Title object is considered equal to another Title if it has the same text, the same interwiki prefix, and the same namespace.

Note: This is different from isSameLinkAs(), which also compares the fragment part, and from isSamePageAs(), which takes into account the page ID.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam

Parameters

object $other

Returns: bool true if $other is a Title and refers to the same page.

Definition at line 3499 of file Title.php.

Referenced by MediaWiki\Block\Restriction\PageRestriction\matches(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\Revision\RenderedRevision\setRevisionInternal().

◆ estimateRevisionCount()

Title::estimateRevisionCount ( )

Get the approximate revision count of this page.

Returns: int

Definition at line 3471 of file Title.php.

References $dbr, DB_REPLICA, 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 Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: bool

Definition at line 3572 of file Title.php.

Referenced by RedirectSpecialArticle\getRedirectQuery(), SpecialUpload\getUploadForm(), and UppercaseTitlesForUnicodeTransition\mungeTitle().

◆ findSubpageDivider()

Title::findSubpageDivider	(	$text,
		$dir
	)

private

Finds the first or last subpage divider (slash) in the string.

Any leading sequence of slashes is ignored, since it does not divide two parts of the string. Considering leading slashes dividers would result in empty root title or base title (T229443).

Note that trailing slashes are considered dividers, and empty subpage names are allowed.

Parameters

string	$text
int	$dir	-1 for the last or +1 for the first divider.

Returns: false|int

Definition at line 1967 of file Title.php.

◆ 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 1321 of file Title.php.

References 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 2173 of file Title.php.

References wfArrayToCgi(), and wfDeprecatedMsg().

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

Deprecated:: since 1.37, now internal

Definition at line 2724 of file Title.php.

◆ getAllRestrictions()

Title::getAllRestrictions ( )

Accessor/initialisation for mRestrictions.

Deprecated:: since 1.37, use RestrictionStore::getAllRestrictions instead

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

Since: 1.23

Definition at line 2650 of file Title.php.

◆ getArticleID()

Title::getArticleID ( $flags = 0 )

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

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: int The ID

Definition at line 2902 of file Title.php.

Referenced by MediaWiki\Preferences\MultiTitleFilter\filterFromForm(), NamespaceDupes\mergePage(), and MediaWiki\Block\Restriction\PageRestriction\newFromTitle().

◆ getBacklinkCache()

Title::getBacklinkCache ( )

Get a backlink cache object.

Deprecated:: since 1.37, use BacklinkCacheFactory::getBacklinkCache()

Returns: BacklinkCache

Definition at line 3927 of file Title.php.

◆ getBaseText()

Title::getBaseText ( )

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

the part before the subpage name

Note: the return value may contain trailing whitespace and is thus not safe for use with makeTitle or TitleValue.

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:383

Returns: string Base name

Definition at line 2055 of file Title.php.

◆ 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

Since: 1.20

Definition at line 2082 of file Title.php.

References $title.

◆ 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[]

Definition at line 3260 of file Title.php.

References $dbr, $res, DB_REPLICA, 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 \| array	$query
string \| bool	$query2	Deprecated

Returns: string The URL

Since: 1.18

Definition at line 2433 of file Title.php.

References PROTO_CANONICAL, and wfExpandUrl().

◆ getCascadeProtectionSources()

Title::getCascadeProtectionSources ( $getPages = true )

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

Deprecated:: since 1.37, use RestrictionStore::getCascadeProtectionSources instead

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 if $getPages is true, or a bool indicating whetehr any cascading protection applies if $getPages was set to false. Second is an array like that returned by Title::getAllRestrictions(), or an empty array if $getPages is false.

Definition at line 2600 of file Title.php.

◆ 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 3957 of file Title.php.

◆ getCdnUrls()

Title::getCdnUrls ( )

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

Deprecated:: 1.35 Use HtmlCacheUpdater

Returns: string[]

Definition at line 3296 of file Title.php.

◆ getContentModel()

Title::getContentModel ( $flags = 0 )

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

Todo:: Deprecate this in favor of SlotRecord::getModel()

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: string Content model id

Definition at line 1090 of file Title.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\__construct(), SpecialChangeContentModel\getOptionsForTitle(), and SpecialWhatLinksHere\wlhLink().

◆ 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 1069 of file Title.php.

Referenced by ArchivedFile\__construct(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), UploadBase\getTitle(), WikiPage\insertRedirectEntry(), ForeignAPIFile\newFromTitle(), RefreshLinks\refreshCategory(), UppercaseTitlesForUnicodeTransition\shouldDelete(), and SpecialWhatLinksHere\showIndirectLinks().

◆ 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 3983 of file Title.php.

References $wgPageLanguageUseDB.

◆ 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 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 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 3716 of file Title.php.

References $lang, NS_MEDIAWIKI, and wfMessage().

◆ getDefaultNamespace()

Title::getDefaultNamespace ( )

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

Deprecated:: since 1.37, no callers, should be removed.

Returns: int Default namespace index

Definition at line 1786 of file Title.php.

References wfDeprecated().

◆ getDeletedEditsCount()

Title::getDeletedEditsCount ( )

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

Since: 1.36

Returns: int The number of archived revisions

Definition at line 2841 of file Title.php.

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

◆ 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: string[]

Definition at line 4094 of file Title.php.

References 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 2445 of file Title.php.

References $s.

◆ getFilteredRestrictionTypes()

static Title::getFilteredRestrictionTypes ( $exists = true )

static

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

Deprecated:: since 1.37, use RestrictionStore::listAllRestrictionTypes instead

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 2464 of file Title.php.

◆ 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 1798 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 1817 of file Title.php.

◆ 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 1945 of file Title.php.

Referenced by 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 \| array	$query
string \| string[] \| bool	$query2
string \| int \| null	$proto	Protocol type to use in URL

Returns: string The URL

Definition at line 2211 of file Title.php.

References wfExpandUrl().

Referenced by 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 2244 of file Title.php.

References SpecialPage\getTitleFor().

◆ getId()

Title::getId ( $wikiId = self::LOCAL )

Returns the page ID.

If this ID is 0, this means the page does not exist.

See also: getArticleID()

Since: 1.36, since 1.35.6 as an alias of getArticleId()

Parameters

string | false $wikiId The wiki ID expected by the caller.

Exceptions

PreconditionException	if this Title instance does not represent a proper page, that is, if it is a section link, interwiki link, link to a special page, or such.
PreconditionException	if $wikiId is not false.

Returns: int

Implements MediaWiki\Page\PageIdentity.

Definition at line 4239 of file Title.php.

◆ 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 \| array	$query
string \| bool	$query2	Deprecated

Returns: string The URL

Definition at line 2411 of file Title.php.

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

◆ 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 979 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 241 of file Title.php.

◆ getLanguageConverter()

Title::getLanguageConverter ( $language )

private

Shorthand for getting a Language Converter for specific language.

Parameters

Language $language Language of converter

Returns: ILanguageConverter

Definition at line 208 of file Title.php.

References getLanguageConverter().

Referenced by getLanguageConverter().

◆ getLatestRevID()

Title::getLatestRevID ( $flags = 0 )

What is the page_latest field for this page?

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

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

Definition at line 2993 of file Title.php.

Referenced by RefreshLinksJob\getCurrentRevisionIfUnchanged().

◆ getLength()

Title::getLength ( $flags = 0 )

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

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: int

Definition at line 2966 of file Title.php.

◆ 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: Title[] List of Titles linking here

Definition at line 3194 of file Title.php.

References $res, DB_REPLICA, and wfGetDB().

◆ 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[]

Definition at line 3136 of file Title.php.

References $res, DB_PRIMARY, DB_REPLICA, and wfGetDB().

◆ 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 \| array	$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 2386 of file Title.php.

◆ 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 \| array	$query	An optional query string, not used for interwiki links. Can be specified as an associative array as well, e.g., [ '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

Definition at line 2278 of file Title.php.

References $matches, $wgActionPaths, $wgArticlePath, $wgMainPageIsDomainRoot, $wgRequest, $wgScript, $wgServer, $wgVariantArticlePath, wfAppendQuery(), and wfUrlencode().

Referenced by SkinTemplate\buildContentNavigationUrls().

◆ 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 1078 of file Title.php.

Referenced by SubpageImportTitleFactory\__construct(), LinkHolderArray\doVariants(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), WikiPage\insertRedirectEntry(), LinkHolderArray\makeHolder(), WikitextContentHandler\makeRedirectContent(), MediaWiki\Block\Restriction\NamespaceRestriction\matches(), UppercaseTitlesForUnicodeTransition\mungeTitle(), ImageQueryPage\outputResults(), UppercaseTitlesForUnicodeTransition\shouldDelete(), MovePageForm\showForm(), and SpecialWhatLinksHere\showIndirectLinks().

◆ 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 3831 of file Title.php.

◆ getNotificationTimestamp()

Title::getNotificationTimestamp ( User $user )

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

Deprecated:: since 1.35

Parameters

User $user

Returns: string|bool|null String timestamp, false if not watched, null if nothing is unseen

Definition at line 3819 of file Title.php.

◆ getNsText()

Title::getNsText ( )

Get the namespace text.

Returns: string|false Namespace text

Definition at line 1169 of file Title.php.

References wfDebug().

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

Deprecated:: since 1.34, use NamespaceInfo::getAssociatedPage

Since: 1.25

Exceptions

MWException If the page doesn't have an other page

Returns: Title

Definition at line 1760 of file Title.php.

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

Definition at line 4005 of file Title.php.

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

◆ getPageLanguageConverter()

Title::getPageLanguageConverter ( )

private

Shorthand for getting a Language Converter for page's language.

Returns: ILanguageConverter

Definition at line 217 of file Title.php.

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

Definition at line 4046 of file Title.php.

References $wgLang, and wfGetLangObj().

◆ getParentCategories()

Title::getParentCategories ( )

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

Returns: string[] Array of parents in the form: $parent => $currentarticle

Definition at line 3355 of file Title.php.

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

◆ 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 3390 of file Title.php.

◆ getPartialURL()

Title::getPartialURL ( )

Get the URL-encoded form of the main part.

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

Definition at line 1060 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 1909 of file Title.php.

References $s.

Referenced by PPTemplateFrame_Hash\__construct(), PPFrame_Hash\loopCheck(), and LinkHolderArray\makeHolder().

◆ 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 1921 of file Title.php.

References $s.

Referenced by ApiPageSet\loadRedirectTargets(), CleanupCaps\movePage(), UppercaseTitlesForUnicodeTransition\mungeTitle(), 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 2154 of file Title.php.

References $s, and wfUrlencode().

◆ 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[]

Definition at line 3860 of file Title.php.

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

◆ getRestrictionExpiry()

Title::getRestrictionExpiry ( $action )

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

Deprecated:: since 1.37, use RestrictionStore::getRestrictionExpiry instead

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 2663 of file Title.php.

◆ getRestrictions()

Title::getRestrictions ( $action )

Accessor/initialisation for mRestrictions.

Deprecated:: since 1.37, use RestrictionStore::getRestrictions instead

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 2637 of file Title.php.

◆ getRestrictionTypes()

Title::getRestrictionTypes ( )

Returns restriction types for the current Title.

Deprecated:: since 1.37, use RestrictionStore::listApplicableRestrictionTypes instead

Returns: array Applicable restriction types

Definition at line 2477 of file Title.php.

◆ getRootText()

Title::getRootText ( )

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

the leftmost part before any slashes

Note: the return value may contain trailing whitespace and is thus not safe for use with makeTitle or TitleValue.

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

# returns: 'Foo'

Returns: string Root name

Since: 1.20

Definition at line 2005 of file Title.php.

◆ 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

Since: 1.20

Definition at line 2032 of file Title.php.

References $title.

◆ getSelectFields()

static Title::getSelectFields ( )

staticprotected

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

Deprecated:: since 1.36, use PageStore::newSelectQueryBuilder() instead.

Returns: array

Definition at line 518 of file Title.php.

◆ 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 1510 of file Title.php.

◆ getSubjectNsText()

Title::getSubjectNsText ( )

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

Returns: string Namespace text

Definition at line 1194 of file Title.php.

◆ getSubjectPage()

Title::getSubjectPage ( )

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

Deprecated:: since 1.34, use NamespaceInfo::getSubjectPage

Returns: Title The object for the subject page

Definition at line 1703 of file Title.php.

References $title.

◆ 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|null Subpage title, or null on an error

Since: 1.20

Definition at line 2129 of file Title.php.

◆ 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 2802 of file Title.php.

References TitleArray\newFromResult().

◆ 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 2102 of file Title.php.

◆ getSubpageUrlForm()

Title::getSubpageUrlForm ( )

Get a URL-encoded form of the subpage text.

Returns: string URL-encoded subpage name

Definition at line 2143 of file Title.php.

References wfUrlencode().

◆ getTalkNsText()

Title::getTalkNsText ( )

Get the namespace text of the talk page.

Returns: string Namespace text

Definition at line 1205 of file Title.php.

◆ getTalkPage()

Title::getTalkPage ( )

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

Deprecated:: since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage() with NamespaceInfo::canHaveTalkPage(). Note that the new method will throw if asked for the talk page of a section-only link, or of an interwiki link.

Returns: Title The object for the talk page

Exceptions

MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL or because it's a relative link, or an interwiki link.

Definition at line 1658 of file Title.php.

References $title.

Referenced by MovePageForm\showForm().

◆ 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 1688 of file Title.php.

◆ 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[]

Definition at line 3248 of file Title.php.

◆ 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[]

Definition at line 3178 of file Title.php.

◆ 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 1051 of file Title.php.

Referenced by TraditionalImageGallery\getCaptionHtml(), UppercaseTitlesForUnicodeTransition\mungeTitle(), and MovePageForm\showForm().

◆ getTitleCache()

static Title::getTitleCache ( )

staticprivate

Returns: MapCacheLRU

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

Deprecated:: since 1.37, use RestrictionStore::getRestrictions() instead

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

Definition at line 2492 of file Title.php.

◆ 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 1028 of file Title.php.

References wfDebug().

◆ getTouched()

Title::getTouched ( $db = null )

Get the last touched timestamp.

Parameters

IDatabase | null $db

Returns: string|false Last-touched timestamp

Definition at line 3803 of file Title.php.

References DB_REPLICA, 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 1011 of file Title.php.

◆ getWikiId()

Title::getWikiId ( )

Returns false to indicate that this Title belongs to the local wiki.

Note: The behavior of this method if considered undefined for interwiki links. At the moment, this method always returns false. But this may change in the future.

Since: 1.36

Returns: bool false

Implements MediaWiki\Page\PageReference.

Definition at line 4219 of file Title.php.

◆ 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 1123 of file Title.php.

◆ hasDeletedEdits()

Title::hasDeletedEdits ( )

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

Since: 1.36

Returns: bool

Definition at line 2877 of file Title.php.

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

◆ hasFragment()

Title::hasFragment ( )

Check if a Title fragment is set.

Returns: bool

Since: 1.23

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1808 of file Title.php.

Referenced by CoreParserFunctions\displaytitle().

◆ hasSourceText()

Title::hasSourceText ( )

Does this page have source text?

Returns: bool

Definition at line 3657 of file Title.php.

References NS_MEDIAWIKI, and wfMessage().

◆ 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 1384 of file Title.php.

◆ hasSubpages()

Title::hasSubpages ( )

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

Returns: bool

Definition at line 2774 of file Title.php.

◆ hasSubpagesEnabled()

Title::hasSubpagesEnabled ( )

private

Whether this Title's namespace has subpages enabled.

Returns: bool

Definition at line 1985 of file Title.php.

◆ 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 1345 of file Title.php.

◆ inNamespaces()

Title::inNamespaces ( $namespaces )

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 1357 of file Title.php.

◆ 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 3739 of file Title.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\getDomainID(), Wikimedia\Rdbms\IDatabase\timestamp(), Wikimedia\Rdbms\IDatabase\update(), wfGetDB(), and wfReadOnly().

◆ 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 3594 of file Title.php.

References NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, and NS_SPECIAL.

◆ isBigDeletion()

Title::isBigDeletion ( )

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

Deprecated:: since 1.37 External callers shouldn't need to know about this.

Returns: bool

Definition at line 3442 of file Title.php.

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

◆ isCascadeProtected()

Title::isCascadeProtected ( )

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

Deprecated:: since 1.37, use RestrictionStore::isCascadeProtected instead

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

Definition at line 2567 of file Title.php.

◆ 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 1396 of file Title.php.

◆ isConversionTable()

Title::isConversionTable ( )

Is this a conversion table for the LanguageConverter?

Returns: bool

Definition at line 1452 of file Title.php.

References NS_MEDIAWIKI.

◆ isDeleted()

Title::isDeleted ( )

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

Deprecated:: since 1.36. Use self::getDeletedEditsCount()

Returns: int The number of archived revisions

Definition at line 2831 of file Title.php.

◆ isDeletedQuick()

Title::isDeletedQuick ( )

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

Deprecated:: since 1.36, Use self::hasDeletedEdits()

Returns: bool

Definition at line 2867 of file Title.php.

◆ isExternal()

Title::isExternal ( )

Is this Title interwiki?

Returns: bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 968 of file Title.php.

Referenced by DoubleRedirectJob\getFinalDestination(), and LinkHolderArray\makeHolder().

◆ 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 3648 of file Title.php.

◆ 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 953 of file Title.php.

◆ 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 1431 of file Title.php.

◆ 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 1407 of file Title.php.

◆ isNamespaceProtected()

Title::isNamespaceProtected ( User $user )

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

Deprecated:: since 1.34, hard-deprecated since 1.37

Parameters

User $user User object to check permissions

Returns: bool

Definition at line 2544 of file Title.php.

References $wgNamespaceProtection, and wfDeprecated().

◆ isNewPage()

Title::isNewPage ( )

Check if this is a new page.

Returns: bool

Definition at line 3431 of file Title.php.

References $dbr, DB_REPLICA, and wfGetDB().

◆ isProtected()

Title::isProtected ( $action = '' )

Does the title correspond to a protected article?

Deprecated:: since 1.37, use RestrictionStore::isProtected instead

Parameters

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

Returns: bool

Definition at line 2530 of file Title.php.

◆ isRawHtmlMessage()

Title::isRawHtmlMessage ( )

Is this a message which can contain raw HTML?

Returns: bool

Since: 1.32

Definition at line 1627 of file Title.php.

References $wgRawHtmlMessages, and NS_MEDIAWIKI.

◆ isRedirect()

Title::isRedirect ( $flags = 0 )

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

This is intended to provide fast access to page_is_redirect for linking. In rare cases, there might not be a valid target in the redirect table even though this function returns true.

To find a redirect target, just call WikiPage::getRedirectTarget() and check if it returns null, there's no need to call this first.

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: bool

Definition at line 2941 of file Title.php.

◆ isSameLinkAs()

Title::isSameLinkAs ( LinkTarget $other )

See also: LinkTarget::isSameLinkAs()

Since: 1.36

Parameters

LinkTarget $other

Returns: bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 3519 of file Title.php.

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

◆ isSamePageAs()

Title::isSamePageAs ( PageReference $other )

See also: PageReference::isSamePageAs()

Since: 1.36

Parameters

PageReference $other

Returns: bool

Implements MediaWiki\Page\PageReference.

Definition at line 3535 of file Title.php.

◆ isSemiProtected()

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

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

Deprecated:: since 1.37, use RestrictionStore::isSemiProtected instead

Parameters

string $action Action to check (default: edit)

Returns: bool

Definition at line 2515 of file Title.php.

◆ isSingleRevRedirect()

Title::isSingleRevRedirect ( )

Locks the page row and check if this page is single revision redirect.

This updates the cached fields of this instance via Title::loadFromRow()

Returns: bool

Definition at line 3317 of file Title.php.

References DB_PRIMARY, 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 1482 of file Title.php.

◆ isSiteCssConfigPage()

Title::isSiteCssConfigPage ( )

Is this a sitewide CSS "config" page?

Returns: bool

Since: 1.32

Definition at line 1573 of file Title.php.

References CONTENT_MODEL_CSS, and NS_MEDIAWIKI.

◆ isSiteJsConfigPage()

Title::isSiteJsConfigPage ( )

Is this a sitewide JS "config" page?

Returns: bool

Since: 1.31

Definition at line 1609 of file Title.php.

References CONTENT_MODEL_JAVASCRIPT, and NS_MEDIAWIKI.

◆ isSiteJsonConfigPage()

Title::isSiteJsonConfigPage ( )

Is this a sitewide JSON "config" page?

Returns: bool

Since: 1.32

Definition at line 1591 of file Title.php.

References CONTENT_MODEL_JSON, and NS_MEDIAWIKI.

◆ 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 1303 of file Title.php.

◆ isSpecialPage()

Title::isSpecialPage ( )

Returns true if this is a special page.

Returns: bool

Definition at line 1293 of file Title.php.

References NS_SPECIAL.

Referenced by SkinTemplate\buildPersonalUrls().

◆ isSubpage()

Title::isSubpage ( )

Is this a subpage?

Returns: bool

Definition at line 1440 of file Title.php.

◆ isSubpageOf()

Title::isSubpageOf ( Title $title )

Check if this title is a subpage of another title.

Parameters

Title $title

Returns: bool

Definition at line 3556 of file Title.php.

References $title.

◆ isTalkPage()

Title::isTalkPage ( )

Is this a talk page of some sort?

Returns: bool

Definition at line 1642 of file Title.php.

◆ 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 998 of file Title.php.

◆ 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 1496 of file Title.php.

◆ isUserCssConfigPage()

Title::isUserCssConfigPage ( )

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

Returns: bool

Since: 1.31

Definition at line 1531 of file Title.php.

References CONTENT_MODEL_CSS, and NS_USER.

◆ isUserJsConfigPage()

Title::isUserJsConfigPage ( )

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

Returns: bool

Since: 1.31

Definition at line 1559 of file Title.php.

References CONTENT_MODEL_JAVASCRIPT, and NS_USER.

◆ isUserJsonConfigPage()

Title::isUserJsonConfigPage ( )

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

Returns: bool

Since: 1.31

Definition at line 1545 of file Title.php.

References CONTENT_MODEL_JSON, and NS_USER.

◆ isValid()

Title::isValid ( )

Returns true if the title is a valid link target, and that it has been properly normalized.

This method checks that the title is syntactically valid, and that the namespace it refers to exists.

Titles constructed using newFromText() or makeTitleSafe() are always valid.

Note: Code that wants to check whether the title can represent a page that can be created and edited should use canExist() instead. Examples of valid titles that cannot "exist" are Special pages, interwiki links, and on-page section links that only have the fragment part set.

See also: canExist()

Returns: bool

Definition at line 914 of file Title.php.

◆ isValidRedirectTarget()

Title::isValidRedirectTarget ( )

Check if this Title is a valid redirect target.

Returns: bool

Definition at line 3896 of file Title.php.

References $wgInvalidRedirectTargets.

Referenced by AbstractContent\getRedirectChain(), WikitextContent\getRedirectTargetAndText(), WikiPage\insertRedirectEntry(), and XmlDumpWriter\openPage().

◆ isWatchable()

Title::isWatchable ( )

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

False for relative section links (with getText() === ''), interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.

Deprecated:: since 1.37, use WatchlistManager::isWatchable instead.

Returns: bool

Definition at line 1282 of file Title.php.

References $watchlistManager, and wfDeprecated().

Referenced by SpecialEditWatchlist\extractTitles().

◆ isWikitextPage()

Title::isWikitextPage ( )

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

Returns: bool

Definition at line 1464 of file Title.php.

References CONTENT_MODEL_WIKITEXT.

◆ lazyFillContentModel()

Title::lazyFillContentModel ( $model )

private

If the content model field is not frozen then update it with a retrieved value.

Parameters

string | bool $model CONTENT_MODEL_XXX constant or false

Definition at line 1158 of file Title.php.

◆ 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 746 of file Title.php.

References $wgLegalTitleChars.

◆ loadFieldFromDB()

Title::loadFieldFromDB	(	$field,
		$flags
	)

private

Parameters

string	$field
int	$flags	Bitfield of class READ_* constants

Returns: string|bool

Definition at line 4169 of file Title.php.

References wfGetDB().

◆ 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 592 of file Title.php.

◆ loadRestrictions()

Title::loadRestrictions	(	$oldFashionedRestrictions = `null`,
		$flags = `0`
	)

Load restrictions from the page_restrictions table.

Deprecated:: since 1.37, no public replacement

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"
int	$flags	A bit field. If self::READ_LATEST is set, skip replicas and read from the primary DB.

Definition at line 2713 of file Title.php.

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

Deprecated:: since 1.37, use RestrictionStore::loadRestrictionsFromRows instead

Parameters

stdClass[]	$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 2695 of file Title.php.

◆ 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 866 of file Title.php.

References $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 651 of file Title.php.

References $t, $title, 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.

The Title object returned by this method is guaranteed to be valid. Call canExist() to check if the Title represents an editable page.

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 677 of file Title.php.

References $t, and $title.

◆ 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 256 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	Bitfield of class READ_* constants

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

Definition at line 529 of file Title.php.

References $title, 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 554 of file Title.php.

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

◆ newFromLinkTarget()

static Title::newFromLinkTarget	(	LinkTarget	$linkTarget,
			$forceClone = `''`
	)

static

Returns a Title given a LinkTarget.

If the given LinkTarget is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget is already a Title instance, that instance is copied using the clone operator.

Parameters

LinkTarget	$linkTarget	Assumed to be safe.
string	$forceClone	set to NEW_CLONE to ensure a fresh instance is returned.

Returns: Title

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

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

Decodes any HTML entities in the text. Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.

Note: The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.

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 if the Title could not be parsed because it is invalid.

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

Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.

Note: The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.

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 418 of file Title.php.

References $t, and NS_MAIN.

◆ newFromTitleValue()

static Title::newFromTitleValue	(	TitleValue	$titleValue,
			$forceClone = `''`
	)

static

Returns a Title given a TitleValue.

If the given TitleValue is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue is already a Title instance, that instance is copied using the clone operator.

Deprecated:: since 1.34, use newFromLinkTarget or castFromLinkTarget

Parameters

TitleValue	$titleValue	Assumed to be safe.
string	$forceClone	set to NEW_CLONE to ensure a fresh instance is returned.

Returns: Title

Definition at line 280 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( $request->getText( 'title' ) );

Example of right code: $title = Title::newFromText( $request->getText( '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 480 of file Title.php.

References $t.

◆ newMainPage()

static Title::newMainPage ( MessageLocalizer $localizer = null )

static

Create a new Title for the Main Page.

This uses the 'mainpage' interface message, which could be specified in $wgForceUIMsgAsContentMsg. If that is the case, then calling this method will use the user language, which would involve initialising the session via RequestContext::getMain()->getLanguage(). For session-less endpoints, be sure to pass in a MessageLocalizer (such as your own RequestContext, or ResourceloaderContext) to prevent an error.

Note: The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.

Parameters

MessageLocalizer | null $localizer An optional context to use (since 1.34)

Returns: Title

Definition at line 713 of file Title.php.

References $title, and wfMessage().

◆ normalizeFragment()

static Title::normalizeFragment ( $fragment )

staticprivate

Normalizes fragment part of the title.

Parameters

string $fragment

Returns: string

Definition at line 1869 of file Title.php.

◆ 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 3417 of file Title.php.

◆ 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 1883 of file Title.php.

References NS_SPECIAL.

◆ 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 2733 of file Title.php.

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

◆ purgeSquid()

Title::purgeSquid ( )

Purge all applicable CDN URLs.

Deprecated:: 1.35 Use HtmlCacheUpdater

Definition at line 3305 of file Title.php.

◆ resetArticleID()

Title::resetArticleID ( $id )

Inject a page ID, reset DB-loaded fields, and clear the link cache for this title.

This can be called on page insertion to allow loading of the new page_id without having to create a new Title instance. Likewise with deletion.

This is also used during page moves, to reflect the change in the relationship between article ID and title text.

Note: This overrides Title::setContentModel()

Parameters

int | bool $id Page ID, 0 for non-existant, or false for "unknown" (lazy-load)

Definition at line 3028 of file Title.php.

◆ secureAndSplit()

Title::secureAndSplit	(	$text,
		$defaultNamespace = `null`
	)

private

Secure and split - main initialisation function for this object.

Assumes that $text 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.

If this method returns normally, the Title is valid.

Parameters

string	$text
int \| null	$defaultNamespace

Exceptions

MalformedTitleException On malformed titles

Definition at line 3088 of file Title.php.

References 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 in the DB. It only affects this particular Title instance. The content model is forced to remain this value until another setContentModel() call.

ContentHandler::canBeUsedOn() should be checked before calling this if there is any doubt regarding the applicability of the content model

Warning: This must only be used if the caller controls the further use of this Title object, to avoid other code unexpectedly using the new value.

Since: 1.28

Parameters

string $model CONTENT_MODEL_XXX constant

Definition at line 1143 of file Title.php.

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

Warning: This must only be used if the caller controls the further use of this Title object, to avoid other code unexpectedly using the new value.

Parameters

string $fragment Text

Definition at line 1842 of file Title.php.

◆ toPageIdentity()

Title::toPageIdentity ( )

Returns the page represented by this Title as a ProperPageIdentity.

The ProperPageIdentity returned by this method is guaranteed to be immutable. If this Title does not represent a proper page, an exception is thrown.

It is preferred to use this method rather than using the Title as a PageIdentity directly.

Returns: ProperPageIdentity

Exceptions

PreconditionException if the page is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such.

Since: 1.36

Definition at line 4276 of file Title.php.

◆ toPageRecord()

Title::toPageRecord ( $flags = 0 )

Returns the page represented by this Title as a ProperPageRecord.

The PageRecord returned by this method is guaranteed to be immutable, the page is guaranteed to exist.

Note: For now, this method queries the database on every call.

Since: 1.36

Parameters

int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE

Returns: ExistingPageRecord

Exceptions

PreconditionException if the page does not exist, or is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such.

Definition at line 4303 of file Title.php.

◆ 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 3779 of file Title.php.

References HTMLCacheUpdateJob\newForBacklinks(), and NS_CATEGORY.

◆ uncache()

Title::uncache ( )

private

Removes this instance from the internal title cache, so it can be modified in-place without polluting the cache (see T281337).

Definition at line 457 of file Title.php.

◆ warnIfPageCannotExist()

Title::warnIfPageCannotExist	(	Title	$title,
			$method
	)

private

Parameters

Title	$title
string	$method

Returns: bool whether a warning was issued

Definition at line 1729 of file Title.php.

References $title, and wfLogWarning().

◆ wasLocalInterwiki()

Title::wasLocalInterwiki ( )

Was this a local interwiki link?

Returns: bool

Definition at line 988 of file Title.php.

Member Data Documentation

◆ $mArticleID

int Title::$mArticleID = -1

Article ID, fetched from the link cache on demand.

Definition at line 132 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 141 of file Title.php.

◆ $mDbkeyform

string Title::$mDbkeyform = ''

Deprecated:: since 1.37 directly accessing this member, use the ::getDBkey() method instead. Main part with underscores

Definition at line 105 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 185 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. Used primarily for {{transclusion}} tags.

See also: newFromText()

Definition at line 168 of file Title.php.

◆ $mEstimateRevisions

int Title::$mEstimateRevisions

private

Estimated number of revisions; null of not loaded.

Definition at line 150 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 147 of file Title.php.

◆ $mFragment

string Title::$mFragment = ''

Deprecated:: since 1.37 Avoid directly accessing this member, use the ::getFragment() method instead. Title fragment (i.e. the bit after the #)

Definition at line 129 of file Title.php.

◆ $mHasSubpages

bool Title::$mHasSubpages

private

Whether a page has any subpages.

Definition at line 177 of file Title.php.

◆ $mInstanceCacheKey

string null Title::$mInstanceCacheKey = null

private

The key of this instance in the internal Title instance cache.

Definition at line 197 of file Title.php.

◆ $mInterwiki

string Title::$mInterwiki = ''

Deprecated:: since 1.37 Avoid directly accessing this member, use the ::getInterwiki() method instead. Interwiki prefix

Definition at line 119 of file Title.php.

◆ $mIsBigDeletion

bool null Title::$mIsBigDeletion = null

private

Would deleting this page be a big deletion?

Definition at line 191 of file Title.php.

◆ $mIsValid

bool null Title::$mIsValid = null

private

Is the title known to be valid?

Definition at line 194 of file Title.php.

◆ $mLatestID

bool int Title::$mLatestID = false

protected

ID of most recent revision.

Definition at line 135 of file Title.php.

◆ $mLength

int Title::$mLength = -1

protected

The page length, 0 for special pages.

Definition at line 171 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 122 of file Title.php.

◆ $mNamespace

int Title::$mNamespace = NS_MAIN

Deprecated:: sine 1.37 Avoid directly accessing this member, use the ::getNamespace() method instead Namespace index, i.e. one of the NS_xxxx constants

Definition at line 112 of file Title.php.

◆ $mPageLanguage

array null Title::$mPageLanguage

private

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

Definition at line 180 of file Title.php.

◆ $mRedirect

null bool Title::$mRedirect = null

Is the article at this title a redirect?

Definition at line 174 of file Title.php.

◆ $mTextform

string Title::$mTextform = ''

Deprecated:: since 1.37 directly accessing this member, use the ::getText() method instead. Text form (spaces not underscores) of the main part

Definition at line 91 of file Title.php.

◆ $mTitleValue

TitleValue null Title::$mTitleValue = null

private

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

Definition at line 188 of file Title.php.

◆ $mUrlform

string Title::$mUrlform = ''

Deprecated:: since 1.37 directly accessing this member, use the ::getPartialURL() method instead. URL-encoded form of the main part

Definition at line 98 of file Title.php.

◆ $prefixedText

string null Title::$prefixedText = null

Text form including namespace/interwiki, initialised on demand.

Only public to share cache with TitleFormatter

Access: internal

Definition at line 160 of file Title.php.

◆ $titleCache

MapCacheLRU null Title::$titleCache = null

staticprivate

Definition at line 53 of file Title.php.

◆ CACHE_MAX

const Title::CACHE_MAX = 1000

private

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 60 of file Title.php.

◆ GAID_FOR_UPDATE

const Title::GAID_FOR_UPDATE = 512

Used to be GAID_FOR_UPDATE define().

Used with getArticleID() and friends to use the primary DB and inject it into link cache.

Deprecated:: since 1.34, use Title::READ_LATEST instead.

Definition at line 67 of file Title.php.

◆ NEW_CLONE

const Title::NEW_CLONE = 'clone'

Flag for use with factory methods like newFromLinkTarget() that have a $forceClone parameter.

If set, the method must return a new instance. Without this flag, some factory methods may return existing instances.as

Since: 1.33

Definition at line 76 of file Title.php.

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

includes/Title.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Private member variables

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ __sleep()

◆ __toString()

◆ __wakeup()

◆ areCascadeProtectionSourcesLoaded()

◆ areRestrictionsCascading()

◆ areRestrictionsLoaded()

◆ assertProperPage()

◆ canExist()

◆ canHaveTalkPage()

◆ canUseNoindex()

◆ capitalize()

◆ castFromLinkTarget()

◆ castFromPageIdentity()

◆ castFromPageReference()

◆ clearCaches()

◆ compare()

◆ convertByteClassToUnicodeClass()

◆ createFragmentTarget()

◆ deleteTitleProtection()

◆ equals()

◆ estimateRevisionCount()

◆ exists()

◆ findSubpageDivider()

◆ fixSpecialName()

◆ fixUrlQueryArgs()

◆ flushRestrictions()

◆ getAllRestrictions()

◆ getArticleID()

◆ getBacklinkCache()

◆ getBaseText()

◆ getBaseTitle()

◆ getBrokenLinksFrom()

◆ getCanonicalURL()

◆ getCascadeProtectionSources()

◆ getCategorySortkey()

◆ getCdnUrls()

◆ getContentModel()

◆ getDBkey()

◆ getDbPageLanguageCode()

◆ getDefaultMessageText()

◆ getDefaultNamespace()

◆ getDeletedEditsCount()

◆ getEditNotices()

◆ getEditURL()

◆ getFilteredRestrictionTypes()

◆ getFragment()

◆ getFragmentForURL()

◆ getFullText()

◆ getFullURL()

◆ getFullUrlForRedirect()

◆ getId()

◆ getInternalURL()

◆ getInterwiki()

◆ getInterwikiLookup()

◆ getLanguageConverter()

◆ getLatestRevID()

◆ getLength()

◆ getLinksFrom()

◆ getLinksTo()

◆ getLinkURL()

◆ getLocalURL()

◆ getNamespace()

◆ getNamespaceKey()

◆ getNotificationTimestamp()

◆ getNsText()

◆ getOtherPage()