MediaWiki  master
Title Class Reference

Represents a title within MediaWiki. More...

Inheritance diagram for Title:
Collaboration diagram for Title:

Public Member Functions

 __clone ()
 
 __sleep ()
 
 __toString ()
 Return a string representation of this title. More...
 
 __wakeup ()
 
 areCascadeProtectionSourcesLoaded ()
 Determines whether cascading protection sources have already been loaded from the database. More...
 
 areRestrictionsCascading ()
 Returns cascading restrictions for the current article. More...
 
 areRestrictionsLoaded ()
 Accessor for mRestrictionsLoaded. More...
 
 canExist ()
 Can this title represent a page in the wiki's database? More...
 
 canHaveTalkPage ()
 Can this title have a corresponding talk page? More...
 
 canUseNoindex ()
 Whether the magic words INDEX and NOINDEX function for this page. More...
 
 createFragmentTarget (string $fragment)
 Creates a new Title for a different fragment of the same page. More...
 
 deleteTitleProtection ()
 Remove any title protection due to page existing. More...
 
 equals (object $other)
 Compares with another Title. More...
 
 estimateRevisionCount ()
 Get the approximate revision count of this page. More...
 
 exists ( $flags=0)
 Check if page exists. More...
 
 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. More...
 
 flushRestrictions ()
 Flush the protection cache in this object and force reload from the database. More...
 
 getAllRestrictions ()
 Accessor/initialisation for mRestrictions. More...
 
 getArticleID ( $flags=0)
 Get the article ID for this Title from the link cache, adding it if necessary. More...
 
 getBacklinkCache ()
 Get a backlink cache object. More...
 
 getBaseText ()
 Get the base page name without a namespace, i.e. More...
 
 getBaseTitle ()
 Get the base page name title, i.e. More...
 
 getBrokenLinksFrom ()
 Get an array of Title objects referring to non-existent articles linked from this page. More...
 
 getCanonicalURL ( $query='', $query2=false)
 Get the URL for a canonical link, for use in things like IRC and e-mail notifications. More...
 
 getCascadeProtectionSources ( $getPages=true)
 Cascading protection: Get the source of any cascading restrictions on this page. More...
 
 getCategorySortkey ( $prefix='')
 Returns the raw sort key to be used for categories, with the specified prefix. More...
 
 getCdnUrls ()
 Get a list of URLs to purge from the CDN cache when this page changes. More...
 
 getContentModel ( $flags=0)
 Get the page's content model id, see the CONTENT_MODEL_XXX constants. More...
 
 getDBkey ()
 Get the main part with underscores. More...
 
 getDefaultMessageText ()
 Get the default (plain) message contents for an page that overrides an interface message key. More...
 
 getDeletedEditsCount ()
 Is there a version of this page in the deletion archive? More...
 
 getEditNotices ( $oldid=0)
 Get a list of rendered edit notices for this page. More...
 
 getEditURL ()
 Get the edit URL for this Title. More...
 
 getFragment ()
 Get the Title fragment (i.e. More...
 
 getFragmentForURL ()
 Get the fragment in URL form, including the "#" character if there is one. More...
 
 getFullText ()
 Get the prefixed title with spaces, plus any fragment (part beginning with '#') More...
 
 getFullURL ( $query='', $query2=false, $proto=PROTO_RELATIVE)
 Get a real URL referring to this title, with interwiki link and fragment. More...
 
 getFullUrlForRedirect ( $query='', $proto=PROTO_CURRENT)
 Get a url appropriate for making redirects based on an untrusted url arg. More...
 
 getId ( $wikiId=self::LOCAL)
 Returns the page ID. More...
 
 getInternalURL ( $query='', $query2=false)
 Get the URL form for an internal link. More...
 
 getInterwiki ()
 Get the interwiki prefix. More...
 
 getLatestRevID ( $flags=0)
 What is the page_latest field for this page? More...
 
 getLength ( $flags=0)
 What is the length of this page? Uses link cache, adding it if necessary. More...
 
 getLinksFrom ( $options=[], $table='pagelinks', $prefix='pl')
 Get an array of Title objects linked from this Title Also stores the IDs in the link cache. More...
 
 getLinksTo ( $options=[], $table='pagelinks', $prefix='pl')
 Get an array of Title objects linking to this Title Also stores the IDs in the link cache. More...
 
 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. More...
 
 getLocalURL ( $query='', $query2=false)
 Get a URL with no fragment or server name (relative URL) from a Title object. More...
 
 getNamespace ()
 Get the namespace index, i.e. More...
 
 getNamespaceKey ( $prepend='nstab-')
 Generate strings used for xml 'id' names in monobook tabs. More...
 
 getNotificationTimestamp (User $user)
 Get the timestamp when this page was updated since the user last saw it. More...
 
 getNsText ()
 Get the namespace text. More...
 
 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. More...
 
 getPageLanguage ()
 Get the language in which the content of this page is written in wikitext. More...
 
 getPageViewLanguage ()
 Get the language in which the content of this page is written when viewed by user. More...
 
 getParentCategories ()
 Get categories to which this Title belongs and return an array of categories' names. More...
 
 getParentCategoryTree ( $children=[])
 Get a tree of parent categories. More...
 
 getPartialURL ()
 Get the URL-encoded form of the main part. More...
 
 getPrefixedDBkey ()
 Get the prefixed database key form. More...
 
 getPrefixedText ()
 Get the prefixed title with spaces. More...
 
 getPrefixedURL ()
 Get a URL-encoded title (not an actual URL) including interwiki. More...
 
 getRedirectsHere ( $ns=null)
 Get all extant redirects to this Title. More...
 
 getRestrictionExpiry ( $action)
 Get the expiry time for the restriction against a given action. More...
 
 getRestrictions ( $action)
 Accessor/initialisation for mRestrictions. More...
 
 getRestrictionTypes ()
 Returns restriction types for the current Title. More...
 
 getRootText ()
 Get the root page name text without a namespace, i.e. More...
 
 getRootTitle ()
 Get the root page name title, i.e. More...
 
 getSkinFromConfigSubpage ()
 Trim down a .css, .json, or .js subpage title to get the corresponding skin name. More...
 
 getSubjectNsText ()
 Get the namespace text of the subject (rather than talk) page. More...
 
 getSubjectPage ()
 Get a title object associated with the subject page of this talk page. More...
 
 getSubpage ( $text)
 Get the title for a subpage of the current page. More...
 
 getSubpages ( $limit=-1)
 Get all subpages of this page. More...
 
 getSubpageText ()
 Get the lowest-level subpage name, i.e. More...
 
 getSubpageUrlForm ()
 Get a URL-encoded form of the subpage text. More...
 
 getTalkNsText ()
 Get the namespace text of the talk page. More...
 
 getTalkPage ()
 Get a Title object associated with the talk page of this article. More...
 
 getTalkPageIfDefined ()
 Get a Title object associated with the talk page of this article, if such a talk page can exist. More...
 
 getTemplateLinksFrom ( $options=[])
 Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache. More...
 
 getTemplateLinksTo ( $options=[])
 Get an array of Title objects using this Title as a template Also stores the IDs in the link cache. More...
 
 getText ()
 Get the text form (spaces not underscores) of the main part. More...
 
 getTitleProtection ()
 Is this title subject to title protection? Title protection is the one applied against creation of such title. More...
 
 getTitleValue ()
 Get a TitleValue object representing this Title. More...
 
 getTouched ( $flags=self::READ_NORMAL)
 Get the last touched timestamp. More...
 
 getTransWikiID ()
 Returns the DB name of the distant wiki which owns the object. More...
 
 getWikiId ()
 Returns false to indicate that this Title belongs to the local wiki. More...
 
 hasContentModel ( $id)
 Convenience method for checking a title's content model name. More...
 
 hasDeletedEdits ()
 Is there a version of this page in the deletion archive? More...
 
 hasFragment ()
 Check if a Title fragment is set. More...
 
 hasSourceText ()
 Does this page have source text? More...
 
 hasSubjectNamespace ( $ns)
 Returns true if the title has the same subject namespace as the namespace specified. More...
 
 hasSubpages ()
 Does this have subpages? (Warning, usually requires an extra DB query.) More...
 
 inNamespace (int $ns)
 Returns true if the title is inside the specified namespace. More...
 
 inNamespaces (... $namespaces)
 Returns true if the title is inside one of the specified namespaces. More...
 
 invalidateCache ( $purgeTime=null)
 Updates page_touched for this page; called from LinksUpdate.php. More...
 
 isAlwaysKnown ()
 Should links to this title be shown as potentially viewable (i.e. More...
 
 isBigDeletion ()
 Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit. More...
 
 isCascadeProtected ()
 Cascading protection: Return true if cascading restrictions apply to this page, false if not. More...
 
 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? More...
 
 isConversionTable ()
 Is this a conversion table for the LanguageConverter? More...
 
 isDeleted ()
 Is there a version of this page in the deletion archive? More...
 
 isDeletedQuick ()
 Is there a version of this page in the deletion archive? More...
 
 isExternal ()
 Is this Title interwiki? More...
 
 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). More...
 
 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 ) More...
 
 isMainPage ()
 Is this the mainpage? More...
 
 isMovable ()
 Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable. More...
 
 isNewPage ( $flags=self::READ_NORMAL)
 Check if this is a new page. More...
 
 isProtected ( $action='')
 Does the title correspond to a protected article? More...
 
 isRawHtmlMessage ()
 Is this a message which can contain raw HTML? More...
 
 isRedirect ( $flags=0)
 Is this an article that is a redirect page? Uses link cache, adding it if necessary. More...
 
 isSameLinkAs (LinkTarget $other)
 
 isSamePageAs (PageReference $other)
 
 isSemiProtected ( $action='edit')
 Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels? More...
 
 isSingleRevRedirect ()
 Locks the page row and check if this page is single revision redirect. More...
 
 isSiteConfigPage ()
 Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI. More...
 
 isSiteCssConfigPage ()
 Is this a sitewide CSS "config" page? More...
 
 isSiteJsConfigPage ()
 Is this a sitewide JS "config" page? More...
 
 isSiteJsonConfigPage ()
 Is this a sitewide JSON "config" page? More...
 
 isSpecial ( $name)
 Returns true if this title resolves to the named special page. More...
 
 isSpecialPage ()
 Returns true if this is a special page. More...
 
 isSubpage ()
 Is this a subpage? More...
 
 isSubpageOf (Title $title)
 Check if this title is a subpage of another title. More...
 
 isTalkPage ()
 Is this a talk page of some sort? More...
 
 isTrans ()
 Determine whether the object refers to a page within this project and is transcludable. More...
 
 isUserConfigPage ()
 Is this a "config" (.css, .json, or .js) sub-page of a user page? More...
 
 isUserCssConfigPage ()
 Is this a CSS "config" sub-page of a user page? More...
 
 isUserJsConfigPage ()
 Is this a JS "config" sub-page of a user page? More...
 
 isUserJsonConfigPage ()
 Is this a JSON "config" sub-page of a user page? More...
 
 isValid ()
 Returns true if the title is a valid link target, and that it has been properly normalized. More...
 
 isValidRedirectTarget ()
 Check if this Title is a valid redirect target. More...
 
 isWikitextPage ()
 Does that page contain wikitext, or it is JS, CSS or whatever? More...
 
 loadFromRow ( $row)
 Load Title object fields from a DB row. More...
 
 loadRestrictions ( $flags=0)
 Load restrictions from the page_restrictions table. More...
 
 loadRestrictionsFromRows ( $rows)
 Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page. More...
 
 pageCond ()
 Get an associative array for selecting this title from the "page" table. More...
 
 purgeSquid ()
 Purge all applicable CDN URLs. More...
 
 resetArticleID ( $id)
 Inject a page ID, reset DB-loaded fields, and clear the link cache for this title. More...
 
 setContentModel ( $model)
 Set a proposed content model for the page for permissions checking. More...
 
 setFragment ( $fragment)
 Set the fragment for this title. More...
 
 toPageIdentity ()
 Returns the page represented by this Title as a ProperPageIdentity. More...
 
 toPageRecord ( $flags=0)
 Returns the page represented by this Title as a ProperPageRecord. More...
 
 touchLinks ()
 Update page_touched timestamps and send CDN purge messages for pages linking to this title. More...
 
 wasLocalInterwiki ()
 Was this a local interwiki link? More...
 
- Public Member Functions inherited from Page\PageIdentity
 exists ()
 Checks if the page currently exists. More...
 
- Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
 assertWiki ( $wikiId)
 Throws if $wikiId is different from the return value of getWikiId(). More...
 

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. More...
 
static castFromLinkTarget ( $linkTarget)
 Same as newFromLinkTarget, but if passed null, returns null. More...
 
static castFromPageIdentity (?PageIdentity $pageIdentity)
 Return a Title for a given PageIdentity. More...
 
static castFromPageReference (?PageReference $pageReference)
 Return a Title for a given Reference. More...
 
static clearCaches ()
 
static compare ( $a, $b)
 Callback for usort() to do title sorts by (namespace, title) More...
 
static convertByteClassToUnicodeClass ( $byteClass)
 Utility method for converting a character sequence from bytes to Unicode. More...
 
static getFilteredRestrictionTypes ( $exists=true)
 Get a filtered list of all restriction types supported by this wiki. More...
 
static legalChars ()
 Get a regex character class describing the legal characters in a link. More...
 
static makeName ( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
 Make a prefixed DB key from a DB key and a namespace index. More...
 
static makeTitle ( $ns, $title, $fragment='', $interwiki='')
 Create a new Title from a namespace index and a DB key. More...
 
static makeTitleSafe ( $ns, $title, $fragment='', $interwiki='')
 Create a new Title from a namespace index and a DB key. More...
 
static newFromDBkey ( $key)
 Create a new Title from a prefixed DB key. More...
 
static newFromID ( $id, $flags=0)
 Create a new Title from an article ID. More...
 
static newFromIDs ( $ids)
 Make an array of titles from an array of IDs. More...
 
static newFromLinkTarget (LinkTarget $linkTarget, $forceClone='')
 Returns a Title given a LinkTarget. More...
 
static newFromRow ( $row)
 Make a Title object from a DB row. More...
 
static newFromText ( $text, $defaultNamespace=NS_MAIN)
 Create a new Title from text, such as what one would find in a link. More...
 
static newFromTextThrow ( $text, $defaultNamespace=NS_MAIN)
 Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null. More...
 
static newFromTitleValue (TitleValue $titleValue, $forceClone='')
 Returns a Title given a TitleValue. More...
 
static newFromURL ( $url)
 THIS IS NOT THE FUNCTION YOU WANT. More...
 
static newMainPage (MessageLocalizer $localizer=null)
 Create a new Title for the Main Page. More...
 
static purgeExpiredRestrictions ()
 Purge expired restrictions from the page_restrictions table. More...
 

Public Attributes

const GAID_FOR_UPDATE = 512
 Used to be GAID_FOR_UPDATE define(). More...
 
const NEW_CLONE = 'clone'
 Flag for use with factory methods like newFromLinkTarget() that have a $forceClone parameter. More...
 
- Public Attributes inherited from IDBAccessObject
const READ_NONE = -1
 Constants for object loading bitfield flags (higher => higher QoS) More...
 

Static Protected Member Functions

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

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. More...
 
 findSubpageDivider ( $text, $dir)
 Finds the first or last subpage divider (slash) in the string. More...
 
 getDbPageLanguageCode (int $flags=0)
 Returns the page language code saved in the database, if $wgPageLanguageUseDB is set to true in LocalSettings.php, otherwise returns false. More...
 
 getFieldFromPageStore ( $field, $flags)
 
 getLanguageConverter ( $language)
 Shorthand for getting a Language Converter for specific language. More...
 
 getPageLanguageConverter ()
 Shorthand for getting a Language Converter for page's language. More...
 
 hasSubpagesEnabled ()
 Whether this Title's namespace has subpages enabled. More...
 
 lazyFillContentModel ( $model)
 If the content model field is not frozen then update it with a retrieved value. More...
 
 prefix ( $name)
 Prefix some arbitrary text with the namespace or interwiki prefix of this object. More...
 
 secureAndSplit ( $text, $defaultNamespace=null)
 Secure and split - main initialisation function for this object. More...
 
 shouldReadLatest (int $flags)
 
 uncache ()
 Removes this instance from the internal title cache, so it can be modified in-place without polluting the cache (see T281337). More...
 
 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. More...
 
static getInterwikiLookup ()
 B/C kludge: provide an InterwikiLookup for use by Title. More...
 
static getTitleCache ()
 
static getTitleFormatter ()
 B/C kludge: provide a TitleParser for use by Title. More...
 
static normalizeFragment ( $fragment)
 Normalizes fragment part of the title. More...
 

Private Attributes

string $mDbkeyform = ''
 Main part with underscores. More...
 
string $mFragment = ''
 Title fragment (i.e. More...
 
string $mInterwiki = ''
 Interwiki prefix. More...
 
bool $mLocalInterwiki = false
 Was this Title created from a string with a local interwiki prefix? More...
 
int $mNamespace = NS_MAIN
 Namespace index, i.e. More...
 
string $mTextform = ''
 Text form (spaces not underscores) of the main part. More...
 
string $mUrlform = ''
 URL-encoded form of the main part. More...
 
const CACHE_MAX = 1000
 Title::newFromText maintains a cache to avoid expensive re-normalization of commonly used titles. More...
 

Static Private Attributes

static MapCacheLRU null $titleCache = null
 

Private member variables

Please use the accessor functions instead.

Access: internal
bool string $mContentModel = false
 ID of the page's content model, i.e. More...
 
bool $mForcedContentModel = false
 If a content model was forced via setContentModel() this will be true to avoid having other code paths reset it. More...
 
int null $mEstimateRevisions
 Estimated number of revisions; null of not loaded. More...
 
const DEFAULT_NAMESPACE = NS_MAIN
 Namespace to assume when no namespace was passed to factory methods. More...
 
bool $mHasSubpages
 Whether a page has any subpages. More...
 
array null $mPageLanguage
 The (string) language code of the page's language and content code. More...
 
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. More...
 
TitleValue null $mTitleValue = null
 ID of the page's content model, i.e. More...
 
bool null $mIsBigDeletion = null
 Would deleting this page be a big deletion? More...
 
bool null $mIsValid = null
 Is the title known to be valid? More...
 
string null $mInstanceCacheKey = null
 The key of this instance in the internal Title instance cache. More...
 
int $mArticleID = -1
 Article ID, fetched from the link cache on demand. More...
 
string null $prefixedText = null
 Text form including namespace/interwiki, initialised on demand. More...
 
null bool $mRedirect = null
 Is the article at this title a redirect? More...
 
bool int $mLatestID = false
 ID of most recent revision. More...
 
int $mLength = -1
 The page length, 0 for special pages. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

Title::__construct ( )
private

Definition at line 221 of file Title.php.

References deprecatePublicProperty(), and deprecatePublicPropertyFallback().

Member Function Documentation

◆ __clone()

Title::__clone ( )

Definition at line 4127 of file Title.php.

◆ __sleep()

Title::__sleep ( )
Returns
array

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

◆ __wakeup()

Title::__wakeup ( )

Definition at line 4121 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 2511 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 2607 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 2551 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 4178 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 Page\PageIdentity.

Definition at line 1232 of file Title.php.

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

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

◆ canUseNoindex()

Title::canUseNoindex ( )

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

Returns
bool

Definition at line 3845 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$textContaining title to capitalize
int$nsNamespace index, defaults to NS_MAIN
Returns
string Containing capitalized title

Definition at line 2945 of file Title.php.

Referenced by CategoryPager\__construct(), UploadBase\checkBadFileName(), and SpecialWithoutInterwiki\execute().

◆ castFromLinkTarget()

◆ castFromPageIdentity()

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

Referenced by RecentChange\__construct(), MediaWiki\Linker\LinkRenderer\castToLinkTarget(), Job\factory(), BacklinkCache\getConditions(), EditPage\getCopyrightWarning(), RecentChange\getTitle(), JobSpecification\getTitle(), HTMLCacheUpdateJob\newForBacklinks(), Parser\ParserObserver\notifyParse(), RecentChange\save(), Parser\setPage(), ManualLogEntry\setTarget(), HTMLForm\setTitle(), and OutputPage\setTitle().

◆ clearCaches()

static Title::clearCaches ( )
static

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

Referenced by ApiQueryInfo\execute().

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

◆ createFragmentTarget()

Title::createFragmentTarget ( string  $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 1820 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 2457 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 3396 of file Title.php.

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

◆ estimateRevisionCount()

Title::estimateRevisionCount ( )

Get the approximate revision count of this page.

Returns
int

Definition at line 3368 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
bool

Definition at line 3469 of file Title.php.

Referenced by 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 1933 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 1301 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 2139 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 2646 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 2581 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
int The ID

Definition at line 2824 of file Title.php.

Referenced by 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 3834 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'
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:370
Returns
string Base name

Definition at line 2021 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 2048 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 3153 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$query2Deprecated
Returns
string The URL
Since
1.18

Definition at line 2388 of file Title.php.

References PROTO_CANONICAL, Hooks\runner(), 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$getPagesWhether 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 whether 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 2531 of file Title.php.

Referenced by MediaWiki\Permissions\PermissionManager\checkCascadingSourcesRestrictions().

◆ 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$prefixThe prefix to be used, specified using {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no prefix.
Returns
string

Definition at line 3864 of file Title.php.

References Hooks\runner().

◆ getCdnUrls()

Title::getCdnUrls ( )

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

Deprecated:
since 1.35 Use HtmlCacheUpdater
Returns
string[]

Definition at line 3189 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
string Content model id

Definition at line 1088 of file Title.php.

References ContentHandler\getDefaultModelFor().

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

◆ getDBkey()

◆ getDbPageLanguageCode()

Title::getDbPageLanguageCode ( int  $flags = 0)
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.

Parameters
int$flags
Returns
?string

Definition at line 3892 of file Title.php.

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

References $lang, NS_MEDIAWIKI, and wfMessage().

◆ 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 2763 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$oldidRevision ID that's being edited
Returns
string[]

Definition at line 4001 of file Title.php.

References Sanitizer\escapeClass(), Html\rawElement(), Hooks\runner(), and wfMessage().

◆ getEditURL()

Title::getEditURL ( )

Get the edit URL for this Title.

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

Definition at line 2400 of file Title.php.

References $s.

◆ getFieldFromPageStore()

Title::getFieldFromPageStore (   $field,
  $flags 
)
private
Parameters
string$field
int$flagsBitfield of class READ_* constants
Returns
string|false

Definition at line 4076 of file Title.php.

◆ 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$existsTrue 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 2419 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 1764 of file Title.php.

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

References Sanitizer\escapeIdForExternalInterwiki(), and Sanitizer\escapeIdForLink().

◆ 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 1911 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$protoProtocol type to use in URL
Returns
string The URL

Definition at line 2177 of file Title.php.

References Hooks\runner(), and 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$protoProtocol type to use in URL
Returns
string A url suitable to use in an HTTP location header.

Definition at line 2210 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$wikiIdThe wiki ID expected by the caller.
Exceptions
PreconditionExceptionif 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.
PreconditionExceptionif $wikiId is not false.
Returns
int

Implements Page\PageIdentity.

Definition at line 4160 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$query2Deprecated
Returns
string The URL

Definition at line 2366 of file Title.php.

References $wgInternalServer, $wgServer, PROTO_HTTP, Hooks\runner(), 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 967 of file Title.php.

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

◆ getLanguageConverter()

Title::getLanguageConverter (   $language)
private

Shorthand for getting a Language Converter for specific language.

Parameters
Language$languageLanguage of converter
Returns
ILanguageConverter

Definition at line 184 of file Title.php.

◆ getLatestRevID()

Title::getLatestRevID (   $flags = 0)

What is the page_latest field for this page?

Parameters
int$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
int Int or 0 if the page doesn't exist

Definition at line 2885 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
int

Definition at line 2867 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$optionsQuery option to Database::select()
string$tableTable name
string$prefixFields prefix
Returns
Title[] List of Titles linking here

Definition at line 3075 of file Title.php.

References $res, DB_REPLICA, WikiPage\getQueryInfo(), 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$optionsMay be FOR UPDATE
string$tableTable name
string$prefixFields prefix
Returns
Title[]

Definition at line 3017 of file Title.php.

References $res, DB_PRIMARY, DB_REPLICA, LinkCache\getSelectFields(), 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$protoA 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 2340 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$queryAn 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$query2An 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 2244 of file Title.php.

References $matches, $wgActionPaths, $wgArticlePath, $wgMainPageIsDomainRoot, $wgScript, $wgVariantArticlePath, PathRouter\getActionPaths(), Hooks\runner(), wfAppendQuery(), and wfUrlencode().

◆ getNamespace()

◆ getNamespaceKey()

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

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

Parameters
string$prependDefaults to 'nstab-'
Returns
string XML 'id' name

Definition at line 3738 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, hard deprecated since 1.39
Parameters
User$user
Returns
string|bool|null String timestamp, false if not watched, null if nothing is unseen

Definition at line 3725 of file Title.php.

References wfDeprecated().

◆ getNsText()

Title::getNsText ( )

Get the namespace text.

Returns
string|false Namespace text

Definition at line 1160 of file Title.php.

References NS_MAIN, and 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
MWExceptionIf the page doesn't have an other page
Returns
Title

Definition at line 1737 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 3912 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 193 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 3953 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 3249 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$childrenArray with the children in the keys, to check for circular refs
Returns
array Tree of parent categories

Definition at line 3284 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 1048 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 1875 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 1887 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 2120 of file Title.php.

References $s, and wfUrlencode().

◆ getRedirectsHere()

Title::getRedirectsHere (   $ns = null)

Get all extant redirects to this Title.

Parameters
int | null$nsSingle namespace to consider; null to consider all namespaces
Returns
Title[]

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

◆ getRestrictions()

Title::getRestrictions (   $action)

Accessor/initialisation for mRestrictions.

Deprecated:
since 1.37, use RestrictionStore::getRestrictions instead
Parameters
string$actionAction 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 2568 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 2432 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 1971 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 1998 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.

Deprecated:
since 1.36, use PageStore::newSelectQueryBuilder() instead. Hard deprecated in 1.39, remove in 1.40
Returns
array

Definition at line 506 of file Title.php.

References wfDeprecated().

◆ 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 1487 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 1190 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 1680 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$textThe subpage name to add to the title
Returns
Title|null Subpage title, or null on an error
Since
1.20

Definition at line 2095 of file Title.php.

◆ getSubpages()

Title::getSubpages (   $limit = -1)

Get all subpages of this page.

Parameters
int$limitMaximum 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 2724 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 2068 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 2109 of file Title.php.

References wfUrlencode().

◆ getTalkNsText()

Title::getTalkNsText ( )

Get the namespace text of the talk page.

Returns
string Namespace text

Definition at line 1201 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
MWExceptionif $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 1635 of file Title.php.

References $title.

◆ 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 1665 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$optionsMay be FOR UPDATE
Returns
Title[]

Definition at line 3141 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$optionsQuery option to Database::select()
Returns
Title[]

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

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

◆ getTitleCache()

static Title::getTitleCache ( )
staticprivate
Returns
MapCacheLRU

Definition at line 490 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 205 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 2447 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 1016 of file Title.php.

References wfDebug().

◆ getTouched()

Title::getTouched (   $flags = self::READ_NORMAL)

Get the last touched timestamp.

Parameters
int$flagsone of the READ_XXX constants. For historical reasons, an IDatabase instance is also accepted here. If an IDatabase is passed, a deprecation warning is triggered, caches will be bypassed, and the primary database connection will be used. However, the IDatabase instance itself will be ignored.
Returns
string|false Last-touched timestamp

Definition at line 3703 of file Title.php.

References wfDeprecatedMsg().

◆ getTransWikiID()

Title::getTransWikiID ( )

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

Returns
string|false The DB name

Definition at line 999 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 Page\PageReference.

Definition at line 4140 of file Title.php.

◆ hasContentModel()

Title::hasContentModel (   $id)

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

Parameters
string$idThe content model ID (use the CONTENT_MODEL_XXX constants).
Returns
bool True if $this->getContentModel() == $id

Definition at line 1114 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 2799 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 1774 of file Title.php.

◆ hasSourceText()

Title::hasSourceText ( )

Does this page have source text?

Returns
bool

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

◆ hasSubpages()

Title::hasSubpages ( )

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

Returns
bool

Definition at line 2696 of file Title.php.

◆ hasSubpagesEnabled()

Title::hasSubpagesEnabled ( )
private

Whether this Title's namespace has subpages enabled.

Returns
bool

Definition at line 1951 of file Title.php.

◆ inNamespace()

Title::inNamespace ( int  $ns)

Returns true if the title is inside the specified namespace.

Parameters
int$nsThe namespace
Returns
bool
Since
1.19

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1322 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 1334 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 3636 of file Title.php.

References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DeferredUpdates\addUpdate(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\getDomainID(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), Wikimedia\Rdbms\IDatabase\update(), and wfGetDB().

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

References NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, NS_SPECIAL, and Hooks\runner().

◆ 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 3339 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 2498 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 1373 of file Title.php.

◆ isConversionTable()

Title::isConversionTable ( )

Is this a conversion table for the LanguageConverter?

Returns
bool

Definition at line 1429 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 2753 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 2789 of file Title.php.

◆ isExternal()

Title::isExternal ( )

Is this Title interwiki?

Returns
bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 956 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 3545 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 941 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 1408 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 1384 of file Title.php.

References Hooks\runner().

◆ isNewPage()

Title::isNewPage (   $flags = self::READ_NORMAL)

Check if this is a new page.

Note
This returns false if the page does not exist.
Parameters
int$flagsone of the READ_XXX constants.
Returns
bool

Definition at line 3328 of file Title.php.

◆ isProtected()

Title::isProtected (   $action = '')

Does the title correspond to a protected article?

Deprecated:
since 1.37, use RestrictionStore::isProtected instead
Parameters
string$actionThe action the page is protected from, by default checks all actions.
Returns
bool

Definition at line 2485 of file Title.php.

◆ isRawHtmlMessage()

Title::isRawHtmlMessage ( )

Is this a message which can contain raw HTML?

Returns
bool
Since
1.32

Definition at line 1604 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
bool

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

◆ isSamePageAs()

Title::isSamePageAs ( PageReference  $other)
See also
PageReference::isSamePageAs()
Since
1.36
Parameters
PageReference$other
Returns
bool

Implements Page\PageReference.

Definition at line 3432 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$actionAction to check (default: edit)
Returns
bool

Definition at line 2470 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 3210 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 1459 of file Title.php.

◆ isSiteCssConfigPage()

Title::isSiteCssConfigPage ( )

Is this a sitewide CSS "config" page?

Returns
bool
Since
1.32

Definition at line 1550 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 1586 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 1568 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$nameThe special page name
Returns
bool

Definition at line 1283 of file Title.php.

◆ isSpecialPage()

Title::isSpecialPage ( )

Returns true if this is a special page.

Returns
bool

Definition at line 1273 of file Title.php.

References NS_SPECIAL.

Referenced by SkinTemplate\buildPersonalUrls().

◆ isSubpage()

Title::isSubpage ( )

Is this a subpage?

Returns
bool

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

References $title.

◆ isTalkPage()

Title::isTalkPage ( )

Is this a talk page of some sort?

Returns
bool

Definition at line 1619 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 986 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 1473 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 1508 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 1536 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 1522 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 902 of file Title.php.

◆ isValidRedirectTarget()

Title::isValidRedirectTarget ( )

Check if this Title is a valid redirect target.

Returns
bool

Definition at line 3803 of file Title.php.

References $wgInvalidRedirectTargets.

Referenced by XmlDumpWriter\openPage().

◆ isWikitextPage()

Title::isWikitextPage ( )

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

Returns
bool

Definition at line 1441 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$modelCONTENT_MODEL_XXX constant or false

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

References $wgLegalTitleChars.

Referenced by ApiQuerySiteinfo\appendGeneralInfo(), CleanupImages\buildSafeTitle(), MediaWikiTitleCodec\getTitleInvalidRegex(), Parser\handleInternalLinks2(), Parser\pstPass2(), and wfStripIllegalFilenameChars().

◆ 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$rowDatabase row

Definition at line 585 of file Title.php.

◆ loadRestrictions()

Title::loadRestrictions (   $flags = 0)

Load restrictions from the page_restrictions table.

Deprecated:
since 1.37, no public replacement
Parameters
int$flagsA bit field. If self::READ_LATEST is set, skip replicas and read from the primary DB.

Definition at line 2636 of file Title.php.

◆ loadRestrictionsFromRows()

Title::loadRestrictionsFromRows (   $rows)

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[]$rowsArray of db result objects

Definition at line 2622 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$nsNumerical representation of the namespace
string$titleThe DB key form the title
string$fragmentThe link fragment (after the "#")
string$interwikiThe interwiki prefix
bool$canonicalNamespaceIf true, use the canonical name for $ns instead of the localized version.
Returns
string The prefixed form of the title

Definition at line 854 of file Title.php.

References $title.

Referenced by SpecialRedirect\dispatchFile(), MovePageForm\doSubmit(), SpecialExport\getPagesFromCategory(), SpecialExport\getPagesFromNamespace(), TitleCleanup\processRow(), and HTMLTitleTextField\validate().

◆ 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$nsThe namespace of the article
string$titleThe unprefixed database key form
string$fragmentThe link fragment (after the "#")
string$interwikiThe interwiki prefix
Returns
Title The new object

Definition at line 638 of file Title.php.

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

Referenced by Job\__construct(), DeletePageJob\__construct(), MediaWiki\Block\AbstractBlock\appliesToUsertalk(), ChangesFeed\buildItems(), FindOrphanedFiles\checkFiles(), LocalRepo\checkRedirect(), SpecialEditWatchlist\cleanupWatchlist(), CompressOld\compressWithConcat(), BenchmarkTitleValue\constructTitle(), ApiFeedWatchlist\createFeedItem(), UppercaseTitlesForUnicodeTransition\doMove(), UppercaseTitlesForUnicodeTransition\doUpdate(), LinkHolderArray\doVariants(), SpecialPasswordPolicies\execute(), ApiBlock\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), AttachLatest\execute(), CheckBadRedirects\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DumpLinks\execute(), FixDoubleRedirects\execute(), NukeNS\execute(), PurgeChangedPages\execute(), SqlSearchResultSet\extractResults(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), Job\factory(), ApiFeedContributions\feedItem(), SpecialNewpages\feedItem(), ForeignAPIRepo\findBySha1(), DoubleRedirectJob\fixRedirects(), WikiFilePage\followRedirect(), MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\footerHtml(), ApiParse\formatCategoryLinks(), FeedUtils\formatDiff(), ApiParse\formatLinks(), SpecialAncientPages\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialListDuplicatedFiles\formatResult(), SpecialListRedirects\formatResult(), SpecialMIMESearch\formatResult(), SpecialUncategorizedCategories\formatResult(), SpecialUnusedCategories\formatResult(), SpecialUnusedTemplates\formatResult(), SpecialWantedCategories\formatResult(), DeletedContribsPager\formatRevisionRow(), SpecialNewpages\formatRow(), NewFilesPager\formatRow(), AllMessagesTablePager\formatValue(), ImageListPager\formatValue(), GenerateSitemap\generateLimit(), ApiUpload\getChunkResult(), PopulateContentTables\getContentModel(), CategoriesRdf\getDumpURI(), DoubleRedirectJob\getFinalDestination(), WikiPage\getHiddenCategories(), ChangeTagsLogItem\getHTML(), RevDelLogItem\getHTML(), SpecialExport\getLinks(), SearchNearMatcher\getNearMatchInternal(), MediaWiki\Search\ParserOutputSearchDataExtractor\getOutgoingLinks(), NewUsersLogFormatter\getPreloadTitles(), SpecialRandomInCategory\getRandomTitle(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), File\getRedirectedTitle(), SpecialListRedirects\getRedirectTarget(), WikiFilePage\getRedirectTarget(), RollbackEdits\getRollbackTitles(), DatabaseLogEntry\getTarget(), RCDatabaseLogEntry\getTarget(), Parser\getTemplateDom(), EditPage\getTemplates(), MediaWiki\Search\ParserOutputSearchDataExtractor\getTemplates(), RecentChange\getTitle(), DifferenceEngine\getTitle(), Message\getTitle(), Parser\getTitle(), User\getTokenUrl(), ExternalUserNames\getUserLinkTitle(), User\getUserPage(), UserRightsProxy\getUserPage(), FixDefaultJsonContentPages\handleRow(), MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\headerHtml(), ImagePage\imageLinks(), CategoriesRdf\labelToUrl(), MessageCache\loadCachedMessagePageEntry(), MediaWiki\Block\BlockUser\log(), MediaWiki\Rest\EntryPoint\main(), GenerateSitemap\main(), NamespaceDupes\mergePage(), UppercaseTitlesForUnicodeTransition\mungeTitle(), ArchivedFile\newFromRow(), LocalFile\newFromRow(), OldLocalFile\newFromRow(), Article\newFromTitle(), MediaWiki\Revision\RevisionStore\newRevisionFromArchiveRowAndSlots(), MediaWiki\Revision\RevisionStore\newRevisionsFromBatch(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), MediaWiki\parseTitle(), ApiUpload\performUpload(), RebuildTextIndex\populateSearchIndex(), SpecialBlock\processFormInternal(), CleanupWatchlist\processRow(), CleanupCaps\processRowToLowercase(), CleanupCaps\processRowToUppercase(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), MessageCache\refreshAndReplaceInternal(), LinkHolderArray\replaceInternal(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryRecentChanges\run(), ApiQueryWatchlistRaw\run(), DoubleRedirectJob\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), ApiOpenSearch\search(), Parser\setPage(), SearchSuggestion\setText(), UppercaseTitlesForUnicodeTransition\shouldDelete(), SpecialAllPages\showChunk(), SpecialWhatLinksHere\showIndirectLinks(), SpecialUpload\showUploadWarning(), CoreParserFunctions\urlFunction(), wfApiMain(), CategoriesRdf\writeCategoryData(), CategoriesRdf\writeCategoryLinkData(), and XmlDumpWriter\writeLogItem().

◆ 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$nsThe namespace of the article
string$titleDatabase key form
string$fragmentThe link fragment (after the "#")
string$interwikiInterwiki prefix
Returns
Title|null The new object, or null on an error

Definition at line 664 of file Title.php.

References $t, and $title.

Referenced by ImageListPager\__construct(), UsersPager\__construct(), ActiveUsersPager\__construct(), AllMessagesTablePager\__construct(), OutputPage\addCategoryLinks(), CleanupImages\buildSafeTitle(), BenchmarkTitleValue\constructTitleSafe(), PrefixSearch\defaultSearchBackend(), DifferenceEngine\deletedLink(), MovePageForm\doSubmit(), LinkHolderArray\doVariants(), SpecialContributions\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), SpecialLog\execute(), MovePageForm\execute(), FixMergeHistoryCorruption\execute(), ImportImages\execute(), ImportSiteScripts\execute(), MakeTestEdits\execute(), RebuildFileCache\execute(), RefreshLinks\execute(), SpecialNewpages\form(), WantedQueryPage\formatResult(), SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialMostLinked\formatResult(), SpecialMostLinkedCategories\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialShortPages\formatResult(), SpecialUnwatchedPages\formatResult(), PageQueryPage\formatResult(), SpecialProtectedtitles\formatRow(), ImageListPager\formatValue(), ProtectedPagesPager\formatValue(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), NamespaceDupes\getAlternateTitle(), NamespaceDupes\getDestinationTitle(), SpecialUncategorizedCategories\getExceptionList(), SpecialStatistics\getGroupStats(), SpecialAllPages\getNamespaceKeyAndText(), SpecialEditWatchlist\getNormalForm(), WantedFilesPage\getPageHeader(), NewPagesPager\getQueryInfo(), SpecialRandomPage\getRandomTitle(), WikiPage\getRedirectTarget(), SpecialPage\getSafeTitleFor(), UploadBase\getTitle(), SpecialUpload\getUploadForm(), SpecialUpload\getWatchCheck(), SpecialEditWatchlist\getWatchlist(), ChangeTags\isTagNameValid(), ArchivedFile\loadFromRow(), Linker\makeThumbLink2(), TitleCleanup\moveInconsistentPage(), MovePage\moveSubpagesInternal(), File\normalizeTitle(), SpecialRandomInCategory\onSubmit(), ImageQueryPage\outputResults(), CoreParserFunctions\pagesincategory(), LanguageConverter\parseCachedTable(), CleanupImages\processRow(), RefreshLinksJob\run(), MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\setParserOutput(), RevisionDeleteUser\setUsernameBitfields(), SpecialBookSources\showList(), SpecialUndelete\showList(), SpecialAllPages\showToplevel(), SpecialUpload\showViewDeletedLinks(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), CoreParserFunctions\special(), PrefixSearch\specialSearch(), ApiQueryBase\titlePartToKey(), ApiFileRevert\validateParameters(), wfImageAuthMain(), and wfStreamThumb().

◆ newFromDBkey()

static Title::newFromDBkey (   $key)
static

Create a new Title from a prefixed DB key.

Parameters
string$keyThe 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 241 of file Title.php.

References $t.

◆ newFromID()

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

◆ newFromIDs()

static Title::newFromIDs (   $ids)
static

Make an array of titles from an array of IDs.

Parameters
int[]$idsArray of IDs
Returns
Title[] Array of Titles
Deprecated:
since 1.38 use a PageStore QueryBuilder instead

Definition at line 545 of file Title.php.

References $dbr, $res, DB_REPLICA, wfDeprecated(), 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$linkTargetAssumed to be safe.
string$forceCloneset to NEW_CLONE to ensure a fresh instance is returned.
Returns
Title

Definition at line 282 of file Title.php.

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

Referenced by MediaWiki\CommentFormatter\CommentParser\addPageLink(), MediaWiki\Linker\LinkRenderer\castToTitle(), ApiComparePages\execute(), ApiExpandTemplates\execute(), ApiParse\execute(), ApiQueryRevisionsBase\extractDeprecatedContent(), ApiQueryWatchlist\extractOutputData(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiComparePages\getDiffRevision(), Linker\getImageLinkMTOParams(), SpecialPage\getTitleFor(), ApiComparePages\guessTitle(), DifferenceEngine\loadRevisionData(), Linker\makeImageLink(), Linker\makeSelfLinkObj(), Linker\makeThumbLink2(), MediaWiki\parseTitle(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), SpecialEditWatchlist\runWatchUnwatchCompleteHook(), DifferenceEngine\setRevisions(), ManualLogEntry\setTarget(), ApiComparePages\setVals(), SpecialUndelete\showDiff(), Parser\statelessFetchTemplate(), RevDelRevisionList\suggestTarget(), and UpdateSearchIndex\updateSearchIndexForPage().

◆ newFromRow()

◆ 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$textThe link text; spaces, prefixes, and an initial ':' indicating the main namespace are accepted.
int$defaultNamespaceThe 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 370 of file Title.php.

Referenced by Installer\__construct(), DoubleRedirectJob\__construct(), Message\__unserialize(), Action\addHelpLink(), Article\addHelpLink(), SpecialPage\addHelpLink(), Skin\addToSidebarPlain(), ApiFormatXml\addXslt(), ApiQuerySiteinfo\appendRightsInfo(), CoreParserFunctions\basepagename(), CoreParserFunctions\basepagenamee(), Parser\braceSubstitution(), SkinTemplate\buildPersonalUrls(), CoreParserFunctions\cascadingsources(), LocalRepo\checkRedirect(), ApiFeedWatchlist\createFeedItem(), CoreParserFunctions\displaytitle(), SpecialExport\doExport(), SpecialRecentChangesLinked\doMainQuery(), PurgeList\doPurge(), SpecialEditTags\execute(), SpecialFileDuplicateSearch\execute(), SpecialGoToInterwiki\execute(), SpecialLog\execute(), MovePageForm\execute(), SpecialRevisionDelete\execute(), SpecialSearch\execute(), SpecialWhatLinksHere\execute(), SpecialExpandTemplates\execute(), ApiExpandTemplates\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiParse\execute(), ApiQueryAllMessages\execute(), ApiQueryImageInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiRevisionDelete\execute(), ApiUndelete\execute(), ApiWatch\execute(), BenchmarkCommentFormatter\execute(), BenchmarkParse\execute(), DeleteBatch\execute(), DumpIterator\execute(), EditCLI\execute(), FixDoubleRedirects\execute(), FormatInstallDoc\execute(), GetTextMaint\execute(), ImportTextFiles\execute(), MoveBatch\execute(), NukePage\execute(), PageExists\execute(), Protect\execute(), RollbackEdits\execute(), Undelete\execute(), UppercaseTitlesForUnicodeTransition\execute(), ViewCLI\execute(), SpecialEditWatchlist\extractTitles(), MediaWiki\ResourceLoader\WikiModule\fetchTitleInfo(), SpecialMyLanguage\findTitleInternal(), LanguageConverter\findVariantLink(), ApiHelp\fixHelpLinks(), Skin\footerLinkTitle(), ApiParse\formatIWLinks(), ApiParse\formatLangLinks(), LogFormatter\formatParameterValue(), LogFormatter\formatParameterValueForApi(), SpecialMIMESearch\formatResult(), SearchSuggestion\fromText(), CoreParserFunctions\fullpagename(), CoreParserFunctions\fullpagenamee(), CoreParserFunctions\gender(), MoveLogFormatter\getActionLinks(), Skin\getCategoryLinks(), Skin\getCopyright(), ApiComparePages\getDiffRevision(), SpecialUncategorizedCategories\getExceptionList(), ApiFeedRecentChanges\getFeedObject(), Parser\Parsoid\Config\DataAccess\getFileInfo(), SpecialPageLanguage\getFormFields(), UserGroupMembership\getGroupPage(), OutputPage\getHeadLinksArray(), Skin\getLanguages(), IRCColourfulRCFeedFormatter\getLine(), SpecialExport\getLinks(), BlockLogFormatter\getMessageParameters(), MergeLogFormatter\getMessageParameters(), MoveLogFormatter\getMessageParameters(), ProtectLogFormatter\getMessageParameters(), SearchNearMatcher\getNearMatchInternal(), UsersPager\getPageHeader(), Parser\Parsoid\Config\DataAccess\getPageInfo(), BlockLogFormatter\getPreloadTitles(), MergeLogFormatter\getPreloadTitles(), MoveLogFormatter\getPreloadTitles(), ProtectLogFormatter\getPreloadTitles(), ApiRollback\getRbTitle(), CssContent\getRedirectTarget(), JavaScriptContent\getRedirectTarget(), WikitextContent\getRedirectTargetAndText(), SkinTemplate\getReturnToParam(), SpecialChangeCredentials\getReturnUrl(), SpecialRecentChangesLinked\getTargetTitle(), ParserOutput\getText(), UploadBase\getTitle(), CLIParser\getTitle(), ApiBase\getTitleFromTitleOrPageId(), MediaWiki\ResourceLoader\WikiModule\getTitleInfo(), ApiBase\getTitleOrPageId(), SpecialSearch\goResult(), ApiComparePages\guessTitle(), Parser\handleInternalLinks2(), LogPager\limitTitle(), PageArchive\listPagesByPrefix(), PageArchive\listPagesBySearch(), LoginSignupSpecialPage\load(), SpecialUndelete\loadRequest(), SpecialMergeHistory\loadRequestParams(), ChangeTags\logTagManagementAction(), PopulateArchiveRevId\makeDummyRevisionRow(), Skin\makeInternalOrExternalUrl(), Skin\makeKnownUrlDetails(), SkinTemplate\makeTalkUrlDetails(), PPFuzzTester\makeTitle(), Skin\makeUrlDetails(), MediaWiki\maybeDoHttpsRedirect(), TitleCleanup\moveIllegalPage(), CoreParserFunctions\mwnamespace(), CoreParserFunctions\namespacee(), CoreParserFunctions\namespacenumber(), MediaWiki\Block\Restriction\PageRestriction\newFromTitle(), ForeignAPIFile\newFromTitle(), MediaWikiSite\normalizePageName(), SpecialChangeContentModel\onSubmit(), SpecialRandomInCategory\onSubmit(), SpecialChangeEmail\onSuccess(), CoreParserFunctions\pageid(), CoreParserFunctions\pagename(), CoreParserFunctions\pagenamee(), CoreParserFunctions\pagesize(), Parser\parseLinkParameter(), BenchmarkTitleValue\parseTitle(), SpecialPage\prefixSearchString(), SpecialFileDuplicateSearch\prefixSearchSubpages(), MediaWiki\ResourceLoader\WikiModule\preloadTitleInfo(), Parser\Parsoid\Config\DataAccess\prepareParser(), SearchEngine\processCompletionResults(), WikiImporter\processLogItem(), TitleCleanup\processRow(), CleanupWatchlist\processRow(), CleanupCaps\processRowToUppercase(), CoreParserFunctions\protectionexpiry(), CoreParserFunctions\protectionlevel(), PurgePage\purge(), SearchExactMatchRescorer\redirectTargetsToRedirect(), Parser\renderImageGallery(), SearchExactMatchRescorer\rescore(), OutputPage\returnToMain(), CoreParserFunctions\revisionday(), CoreParserFunctions\revisionday2(), CoreParserFunctions\revisionid(), CoreParserFunctions\revisionmonth(), CoreParserFunctions\revisionmonth1(), CoreParserFunctions\revisiontimestamp(), CoreParserFunctions\revisionuser(), CoreParserFunctions\revisionyear(), SpecialComparePages\revOrTitle(), CoreParserFunctions\rootpagename(), CoreParserFunctions\rootpagenamee(), ApiQueryCategories\run(), ApiQueryImages\run(), ApiQueryLinks\run(), ApiQueryRecentChanges\run(), ApiQueryDeletedRevisions\run(), SpecialEditWatchlist\runWatchUnwatchCompleteHook(), SpecialChangeContentModel\setParameter(), WikiImporter\setTargetRootPage(), MediaWiki\ResourceLoader\WikiModule\shouldEmbedModule(), EditPage\showCustomIntro(), OutputPage\showPermissionsErrorPage(), SpecialSearch\showResults(), LoginHelper\showReturnToPage(), SpecialEditWatchlist\showTitles(), CoreParserFunctions\subjectpagename(), CoreParserFunctions\subjectpagenamee(), CoreParserFunctions\subjectspace(), CoreParserFunctions\subjectspacee(), WebInstallerName\submit(), CoreParserFunctions\subpagename(), CoreParserFunctions\subpagenamee(), Skin\subPageSubtitleInternal(), SpecialCreateAccount\successfulAction(), CoreParserFunctions\talkpagename(), CoreParserFunctions\talkpagenamee(), CoreParserFunctions\talkspace(), CoreParserFunctions\talkspacee(), and CoreParserFunctions\urlFunction().

◆ 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$textTitle text to check
int$defaultNamespace
Exceptions
MalformedTitleExceptionIf the title is invalid.
Returns
Title

Definition at line 405 of file Title.php.

References $t, Sanitizer\decodeCharReferencesAndNormalize(), and NS_MAIN.

Referenced by SpecialRedirect\dispatchFile(), PageDataRequestHandler\handleRequest(), SpecialRedirectWithAction\onFormSubmit(), SpecialNewSection\onFormSubmit(), SpecialPageLanguage\onSubmit(), MediaWiki\parseTitle(), HTMLTitleTextField\validate(), and SpecialChangeContentModel\validateTitle().

◆ 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. Hard deprecated in 1.39.
Parameters
TitleValue$titleValueAssumed to be safe.
string$forceCloneset to NEW_CLONE to ensure a fresh instance is returned.
Returns
Title

Definition at line 266 of file Title.php.

References wfDeprecated().

◆ 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$urlThe title, as might be taken from a URL
Returns
Title|null The new object, or null on an error

Definition at line 467 of file Title.php.

References $t.

Referenced by MediaWiki\parseTitle(), and CoreParserFunctions\urlFunction().

◆ 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 ResourceLoader Context) 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$localizerAn optional context to use (since 1.34)
Returns
Title

Definition at line 700 of file Title.php.

References $title, and wfMessage().

Referenced by EmaillingJob\__construct(), Skin\addToSidebarPlain(), ApiQuerySiteinfo\appendGeneralInfo(), Installer\createMainpage(), ApiRsd\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), SpecialChangeCredentials\getAuthForm(), HTMLForm\getCancelTargetURL(), ApiComparePages\getDiffRevision(), SpecialMyLanguage\getRedirect(), SkinMustache\getTemplateData(), XmlDumpWriter\homelink(), Skin\logoText(), PopulateArchiveRevId\makeDummyRevisionRow(), Skin\makeMainPageUrl(), SpecialChangeEmail\onSuccess(), MediaWiki\parseTitle(), OutputPage\returnToMain(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), OutputPage\showPermissionsErrorPage(), LoginHelper\showReturnToPage(), and MediaWikiTitleCodec\splitTitleString().

◆ normalizeFragment()

static Title::normalizeFragment (   $fragment)
staticprivate

Normalizes fragment part of the title.

Parameters
string$fragment
Returns
string

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

◆ prefix()

Title::prefix (   $name)
private

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

Parameters
string$nameThe text
Returns
string The prefixed text

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

References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DeferredUpdates\addUpdate(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\selectFieldValues(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and wfGetDB().

Referenced by WikiPage\doUpdateRestrictions().

◆ purgeSquid()

Title::purgeSquid ( )

Purge all applicable CDN URLs.

Deprecated:
since 1.35 Use HtmlCacheUpdater

Definition at line 3198 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$idPage ID, 0 for non-existent, or false for "unknown" (lazy-load)

Definition at line 2910 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
MalformedTitleExceptionOn malformed titles

Definition at line 2970 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$modelCONTENT_MODEL_XXX constant

Definition at line 1134 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$fragmentText

Definition at line 1808 of file Title.php.

◆ shouldReadLatest()

Title::shouldReadLatest ( int  $flags)
private
Parameters
int$flags
Returns
bool Whether $flags indicates that the latest information should be read from the primary database, bypassing caches.

Definition at line 1076 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
PreconditionExceptionif 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 4197 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$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
ExistingPageRecord
Exceptions
PreconditionExceptionif 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 4224 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 3676 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 444 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 1706 of file Title.php.

References $title, and wfLogWarning().

◆ wasLocalInterwiki()

Title::wasLocalInterwiki ( )

Was this a local interwiki link?

Returns
bool

Definition at line 976 of file Title.php.

Member Data Documentation

◆ $mArticleID

int Title::$mArticleID = -1

Article ID, fetched from the link cache on demand.

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

◆ $mDbkeyform

string Title::$mDbkeyform = ''
private

Main part with underscores.

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

◆ $mEstimateRevisions

int null Title::$mEstimateRevisions
private

Estimated number of revisions; null of not loaded.

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

◆ $mFragment

string Title::$mFragment = ''
private

Title fragment (i.e.

the bit after the #)

Definition at line 98 of file Title.php.

◆ $mHasSubpages

bool Title::$mHasSubpages
private

Whether a page has any subpages.

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

◆ $mInterwiki

string Title::$mInterwiki = ''
private

Interwiki prefix.

Definition at line 92 of file Title.php.

◆ $mIsBigDeletion

bool null Title::$mIsBigDeletion = null
private

Would deleting this page be a big deletion?

Definition at line 167 of file Title.php.

◆ $mIsValid

bool null Title::$mIsValid = null
private

Is the title known to be valid?

Definition at line 170 of file Title.php.

◆ $mLatestID

bool int Title::$mLatestID = false
protected

ID of most recent revision.

Definition at line 112 of file Title.php.

◆ $mLength

int Title::$mLength = -1
protected

The page length, 0 for special pages.

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

◆ $mNamespace

int Title::$mNamespace = NS_MAIN
private

Namespace index, i.e.

one of the NS_xxxx constants

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

◆ $mRedirect

null bool Title::$mRedirect = null

Is the article at this title a redirect?

Definition at line 150 of file Title.php.

◆ $mTextform

string Title::$mTextform = ''
private

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

Definition at line 80 of file Title.php.

◆ $mTitleValue

TitleValue null Title::$mTitleValue = null
private

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

one of the CONTENT_MODEL_XXX constants

Definition at line 164 of file Title.php.

◆ $mUrlform

string Title::$mUrlform = ''
private

URL-encoded form of the main part.

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

◆ $titleCache

MapCacheLRU null Title::$titleCache = null
staticprivate

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

◆ DEFAULT_NAMESPACE

const Title::DEFAULT_NAMESPACE = NS_MAIN
private

Namespace to assume when no namespace was passed to factory methods.

This must be NS_MAIN, as it's hardcoded in several places. See T2696. Used primarily for {{transclusion}} tags.

Definition at line 144 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 68 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 77 of file Title.php.


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