MediaWiki  master
Title Class Reference

Represents a title within MediaWiki. More...

Inheritance diagram for Title:
Collaboration diagram for Title:

Public Attributes

const CACHE_MAX = 1000
 Title::newFromText maintains a cache to avoid expensive re-normalization of commonly used titles. More...
 
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_LOCKING = self::READ_LATEST | 2
 Constants for object loading bitfield flags (higher => higher QoS) More...
 
const READ_NONE = -1
 

Static Private Attributes

static MapCacheLRU null $titleCache = null
 

Private member variables

Please use the accessor functions instead.

Access:\n private
string $mTextform = ''
 Text form (spaces not underscores) of the main part. More...
 
string $mUrlform = ''
 URL-encoded form of the main part. More...
 
string $mDbkeyform = ''
 Main part with underscores. More...
 
int $mNamespace = NS_MAIN
 Namespace index, i.e. More...
 
string $mInterwiki = ''
 Interwiki prefix. More...
 
string $mFragment = ''
 Title fragment (i.e. More...
 
int $mArticleID = -1
 Article ID, fetched from the link cache on demand. More...
 
array $mRestrictions = []
 Array of groups allowed to edit this article. More...
 
bool $mCascadeRestriction
 Cascade restrictions on this page to included templates and images? More...
 
 $mCascadingRestrictions
 Caching the results of getCascadeProtectionSources. More...
 
array $mCascadeSources
 Where are the cascading restrictions coming from on this page? More...
 
bool $mRestrictionsLoaded = false
 Boolean for initialisation on demand. More...
 
string null $prefixedText = null
 Text form including namespace/interwiki, initialised on demand. More...
 
mixed $mTitleProtection
 Cached value for getTitleProtection (create protection) More...
 
int $mDefaultNamespace = NS_MAIN
 Namespace index when there is no namespace. More...
 
null $mRedirect = null
 Is the article at this title a redirect? More...
 
bool $mLocalInterwiki = false
 Was this Title created from a string with a local interwiki prefix? More...
 
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 $mEstimateRevisions
 Estimated number of revisions; null of not loaded. More...
 
array $mNotificationTimestamp = []
 Associative array of user ID -> timestamp/false. 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
 A corresponding TitleValue object. 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...
 
bool int $mLatestID = false
 ID of most recent revision. More...
 
string bool $mOldRestrictions = false
 Comma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows. More...
 
array $mRestrictionsExpiry = []
 When do the restrictions on this page expire? More...
 
bool $mHasCascadingRestrictions
 Are cascading restrictions in effect on this page? More...
 
int $mLength = -1
 The page length, 0 for special pages. More...
 
static getTitleFormatter ()
 B/C kludge: provide a TitleParser for use by Title. More...
 
static getInterwikiLookup ()
 B/C kludge: provide an InterwikiLookup for use by Title. More...
 
static getTitleCache ()
 
static fixUrlQueryArgs ( $query, $query2=false)
 Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional second argument named variant. More...
 
 __construct ()
 
 loadFromRow ( $row)
 Load Title object fields from a DB row. More...
 
 isValid ()
 Returns true if the title is a valid link target, and that it has been properly normalized. 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...
 
 isExternal ()
 Is this Title interwiki? More...
 
 getInterwiki ()
 Get the interwiki prefix. More...
 
 wasLocalInterwiki ()
 Was this a local interwiki link? More...
 
 isTrans ()
 Determine whether the object refers to a page within this project and is transcludable. More...
 
 getTransWikiID ()
 Returns the DB name of the distant wiki which owns the object. More...
 
 getTitleValue ()
 Get a TitleValue object representing this Title. More...
 
 getText ()
 Get the text form (spaces not underscores) of the main part. More...
 
 getPartialURL ()
 Get the URL-encoded form of the main part. More...
 
 getDBkey ()
 Get the main part with underscores. More...
 
 getUserCaseDBKey ()
 Same as getDBkey() More...
 
 getNamespace ()
 Get the namespace index, i.e. More...
 
 getContentModel ( $flags=0)
 Get the page's content model id, see the CONTENT_MODEL_XXX constants. More...
 
 hasContentModel ( $id)
 Convenience method for checking a title's content model name. More...
 
 setContentModel ( $model)
 Set a proposed content model for the page for permissions checking. More...
 
 getNsText ()
 Get the namespace text. More...
 
 getSubjectNsText ()
 Get the namespace text of the subject (rather than talk) page. More...
 
 getTalkNsText ()
 Get the namespace text of the talk page. More...
 
 canHaveTalkPage ()
 Can this title have a corresponding talk page? More...
 
 canExist ()
 Can this title represent a page in the wiki's database? More...
 
 isWatchable ()
 Can this title be added to a user's watchlist? More...
 
 isSpecialPage ()
 Returns true if this is a special page. More...
 
 isSpecial ( $name)
 Returns true if this title resolves to the named special page. 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...
 
 inNamespace ( $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...
 
 hasSubjectNamespace ( $ns)
 Returns true if the title has the same subject namespace as the namespace specified. 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...
 
 isMovable ()
 Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable. More...
 
 isMainPage ()
 Is this the mainpage? More...
 
 isSubpage ()
 Is this a subpage? More...
 
 isConversionTable ()
 Is this a conversion table for the LanguageConverter? More...
 
 isWikitextPage ()
 Does that page contain wikitext, or it is JS, CSS or whatever? More...
 
 isSiteConfigPage ()
 Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI. More...
 
 isUserConfigPage ()
 Is this a "config" (.css, .json, or .js) sub-page of a user page? More...
 
 getSkinFromConfigSubpage ()
 Trim down a .css, .json, or .js subpage title to get the corresponding skin name. More...
 
 isUserCssConfigPage ()
 Is this a CSS "config" sub-page of a user page? More...
 
 isUserJsonConfigPage ()
 Is this a JSON "config" sub-page of a user page? More...
 
 isUserJsConfigPage ()
 Is this a JS "config" sub-page of a user page? More...
 
 isSiteCssConfigPage ()
 Is this a sitewide CSS "config" page? More...
 
 isSiteJsonConfigPage ()
 Is this a sitewide JSON "config" page? More...
 
 isSiteJsConfigPage ()
 Is this a sitewide JS "config" page? More...
 
 isRawHtmlMessage ()
 Is this a message which can contain raw HTML? More...
 
 isTalkPage ()
 Is this a talk page of some sort? 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...
 
 getSubjectPage ()
 Get a title object associated with the subject page of this talk page. 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...
 
 getDefaultNamespace ()
 Get the default namespace index, for when there is no namespace. More...
 
 getFragment ()
 Get the Title fragment (i.e. More...
 
 hasFragment ()
 Check if a Title fragment is set. More...
 
 getFragmentForURL ()
 Get the fragment in URL form, including the "#" character if there is one. More...
 
 setFragment ( $fragment)
 Set the fragment for this title. More...
 
 createFragmentTarget ( $fragment)
 Creates a new Title for a different fragment of the same page. More...
 
 getPrefixedDBkey ()
 Get the prefixed database key form. More...
 
 getPrefixedText ()
 Get the prefixed title with spaces. More...
 
 __toString ()
 Return a string representation of this title. More...
 
 getFullText ()
 Get the prefixed title with spaces, plus any fragment (part beginning with '#') More...
 
 getRootText ()
 Get the root page name text without a namespace, i.e. More...
 
 getRootTitle ()
 Get the root page name title, i.e. More...
 
 getBaseText ()
 Get the base page name without a namespace, i.e. More...
 
 getBaseTitle ()
 Get the base page name title, i.e. More...
 
 getSubpageText ()
 Get the lowest-level subpage name, i.e. More...
 
 getSubpage ( $text)
 Get the title for a subpage of the current page. More...
 
 getSubpageUrlForm ()
 Get a URL-encoded form of the subpage text. More...
 
 getPrefixedURL ()
 Get a URL-encoded title (not an actual URL) including interwiki. 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...
 
 getLocalURL ( $query='', $query2=false)
 Get a URL with no fragment or server name (relative URL) from a Title object. 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...
 
 getInternalURL ( $query='', $query2=false)
 Get the URL form for an internal link. More...
 
 getCanonicalURL ( $query='', $query2=false)
 Get the URL for a canonical link, for use in things like IRC and e-mail notifications. More...
 
 getEditURL ()
 Get the edit URL for this Title. More...
 
 quickUserCan ( $action, $user=null)
 Can $user perform $action on this page? This skips potentially expensive cascading permission checks as well as avoids expensive error formatting. More...
 
 userCan ( $action, $user=null, $rigor=PermissionManager::RIGOR_SECURE)
 Can $user perform $action on this page? More...
 
 getUserPermissionsErrors ( $action, $user, $rigor=PermissionManager::RIGOR_SECURE, $ignoreErrors=[])
 Can $user perform $action on this page? More...
 
 getRestrictionTypes ()
 Returns restriction types for the current Title. More...
 
 getTitleProtection ()
 Is this title subject to title protection? Title protection is the one applied against creation of such title. More...
 
 deleteTitleProtection ()
 Remove any title protection due to page existing. More...
 
 isSemiProtected ( $action='edit')
 Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels? More...
 
 isProtected ( $action='')
 Does the title correspond to a protected article? More...
 
 isNamespaceProtected (User $user)
 Determines if $user is unable to edit this page because it has been protected by $wgNamespaceProtection. More...
 
 isCascadeProtected ()
 Cascading protection: Return true if cascading restrictions apply to this page, false if not. More...
 
 areCascadeProtectionSourcesLoaded ( $getPages=true)
 Determines whether cascading protection sources have already been loaded from the database. More...
 
 getCascadeProtectionSources ( $getPages=true)
 Cascading protection: Get the source of any cascading restrictions on this page. More...
 
 areRestrictionsLoaded ()
 Accessor for mRestrictionsLoaded. More...
 
 getRestrictions ( $action)
 Accessor/initialisation for mRestrictions. More...
 
 getAllRestrictions ()
 Accessor/initialisation for mRestrictions. More...
 
 getRestrictionExpiry ( $action)
 Get the expiry time for the restriction against a given action. More...
 
 areRestrictionsCascading ()
 Returns cascading restrictions for the current article. More...
 
 loadRestrictionsFromRows ( $rows, $oldFashionedRestrictions=null)
 Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page. More...
 
 loadRestrictions ( $oldFashionedRestrictions=null, $flags=0)
 Load restrictions from the page_restrictions table. More...
 
 flushRestrictions ()
 Flush the protection cache in this object and force reload from the database. More...
 
 hasSubpages ()
 Does this have subpages? (Warning, usually requires an extra DB query.) More...
 
 getSubpages ( $limit=-1)
 Get all subpages of this page. 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...
 
 getArticleID ( $flags=0)
 Get the article ID for this Title from the link cache, adding it if necessary. More...
 
 isRedirect ( $flags=0)
 Is this an article that is a redirect page? Uses link cache, adding it if necessary. More...
 
 getLength ( $flags=0)
 What is the length of this page? Uses link cache, adding it if necessary. More...
 
 getLatestRevID ( $flags=0)
 What is the page_latest field for this page? More...
 
 resetArticleID ( $id)
 Inject a page ID, reset DB-loaded fields, and clear the link cache for this title. 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...
 
 getTemplateLinksTo ( $options=[])
 Get an array of Title objects using this Title as a template Also stores the IDs in the link cache. 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...
 
 getTemplateLinksFrom ( $options=[])
 Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache. More...
 
 getBrokenLinksFrom ()
 Get an array of Title objects referring to non-existent articles linked from this page. More...
 
 getCdnUrls ()
 Get a list of URLs to purge from the CDN cache when this page changes. More...
 
 purgeSquid ()
 Purge all applicable CDN URLs. More...
 
 isValidMoveOperation (&$nt, $auth=true, $reason='')
 Check whether a given move operation would be valid. More...
 
 moveTo (&$nt, $auth=true, $reason='', $createRedirect=true, array $changeTags=[])
 Move a title to a new location. More...
 
 moveSubpages ( $nt, $auth=true, $reason='', $createRedirect=true, array $changeTags=[])
 Move this page's subpages to be subpages of $nt. More...
 
 isSingleRevRedirect ()
 Locks the page row and check if this page is single revision redirect. More...
 
 isValidMoveTarget ( $nt)
 Checks if $this can be moved to a given Title. 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...
 
 pageCond ()
 Get an associative array for selecting this title from the "page" table. More...
 
 getPreviousRevisionID ( $revId, $flags=0)
 Get the revision ID of the previous revision. More...
 
 getNextRevisionID ( $revId, $flags=0)
 Get the revision ID of the next revision. More...
 
 getFirstRevision ( $flags=0)
 Get the first revision of the page. More...
 
 getEarliestRevTime ( $flags=0)
 Get the oldest revision timestamp of this page. More...
 
 isNewPage ()
 Check if this is a new page. More...
 
 isBigDeletion ()
 Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit. More...
 
 estimateRevisionCount ()
 Get the approximate revision count of this page. More...
 
 countRevisionsBetween ( $old, $new, $max=null)
 Get the number of revisions between the given revision. More...
 
 getAuthorsBetween ( $old, $new, $limit, $options=[])
 Get the authors between the given revisions or revision IDs. More...
 
 countAuthorsBetween ( $old, $new, $limit, $options=[])
 Get the number of authors between the given revisions or revision IDs. More...
 
 equals (LinkTarget $title)
 Compare with another title. More...
 
 isSubpageOf (Title $title)
 Check if this title is a subpage of another title. More...
 
 exists ( $flags=0)
 Check if page exists. More...
 
 isAlwaysKnown ()
 Should links to this title be shown as potentially viewable (i.e. 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...
 
 hasSourceText ()
 Does this page have source text? More...
 
 getDefaultMessageText ()
 Get the default (plain) message contents for an page that overrides an interface message key. More...
 
 invalidateCache ( $purgeTime=null)
 Updates page_touched for this page; called from LinksUpdate.php. More...
 
 touchLinks ()
 Update page_touched timestamps and send CDN purge messages for pages linking to this title. More...
 
 getTouched ( $db=null)
 Get the last touched timestamp. More...
 
 getNotificationTimestamp ( $user=null)
 Get the timestamp when this page was updated since the user last saw it. More...
 
 getNamespaceKey ( $prepend='nstab-')
 Generate strings used for xml 'id' names in monobook tabs. More...
 
 getRedirectsHere ( $ns=null)
 Get all extant redirects to this Title. More...
 
 isValidRedirectTarget ()
 Check if this Title is a valid redirect target. More...
 
 getBacklinkCache ()
 Get a backlink cache object. More...
 
 canUseNoindex ()
 Whether the magic words INDEX and NOINDEX function for this page. More...
 
 getCategorySortkey ( $prefix='')
 Returns the raw sort key to be used for categories, with the specified prefix. 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...
 
 getEditNotices ( $oldid=0)
 Get a list of rendered edit notices for this page. More...
 
 __sleep ()
 
 __wakeup ()
 Text form (spaces not underscores) of the main part. More...
 
static newFromDBkey ( $key)
 Create a new Title from a prefixed DB key. More...
 
static newFromTitleValue (TitleValue $titleValue, $forceClone='')
 Returns a Title given a TitleValue. More...
 
static newFromLinkTarget (LinkTarget $linkTarget, $forceClone='')
 Returns a Title given a LinkTarget. More...
 
static castFromLinkTarget ( $linkTarget)
 Same as newFromLinkTarget, but if passed null, returns null. 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 newFromURL ( $url)
 THIS IS NOT THE FUNCTION YOU WANT. 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 newFromRow ( $row)
 Make a Title object from a DB row. 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 newMainPage (MessageLocalizer $localizer=null)
 Create a new Title for the Main Page. More...
 
static nameOf ( $id)
 Get the prefixed DB key associated with an ID. More...
 
static legalChars ()
 Get a regex character class describing the legal characters in a link. More...
 
static convertByteClassToUnicodeClass ( $byteClass)
 Utility method for converting a character sequence from bytes to Unicode. More...
 
static makeName ( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
 Make a prefixed DB key from a DB key and a namespace index. More...
 
static compare (LinkTarget $a, LinkTarget $b)
 Callback for usort() to do title sorts by (namespace, title) More...
 
static getFilteredRestrictionTypes ( $exists=true)
 Get a filtered list of all restriction types supported by this wiki. More...
 
static purgeExpiredRestrictions ()
 Purge expired restrictions from the page_restrictions table. More...
 
static clearCaches ()
 Text form (spaces not underscores) of the main part. More...
 
static capitalize ( $text, $ns=NS_MAIN)
 Capitalize a text string for a title if it belongs to a namespace that capitalizes. More...
 
static getSelectFields ()
 Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries. More...
 
 lazyFillContentModel ( $model)
 If the content model field is not frozen then update it with a retreived value. More...
 
 warnIfPageCannotExist (Title $title, $method)
 
 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...
 
 getRelativeRevisionID ( $revId, $flags, $dir)
 Get next/previous revision ID relative to another revision ID. More...
 
 getDbPageLanguageCode ()
 Returns the page language code saved in the database, if $wgPageLanguageUseDB is set to true in LocalSettings.php, otherwise returns false. More...
 
 loadFieldFromDB ( $field, $flags)
 
 getTitleProtectionInternal ()
 Fetch title protection settings. More...
 

Additional Inherited Members

Detailed Description

Represents a title within MediaWiki.

Optionally may contain an interwiki designation or namespace.

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

Definition at line 42 of file Title.php.

Constructor & Destructor Documentation

◆ __construct()

Title::__construct ( )
Access:\n protected

Definition at line 219 of file Title.php.

Member Function Documentation

◆ __sleep()

Title::__sleep ( )
Returns
array

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

References getPrefixedText().

◆ __wakeup()

Title::__wakeup ( )

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

Definition at line 4773 of file Title.php.

References wfUrlencode().

◆ areCascadeProtectionSourcesLoaded()

Title::areCascadeProtectionSourcesLoaded (   $getPages = true)

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

Parameters
bool$getPagesTrue to check if the pages are loaded, or false to check if the status is loaded.
Returns
bool Whether or not the specified information has been loaded
Since
1.23

Definition at line 2675 of file Title.php.

◆ areRestrictionsCascading()

Title::areRestrictionsCascading ( )

Returns cascading restrictions for the current article.

Returns
bool

Definition at line 2831 of file Title.php.

References $mCascadeRestriction, and loadRestrictions().

◆ areRestrictionsLoaded()

Title::areRestrictionsLoaded ( )

Accessor for mRestrictionsLoaded.

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

Definition at line 2778 of file Title.php.

References $mRestrictionsLoaded.

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

Definition at line 1189 of file Title.php.

References getNamespace(), getText(), isExternal(), isValid(), and NS_MAIN.

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

◆ canHaveTalkPage()

Title::canHaveTalkPage ( )

Can this title have a corresponding talk page?

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

See also
NamespaceInfo::canHaveTalkPage
Since
1.30
Returns
bool True if this title either is a talk page or can have a talk page associated.

Definition at line 1175 of file Title.php.

Referenced by getOtherPage(), and getTalkPageIfDefined().

◆ canUseNoindex()

Title::canUseNoindex ( )

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

Returns
bool

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

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

◆ castFromLinkTarget()

static Title::castFromLinkTarget (   $linkTarget)
static

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

Parameters
LinkTarget | null$linkTargetAssumed to be safe (if not null).
Returns
Title|null

Definition at line 293 of file Title.php.

References newFromLinkTarget().

Referenced by TitleFactory\castFromLinkTarget(), Linker\formatAutocomments(), Linker\getUploadUrl(), Linker\makeBrokenImageLinkObj(), Linker\makeMediaLinkFile(), and WatchedItemStore\resetNotificationTimestamp().

◆ clearCaches()

static Title::clearCaches ( )
static

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

Definition at line 3296 of file Title.php.

References $titleCache, MapCacheLRU\clear(), and getTitleCache().

Referenced by ImportableOldRevisionImporter\import().

◆ compare()

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

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

Parameters
LinkTarget$a
LinkTarget$b
Returns
int Result of string comparison, or namespace comparison

Definition at line 838 of file Title.php.

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

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

Referenced by ResourceLoaderStartUpModule\getConfigSettings().

◆ countAuthorsBetween()

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

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

Used for diffs and other things that really need it.

Deprecated:
since 1.35 Use RevisionStore::countAuthorsBetween instead.
Parameters
int | Revision$oldOld revision or rev ID (first before range by default)
int | Revision$newNew revision or rev ID (first after range by default)
int$limitMaximum number of authors
string | array$options(Optional): Single option, or an array of options: 'include_old' Include $old in the range; $new is excluded. 'include_new' Include $new in the range; $old is excluded. 'include_both' Include both $old and $new in the range. Unknown option values are ignored.
Returns
int Number of revision authors in the range; zero if not both revisions exist

Definition at line 4092 of file Title.php.

References getAuthorsBetween().

◆ countRevisionsBetween()

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

Get the number of revisions between the given revision.

Used for diffs and other things that really need it.

Deprecated:
since 1.35 Use RevisionStore::countRevisionsBetween instead.
Parameters
int | Revision$oldOld revision or rev ID (first before range)
int | Revision$newNew revision or rev ID (first after range)
int | null$maxLimit of Revisions to count, will be incremented to detect truncations
Returns
int Number of revisions between these revisions.

Definition at line 4013 of file Title.php.

References getArticleID(), and Revision\newFromTitle().

◆ createFragmentTarget()

Title::createFragmentTarget (   $fragment)

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

Since
1.27
Parameters
string$fragment
Returns
Title

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1799 of file Title.php.

References getText(), and makeTitle().

◆ deleteTitleProtection()

Title::deleteTitleProtection ( )

Remove any title protection due to page existing.

Definition at line 2563 of file Title.php.

References DB_MASTER, and wfGetDB().

◆ equals()

Title::equals ( LinkTarget  $title)

◆ estimateRevisionCount()

Title::estimateRevisionCount ( )

Get the approximate revision count of this page.

Returns
int

Definition at line 3988 of file Title.php.

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

◆ exists()

Title::exists (   $flags = 0)

Check if page exists.

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

Parameters
int$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
bool

Definition at line 4132 of file Title.php.

References getArticleID(), and Hooks\run().

Referenced by estimateRevisionCount(), getRestrictionTypes(), getTitleProtectionInternal(), SpecialUpload\getUploadForm(), hasSourceText(), isKnown(), makeTitleSafe(), and UppercaseTitlesForUnicodeTransition\mungeTitle().

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

References isSpecialPage(), makeTitle(), and NS_SPECIAL.

◆ fixUrlQueryArgs()

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

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

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

Since
1.19 (r105919)
Parameters
array | string$query
string | string[] | bool$query2
Returns
string

Definition at line 2065 of file Title.php.

References wfArrayToCgi(), and wfDeprecated().

Referenced by getCanonicalURL(), getFullURL(), getInternalURL(), and getLocalURL().

◆ flushRestrictions()

Title::flushRestrictions ( )

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

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

Definition at line 2999 of file Title.php.

◆ getAllRestrictions()

Title::getAllRestrictions ( )

Accessor/initialisation for mRestrictions.

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

Definition at line 2805 of file Title.php.

References $mRestrictions, and loadRestrictions().

◆ getArticleID()

◆ getAuthorsBetween()

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

Get the authors between the given revisions or revision IDs.

Used for diffs and other things that really need it.

Since
1.23
Deprecated:
since 1.35 Use RevisionStore::getAuthorsBetween instead.
Parameters
int | Revision$oldOld revision or rev ID (first before range by default)
int | Revision$newNew revision or rev ID (first after range by default)
int$limitMaximum number of authors
string | array$options(Optional): Single option, or an array of options: 'include_old' Include $old in the range; $new is excluded. 'include_new' Include $new in the range; $old is excluded. 'include_both' Include both $old and $new in the range. Unknown option values are ignored.
Returns
array|null Names of revision authors in the range; null if not both revisions exist

Definition at line 4050 of file Title.php.

References getArticleID(), MediaWiki\User\UserIdentity\getName(), and Revision\newFromTitle().

Referenced by countAuthorsBetween().

◆ getBacklinkCache()

Title::getBacklinkCache ( )

Get a backlink cache object.

Returns
BacklinkCache

Definition at line 4506 of file Title.php.

References BacklinkCache\get().

◆ getBaseText()

Title::getBaseText ( )

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

the part before the subpage name

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'
Returns
string Base name

Definition at line 1947 of file Title.php.

References getText(), and hasSubpages().

Referenced by getBaseTitle().

◆ getBaseTitle()

Title::getBaseTitle ( )

Get the base page name title, i.e.

the part before the subpage name.

Example:
Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
# returns: Title{User:Foo/Bar}
Returns
Title Base title
Since
1.20

Definition at line 1977 of file Title.php.

References $title, getBaseText(), and makeTitleSafe().

◆ getBrokenLinksFrom()

Title::getBrokenLinksFrom ( )

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

Todo:
check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case).
Returns
Title[] Array of Title the Title objects

Definition at line 3508 of file Title.php.

References $dbr, $res, DB_REPLICA, getArticleID(), makeTitle(), 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 2327 of file Title.php.

References fixUrlQueryArgs(), getFragmentForURL(), getLocalURL(), PROTO_CANONICAL, Hooks\run(), and wfExpandUrl().

◆ getCascadeProtectionSources()

Title::getCascadeProtectionSources (   $getPages = true)

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

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, false for none, or true if such restrictions exist but $getPages was not set. Second is an array like that returned by Title::getAllRestrictions(), or an empty array if $getPages is false.

Definition at line 2692 of file Title.php.

References $dbr, $mCascadeSources, $mCascadingRestrictions, $mDbkeyform, $mHasCascadingRestrictions, $mNamespace, $res, DB_REPLICA, makeTitle(), NS_FILE, wfGetDB(), and wfTimestampNow().

Referenced by isCascadeProtected().

◆ getCategorySortkey()

Title::getCategorySortkey (   $prefix = '')

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

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

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

Definition at line 4534 of file Title.php.

References getText(), and Hooks\run().

Referenced by CategoryViewer\doCategoryQuery().

◆ getCdnUrls()

Title::getCdnUrls ( )

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

Returns
string[] Array of String the URLs

Definition at line 3544 of file Title.php.

References getInternalURL(), getPageLanguage(), isUserCssConfigPage(), isUserJsConfigPage(), isUserJsonConfigPage(), and Hooks\run().

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

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

References $mContentModel, getArticleID(), ContentHandler\getDefaultModelFor(), DBAccessObjectUtils\hasFlags(), lazyFillContentModel(), and loadFieldFromDB().

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

◆ getDBkey()

◆ getDbPageLanguageCode()

Title::getDbPageLanguageCode ( )
private

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

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

Returns
string|null|bool

Definition at line 4560 of file Title.php.

References $mDbPageLanguage, and $wgPageLanguageUseDB.

Referenced by getPageLanguage(), and getPageViewLanguage().

◆ getDefaultMessageText()

Title::getDefaultMessageText ( )

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

Primary use cases:

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

Definition at line 4275 of file Title.php.

References $lang, getText(), NS_MEDIAWIKI, MessageCache\singleton(), and wfMessage().

◆ getDefaultNamespace()

Title::getDefaultNamespace ( )

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

Returns
int Default namespace index

Definition at line 1731 of file Title.php.

References $mDefaultNamespace.

◆ getEarliestRevTime()

Title::getEarliestRevTime (   $flags = 0)

Get the oldest revision timestamp of this page.

Parameters
int$flagsBitfield of class READ_* constants
Returns
string|null MW timestamp

Definition at line 3939 of file Title.php.

References getFirstRevision().

◆ getEditNotices()

Title::getEditNotices (   $oldid = 0)

Get a list of rendered edit notices for this page.

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

Since
1.21
Parameters
int$oldidRevision ID that's being edited
Returns
array

Definition at line 4667 of file Title.php.

References $mNamespace, hasSubpages(), Hooks\run(), 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 2341 of file Title.php.

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

◆ getFilteredRestrictionTypes()

static Title::getFilteredRestrictionTypes (   $exists = true)
static

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

Parameters
bool$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 2448 of file Title.php.

References $wgRestrictionTypes.

Referenced by ApiQueryAllPages\getAllowedParams(), getRestrictionTypes(), and SpecialProtectedpages\getTypeMenu().

◆ getFirstRevision()

Title::getFirstRevision (   $flags = 0)

Get the first revision of the page.

Parameters
int$flagsBitfield of class READ_* constants
Returns
Revision|null If page doesn't exist

Definition at line 3907 of file Title.php.

References $revQuery, GAID_FOR_UPDATE, getArticleID(), DBAccessObjectUtils\getDBOptions(), Revision\getQueryInfo(), and wfGetDB().

Referenced by getEarliestRevTime().

◆ getFragment()

Title::getFragment ( )

Get the Title fragment (i.e.

\ the bit after the #) in text form

Use Title::hasFragment to check for a fragment

Returns
string Title fragment

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1742 of file Title.php.

References $mFragment.

Referenced by WikiPage\insertRedirectEntry().

◆ getFragmentForURL()

Title::getFragmentForURL ( )

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

Returns
string Fragment in URL form

Definition at line 1761 of file Title.php.

References getInterwikiLookup(), hasFragment(), and isExternal().

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

◆ getFullText()

Title::getFullText ( )

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

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

Definition at line 1877 of file Title.php.

References $mFragment, getPrefixedText(), and hasFragment().

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

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

References fixUrlQueryArgs(), getFragmentForURL(), getLocalURL(), Hooks\run(), and wfExpandUrl().

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

◆ getFullUrlForRedirect()

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

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

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

Note
Uses current protocol by default, since technically relative urls aren't allowed in redirects per HTTP spec, so this is not suitable for places where the url gets cached, as might pollute between https and non-https users.
See also
self::getLocalURL for the arguments.
Parameters
array | string$query
string$protoProtocol type to use in URL
Returns
string A url suitable to use in an HTTP location header.

Definition at line 2138 of file Title.php.

References getPrefixedDBkey(), SpecialPage\getTitleFor(), and isExternal().

◆ getInternalURL()

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

Get the URL form for an internal link.

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

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

See also
self::getLocalURL for the arguments.
Parameters
string | array$query
string | bool$query2Deprecated
Returns
string The URL

Definition at line 2303 of file Title.php.

References $wgInternalServer, $wgServer, fixUrlQueryArgs(), getLocalURL(), PROTO_HTTP, Hooks\run(), and wfExpandUrl().

Referenced by getCdnUrls().

◆ getInterwiki()

Title::getInterwiki ( )

Get the interwiki prefix.

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

Returns
string Interwiki prefix

Implements MediaWiki\Linker\LinkTarget.

Definition at line 924 of file Title.php.

References $mInterwiki.

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

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

Referenced by getFragmentForURL(), getLocalURL(), getTransWikiID(), isLocal(), and isTrans().

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

References $mLatestID, getArticleID(), DBAccessObjectUtils\hasFlags(), and loadFieldFromDB().

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

References $mLength, getArticleID(), DBAccessObjectUtils\hasFlags(), and loadFieldFromDB().

◆ 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
array Array of Title objects linking here

Definition at line 3442 of file Title.php.

References $res, DB_REPLICA, getArticleID(), WikiPage\getQueryInfo(), makeTitle(), newFromRow(), and wfGetDB().

Referenced by getTemplateLinksFrom().

◆ getLinksTo()

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

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

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

Parameters
array$optionsMay be FOR UPDATE
string$tableTable name
string$prefixFields prefix
Returns
Title[] Array of Title objects linking here

Definition at line 3384 of file Title.php.

References $res, DB_MASTER, DB_REPLICA, makeTitle(), and wfGetDB().

Referenced by getTemplateLinksTo().

◆ getLinkURL()

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

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

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

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

Parameters
string | string[]$query
bool$query2
string | int | bool$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 2278 of file Title.php.

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

◆ getLocalURL()

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

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

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

See also
self::getFullURL to always get an absolute URL.
self::getLinkURL to always get a URL that's the simplest URL that will be valid to link, locally, to the current Title.
self::newFromText to produce a Title object.
Parameters
string | 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 String of the URL.

Definition at line 2172 of file Title.php.

References $matches, $wgActionPaths, $wgArticlePath, $wgMainPageIsDomainRoot, $wgRequest, $wgScript, $wgServer, $wgVariantArticlePath, equals(), fixUrlQueryArgs(), PathRouter\getActionPaths(), getInterwikiLookup(), getNsText(), getPageLanguage(), getPrefixedDBkey(), isMainPage(), Hooks\run(), wfAppendQuery(), and wfUrlencode().

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

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

References getSubjectNsText().

◆ getNextRevisionID()

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

Get the revision ID of the next revision.

Deprecated:
since 1.34, use RevisionLookup::getNextRevision
Parameters
int$revIdRevision ID. Get the revision that was after this one.
int$flagsBitfield of class READ_* constants
Returns
int|bool Next revision ID, or false if none exists

Definition at line 3897 of file Title.php.

References getRelativeRevisionID().

◆ getNotificationTimestamp()

Title::getNotificationTimestamp (   $user = null)

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

Parameters
User | null$user
Returns
string|bool|null String timestamp, false if not watched, null if nothing is unseen

Definition at line 4379 of file Title.php.

◆ getNsText()

Title::getNsText ( )

Get the namespace text.

Returns
string|false Namespace text

Definition at line 1122 of file Title.php.

References getTitleFormatter(), isExternal(), and wfDebug().

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

◆ getOtherPage()

Title::getOtherPage ( )

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

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

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

◆ getPageLanguage()

Title::getPageLanguage ( )

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

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

Since
1.18
Returns
Language

Definition at line 4582 of file Title.php.

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

Referenced by getCdnUrls(), and getLocalURL().

◆ getPageViewLanguage()

Title::getPageViewLanguage ( )

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

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

Since
1.20
Returns
Language

Definition at line 4621 of file Title.php.

References $wgLang, getDbPageLanguageCode(), ContentHandler\getForTitle(), isSpecialPage(), and wfGetLangObj().

◆ getParentCategories()

Title::getParentCategories ( )

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

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

Definition at line 3785 of file Title.php.

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

Referenced by getParentCategoryTree().

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

References getParentCategories(), and newFromText().

◆ getPartialURL()

Title::getPartialURL ( )

Get the URL-encoded form of the main part.

Returns
string Main part of the title, URL-encoded

Definition at line 1005 of file Title.php.

References $mUrlform.

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

References $s, and prefix().

Referenced by PPTemplateFrame_Hash\__construct(), PPTemplateFrame_DOM\__construct(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), getFullUrlForRedirect(), getLocalURL(), isValidMoveTarget(), PPFrame_Hash\loopCheck(), PPFrame_DOM\loopCheck(), and RecentChange\newForCategorization().

◆ getPrefixedText()

◆ getPrefixedURL()

Title::getPrefixedURL ( )

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

Returns
string The URL-encoded form

Definition at line 2046 of file Title.php.

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

◆ getPreviousRevisionID()

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

Get the revision ID of the previous revision.

Deprecated:
since 1.34, use RevisionLookup::getPreviousRevision
Parameters
int$revIdRevision ID. Get the revision that was before this one.
int$flagsBitfield of class READ_* constants
Returns
int|bool Old revision ID, or false if none exists

Definition at line 3885 of file Title.php.

References getRelativeRevisionID().

◆ 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[] Array of Title redirects to this title

Definition at line 4446 of file Title.php.

References $dbr, $mDbkeyform, $mInterwiki, $mNamespace, $res, DB_REPLICA, isExternal(), newFromRow(), and wfGetDB().

◆ getRelativeRevisionID()

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

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

Parameters
int$revIdRevision ID. Get the revision that was before this one.
int$flagsBitfield of class READ_* constants
string$dir'next' or 'prev'
Returns
int|bool New revision ID, or false if none exists

Definition at line 3863 of file Title.php.

Referenced by getNextRevisionID(), and getPreviousRevisionID().

◆ getRestrictionExpiry()

Title::getRestrictionExpiry (   $action)

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

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

Definition at line 2819 of file Title.php.

References loadRestrictions().

◆ getRestrictions()

Title::getRestrictions (   $action)

Accessor/initialisation for mRestrictions.

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

References loadRestrictions().

Referenced by isProtected(), and isSemiProtected().

◆ getRestrictionTypes()

Title::getRestrictionTypes ( )

Returns restriction types for the current Title.

Returns
array Applicable restriction types

Definition at line 2466 of file Title.php.

References exists(), getFilteredRestrictionTypes(), getPrefixedText(), isSpecialPage(), NS_FILE, Hooks\run(), and wfDebug().

Referenced by isProtected(), and loadRestrictionsFromRows().

◆ getRootText()

Title::getRootText ( )

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

the leftmost part before any slashes

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

References getText(), and hasSubpages().

Referenced by getRootTitle().

◆ getRootTitle()

Title::getRootTitle ( )

Get the root page name title, i.e.

the leftmost part before any slashes

Example:
Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
# returns: Title{User:Foo}
Returns
Title Root title
Since
1.20

Definition at line 1924 of file Title.php.

References $title, getRootText(), and makeTitleSafe().

Referenced by isRawHtmlMessage().

◆ getSelectFields()

static Title::getSelectFields ( )
staticprotected

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

Uses $wgContentHandlerUseDB to determine whether to include page_content_model.

Returns
array

Definition at line 439 of file Title.php.

References $wgContentHandlerUseDB, and $wgPageLanguageUseDB.

◆ getSkinFromConfigSubpage()

Title::getSkinFromConfigSubpage ( )

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

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

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

References getNsText().

Referenced by getNamespaceKey().

◆ getSubjectPage()

Title::getSubjectPage ( )

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

Deprecated:
since 1.34, use NamespaceInfo::getSubjectPage
Returns
Title The object for the subject page

Definition at line 1649 of file Title.php.

References $title, makeTitle(), and warnIfPageCannotExist().

Referenced by getOtherPage().

◆ getSubpage()

Title::getSubpage (   $text)

Get the title for a subpage of the current page.

Example:
Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
# returns: Title{User:Foo/Bar/Baz/Asdf}
Parameters
string$textThe subpage name to add to the title
Returns
Title|null Subpage title, or null on an error
Since
1.20

Definition at line 2021 of file Title.php.

References getText(), and makeTitleSafe().

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

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

Referenced by hasSubpages().

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

References $mTextform, and hasSubpages().

Referenced by getSubpageUrlForm().

◆ getSubpageUrlForm()

Title::getSubpageUrlForm ( )

Get a URL-encoded form of the subpage text.

Returns
string URL-encoded subpage name

Definition at line 2035 of file Title.php.

References getSubpageText(), and wfUrlencode().

◆ getTalkNsText()

Title::getTalkNsText ( )

Get the namespace text of the talk page.

Returns
string Namespace text

Definition at line 1158 of file Title.php.

References getNsText().

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

References $title, makeTitle(), and warnIfPageCannotExist().

Referenced by getOtherPage(), and getTalkPageIfDefined().

◆ getTalkPageIfDefined()

Title::getTalkPageIfDefined ( )

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

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

Definition at line 1634 of file Title.php.

References canHaveTalkPage(), and getTalkPage().

◆ getTemplateLinksFrom()

Title::getTemplateLinksFrom (   $options = [])

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

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

Parameters
array$optionsMay be FOR UPDATE
Returns
Title[] Array of Title the Title objects used here

Definition at line 3496 of file Title.php.

References getLinksFrom().

◆ getTemplateLinksTo()

Title::getTemplateLinksTo (   $options = [])

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

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

Parameters
array$optionsQuery option to Database::select()
Returns
Title[] Array of Title the Title objects linking here

Definition at line 3426 of file Title.php.

References getLinksTo().

◆ getText()

◆ getTitleCache()

static Title::getTitleCache ( )
staticprivate
Returns
MapCacheLRU

Definition at line 425 of file Title.php.

References $titleCache.

Referenced by clearCaches(), and newFromTextThrow().

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

Referenced by getNsText().

◆ getTitleProtection()

Title::getTitleProtection ( )

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

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

Definition at line 2493 of file Title.php.

References getTitleProtectionInternal().

◆ getTitleProtectionInternal()

Title::getTitleProtectionInternal ( )
protected

Fetch title protection settings.

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

Returns
array|bool

Definition at line 2516 of file Title.php.

References $dbr, $mTitleProtection, $res, DB_REPLICA, exists(), CommentStore\getStore(), and wfGetDB().

Referenced by getTitleProtection(), and loadRestrictions().

◆ getTitleValue()

Title::getTitleValue ( )

Get a TitleValue object representing this Title.

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

Definition at line 973 of file Title.php.

References $mTitleValue, getPrefixedText(), and wfDebug().

◆ getTouched()

Title::getTouched (   $db = null)

Get the last touched timestamp.

Parameters
IDatabase | null$db
Returns
string|false Last-touched timestamp

Definition at line 4365 of file Title.php.

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

◆ getTransWikiID()

Title::getTransWikiID ( )

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

Returns
string|false The DB name

Definition at line 956 of file Title.php.

References getInterwikiLookup(), and isExternal().

◆ getUserCaseDBKey()

Title::getUserCaseDBKey ( )

Same as getDBkey()

Deprecated:
since 1.33; please use Title::getDBKey() instead
Returns
string DB key

Definition at line 1024 of file Title.php.

References getDBkey(), and wfDeprecated().

◆ getUserPermissionsErrors()

Title::getUserPermissionsErrors (   $action,
  $user,
  $rigor = PermissionManager::RIGOR_SECURE,
  $ignoreErrors = [] 
)

Can $user perform $action on this page?

Todo:
FIXME: This does not check throttles (User::pingLimiter()).
Parameters
string$actionAction that permission needs to be checked for
User$userUser to check
string$rigorOne of (quick,full,secure)
  • quick : does cheap permission checks from replica DBs (usable for GUI creation)
  • full : does cheap and expensive checks possibly from a replica DB
  • secure : does cheap and expensive checks, using the master as needed
array$ignoreErrorsArray of Strings Set this to a list of message keys whose corresponding errors may be ignored.
Returns
array[] Array of arrays of the arguments to wfMessage to explain permissions problems.
Exceptions
Exception
Deprecated:
since 1.33, use MediaWikiServices::getInstance()->getPermissionManager()->getPermissionErrors()

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

References getContentModel().

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

◆ hasFragment()

Title::hasFragment ( )

Check if a Title fragment is set.

Returns
bool
Since
1.23

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1752 of file Title.php.

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

◆ hasSourceText()

Title::hasSourceText ( )

Does this page have source text?

Returns
bool

Definition at line 4217 of file Title.php.

References exists(), NS_MEDIAWIKI, MessageCache\singleton(), and wfMessage().

Referenced by isAlwaysKnown().

◆ hasSubjectNamespace()

Title::hasSubjectNamespace (   $ns)

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

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

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

Since
1.19
Parameters
int$ns
Returns
bool

Definition at line 1335 of file Title.php.

◆ hasSubpages()

Title::hasSubpages ( )

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

Returns
bool

Definition at line 3050 of file Title.php.

References $mHasSubpages, and getSubpages().

Referenced by getBaseText(), getEditNotices(), getRootText(), getSubpages(), getSubpageText(), and isSubpage().

◆ inNamespace()

Title::inNamespace (   $ns)

Returns true if the title is inside the specified namespace.

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

Parameters
int$nsThe namespace
Returns
bool
Since
1.19

Implements MediaWiki\Linker\LinkTarget.

Definition at line 1296 of file Title.php.

References equals().

Referenced by inNamespaces(), and isRawHtmlMessage().

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

References inNamespace().

◆ invalidateCache()

Title::invalidateCache (   $purgeTime = null)

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

Parameters
string | null$purgeTime[optional] TS_MW timestamp
Returns
bool True if the update succeeded

Definition at line 4298 of file Title.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), DeferredUpdates\addUpdate(), DB_MASTER, ResourceLoaderWikiModule\invalidateModuleCache(), pageCond(), DeferredUpdates\PRESEND, Wikimedia\Rdbms\IDatabase\timestamp(), Wikimedia\Rdbms\IDatabase\update(), wfGetDB(), and wfReadOnly().

Referenced by File\purgeDescription().

◆ isAlwaysKnown()

Title::isAlwaysKnown ( )

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

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

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

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

Returns
bool

Definition at line 4154 of file Title.php.

References hasSourceText(), isExternal(), NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, NS_SPECIAL, and Hooks\run().

Referenced by isKnown().

◆ isBigDeletion()

Title::isBigDeletion ( )

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

Returns
bool

Definition at line 3959 of file Title.php.

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

◆ isCascadeProtected()

Title::isCascadeProtected ( )

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

Returns
bool If the page is subject to cascading restrictions.

Definition at line 2661 of file Title.php.

References getCascadeProtectionSources().

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

◆ isConversionTable()

Title::isConversionTable ( )

Is this a conversion table for the LanguageConverter?

Returns
bool

Definition at line 1403 of file Title.php.

References getText(), and NS_MEDIAWIKI.

◆ isDeleted()

Title::isDeleted ( )

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

Returns
int The number of archived revisions

Definition at line 3111 of file Title.php.

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

◆ isDeletedQuick()

Title::isDeletedQuick ( )

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

Returns
bool

Definition at line 3136 of file Title.php.

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

Referenced by File\wasDeleted().

◆ isExternal()

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

References exists(), and isAlwaysKnown().

◆ isLocal()

Title::isLocal ( )

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

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

Definition at line 898 of file Title.php.

References getInterwikiLookup(), and isExternal().

◆ isMainPage()

Title::isMainPage ( )

Is this the mainpage?

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

Definition at line 1382 of file Title.php.

References equals().

Referenced by getLocalURL().

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

References isExternal(), and Hooks\run().

◆ isNamespaceProtected()

Title::isNamespaceProtected ( User  $user)

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

Deprecated:
since 1.34 Don't use this function in new code.
Parameters
User$userUser object to check permissions
Returns
bool

Definition at line 2642 of file Title.php.

References $wgNamespaceProtection.

◆ isNewPage()

Title::isNewPage ( )

Check if this is a new page.

Returns
bool

Definition at line 3949 of file Title.php.

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

◆ isProtected()

Title::isProtected (   $action = '')

Does the title correspond to a protected article?

Parameters
string$actionThe action the page is protected from, by default checks all actions.
Returns
bool

Definition at line 2609 of file Title.php.

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

◆ isRawHtmlMessage()

Title::isRawHtmlMessage ( )

Is this a message which can contain raw HTML?

Returns
bool
Since
1.32

Definition at line 1573 of file Title.php.

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

◆ isRedirect()

Title::isRedirect (   $flags = 0)

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

Parameters
int$flagsEither a bitfield of class READ_* constants or GAID_FOR_UPDATE
Returns
bool

Definition at line 3190 of file Title.php.

References $mRedirect, getArticleID(), DBAccessObjectUtils\hasFlags(), and loadFieldFromDB().

Referenced by CategoryViewer\addSubcategoryObject().

◆ isSemiProtected()

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

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

Parameters
string$actionAction to check (default: edit)
Returns
bool

Definition at line 2581 of file Title.php.

References $wgSemiprotectedRestrictionLevels, and getRestrictions().

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

References DB_MASTER, loadFromRow(), pageCond(), and wfGetDB().

◆ isSiteConfigPage()

Title::isSiteConfigPage ( )

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

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

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

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

Returns
bool
Since
1.31

Definition at line 1433 of file Title.php.

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

◆ isSiteCssConfigPage()

Title::isSiteCssConfigPage ( )

Is this a sitewide CSS "config" page?

Returns
bool
Since
1.32

Definition at line 1519 of file Title.php.

References CONTENT_MODEL_CSS, hasContentModel(), and NS_MEDIAWIKI.

Referenced by isSiteConfigPage().

◆ isSiteJsConfigPage()

Title::isSiteJsConfigPage ( )

Is this a sitewide JS "config" page?

Returns
bool
Since
1.31

Definition at line 1555 of file Title.php.

References CONTENT_MODEL_JAVASCRIPT, hasContentModel(), and NS_MEDIAWIKI.

Referenced by isSiteConfigPage().

◆ isSiteJsonConfigPage()

Title::isSiteJsonConfigPage ( )

Is this a sitewide JSON "config" page?

Returns
bool
Since
1.32

Definition at line 1537 of file Title.php.

References CONTENT_MODEL_JSON, hasContentModel(), and NS_MEDIAWIKI.

Referenced by isSiteConfigPage().

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

References isSpecialPage().

Referenced by isValidRedirectTarget().

◆ isSpecialPage()

Title::isSpecialPage ( )

◆ isSubpage()

Title::isSubpage ( )

Is this a subpage?

Returns
bool

Definition at line 1391 of file Title.php.

References getText(), and hasSubpages().

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

◆ isSubpageOf()

Title::isSubpageOf ( Title  $title)

Check if this title is a subpage of another title.

Parameters
Title$title
Returns
bool

Definition at line 4116 of file Title.php.

References $title.

◆ isTalkPage()

Title::isTalkPage ( )

Is this a talk page of some sort?

Returns
bool

Definition at line 1588 of file Title.php.

Referenced by getOtherPage().

◆ isTrans()

Title::isTrans ( )

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

Returns
bool True if this is transcludable

Definition at line 943 of file Title.php.

References getInterwikiLookup(), and isExternal().

◆ isUserConfigPage()

Title::isUserConfigPage ( )

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

Returns
bool
Since
1.31

Definition at line 1447 of file Title.php.

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

◆ isUserCssConfigPage()

Title::isUserCssConfigPage ( )

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

Returns
bool
Since
1.31

Definition at line 1477 of file Title.php.

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

Referenced by getCdnUrls(), and isUserConfigPage().

◆ isUserJsConfigPage()

Title::isUserJsConfigPage ( )

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

Returns
bool
Since
1.31

Definition at line 1505 of file Title.php.

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

Referenced by getCdnUrls(), and isUserConfigPage().

◆ isUserJsonConfigPage()

Title::isUserJsonConfigPage ( )

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

Returns
bool
Since
1.31

Definition at line 1491 of file Title.php.

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

Referenced by getCdnUrls(), and isUserConfigPage().

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

References $mIsValid, and getFullText().

Referenced by canExist().

◆ isValidMoveOperation()

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

Check whether a given move operation would be valid.

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

Deprecated:
since 1.25, use MovePage's methods instead
Parameters
Title&$ntThe new title
bool$authWhether to check user permissions (uses $wgUser)
string$reasonIs the log summary of the move, used for spam checking
Returns
array|bool True on success, getUserPermissionsErrors()-like array on failure

Definition at line 3591 of file Title.php.

References wfDeprecated(), and wfMergeErrorArrays().

◆ isValidMoveTarget()

Title::isValidMoveTarget (   $nt)

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

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

    Deprecated:
    since 1.25, use MovePage's methods instead
    Parameters
    Title$ntThe new title to check
    Returns
    bool

Definition at line 3734 of file Title.php.

References $content, $file, getPrefixedDBkey(), Revision\newFromTitle(), NS_FILE, wfDebug(), and wfDeprecated().

◆ isValidRedirectTarget()

Title::isValidRedirectTarget ( )

Check if this Title is a valid redirect target.

Returns
bool

Definition at line 4482 of file Title.php.

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

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

◆ isWatchable()

Title::isWatchable ( )

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

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

Returns
bool

Definition at line 1233 of file Title.php.

References getText(), and isExternal().

◆ isWikitextPage()

Title::isWikitextPage ( )

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

Returns
bool

Definition at line 1415 of file Title.php.

References CONTENT_MODEL_WIKITEXT, and hasContentModel().

◆ lazyFillContentModel()

Title::lazyFillContentModel (   $model)
private

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

Parameters
string | bool$modelCONTENT_MODEL_XXX constant or false

Definition at line 1111 of file Title.php.

Referenced by getContentModel(), and loadFromRow().

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

References $wgLegalTitleChars.

Referenced by CleanupImages\buildSafeTitle(), ResourceLoaderStartUpModule\getConfigSettings(), MediaWikiTitleCodec\getTitleInvalidRegex(), and wfStripIllegalFilenameChars().

◆ loadFieldFromDB()

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

Definition at line 4742 of file Title.php.

References GAID_FOR_UPDATE, DBAccessObjectUtils\getDBOptions(), pageCond(), and wfGetDB().

Referenced by getArticleID(), getContentModel(), getLatestRevID(), getLength(), and isRedirect().

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

References lazyFillContentModel().

Referenced by isSingleRevRedirect().

◆ loadRestrictions()

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

Load restrictions from the page_restrictions table.

Parameters
string | null$oldFashionedRestrictionsComma-separated set of permission keys indicating who can move or edit the page from the page table, (pre 1.10) rows. Edit and move sections are separated by a colon Example: "edit=autoconfirmed,sysop:move=sysop"
int$flagsA bit field. If self::READ_LATEST is set, skip replicas and read from the master DB.

Definition at line 2928 of file Title.php.

References $cache, $dbr, DB_MASTER, DB_REPLICA, getArticleID(), getTitleProtectionInternal(), DBAccessObjectUtils\hasFlags(), loadRestrictionsFromRows(), wfGetDB(), and wfTimestampNow().

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

◆ loadRestrictionsFromRows()

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

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

Public for usage by LiquidThreads.

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

Definition at line 2850 of file Title.php.

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

Referenced by loadRestrictions().

◆ makeName()

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

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

Parameters
int$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 811 of file Title.php.

References $title.

Referenced by SpecialRedirect\dispatchFile(), MovePageForm\doSubmit(), SpecialExport\getPagesFromCategory(), SpecialExport\getPagesFromNamespace(), makeTitleSafe(), nameOf(), 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 584 of file Title.php.

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

Referenced by DeletePageJob\__construct(), JobSpecification\__construct(), Job\__construct(), CategoryViewer\addFragmentToTitle(), ChangesFeed\buildItems(), FindOrphanedFiles\checkFiles(), LocalRepo\checkRedirect(), Orphans\checkSeparation(), SpecialEditWatchlist\cleanupWatchlist(), CompressOld\compressWithConcat(), BenchmarkTitleValue\constructTitle(), ApiFeedWatchlist\createFeedItem(), createFragmentTarget(), SpecialRedirect\dispatchUser(), UppercaseTitlesForUnicodeTransition\doMove(), UppercaseTitlesForUnicodeTransition\doUpdate(), LinkHolderArray\doVariants(), CheckBadRedirects\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), DeleteDefaultMessages\execute(), FixDoubleRedirects\execute(), AttachLatest\execute(), DumpLinks\execute(), ApiComparePages\execute(), PurgeChangedPages\execute(), NukeNS\execute(), DeleteEqualMessages\execute(), SqlSearchResultSet\extractResults(), ApiQueryLogEvents\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), Job\factory(), ApiFeedContributions\feedItem(), SpecialNewpages\feedItem(), SpecialRecentChanges\filterByCategories(), ForeignAPIRepo\findBySha1(), DoubleRedirectJob\fixRedirects(), fixSpecialName(), WikiFilePage\followRedirect(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), ApiParse\formatCategoryLinks(), FeedUtils\formatDiff(), ApiParse\formatLinks(), SpecialUnusedTemplates\formatResult(), SpecialUnusedCategories\formatResult(), SpecialUncategorizedCategories\formatResult(), SpecialListDuplicatedFiles\formatResult(), SpecialAncientPages\formatResult(), SpecialWantedCategories\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialListRedirects\formatResult(), SpecialMIMESearch\formatResult(), DeletedContribsPager\formatRevisionRow(), NewFilesPager\formatRow(), SpecialNewpages\formatRow(), AllMessagesTablePager\formatValue(), ImageListPager\formatValue(), SearchSuggestion\fromText(), LinksUpdate\getAddedLinks(), getBrokenLinksFrom(), User\getCanonicalName(), getCascadeProtectionSources(), ApiUpload\getChunkResult(), PopulateContentTables\getContentModel(), ApiComparePages\getDiffRevision(), ApiErrorFormatter\getDummyTitle(), CategoriesRdf\getDumpURI(), DoubleRedirectJob\getFinalDestination(), WikiPage\getHiddenCategories(), ChangeTagsLogItem\getHTML(), RevDelLogItem\getHTML(), SpecialExport\getLinks(), getLinksFrom(), getLinksTo(), SearchNearMatcher\getNearMatchInternal(), MediaWiki\Search\ParserOutputSearchDataExtractor\getOutgoingLinks(), NewUsersLogFormatter\getPreloadTitles(), ApiQueryInfo\getProtectionInfo(), SpecialRandomInCategory\getRandomTitle(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), File\getRedirectedTitle(), WikiFilePage\getRedirectTarget(), SpecialListRedirects\getRedirectTarget(), WikiPage\getRedirectTarget(), ApiPageSet\getRedirectTargets(), LinksUpdate\getRemovedLinks(), RollbackEdits\getRollbackTitles(), getSubjectPage(), getTalkPage(), RCDatabaseLogEntry\getTarget(), DatabaseLogEntry\getTarget(), MediaWiki\Search\ParserOutputSearchDataExtractor\getTemplates(), EditPage\getTemplates(), RecentChange\getTitle(), DifferenceEngine\getTitle(), User\getTokenUrl(), ExternalUserNames\getUserLinkTitle(), UserRightsProxy\getUserPage(), User\getUserPage(), FixDefaultJsonContentPages\handleRow(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget\headerHtml(), ImagePage\imageLinks(), ApiPageSet\initFromQueryResult(), ApiPageSet\initFromRevIDs(), CategoriesRdf\labelToUrl(), MessageCache\loadCachedMessagePageEntry(), MediaWiki\Rest\EntryPoint\main(), MediaWiki\main(), TitleFactory\makeTitle(), NamespaceDupes\mergePage(), UppercaseTitlesForUnicodeTransition\mungeTitle(), Revision\newFromArchiveRow(), JobSpecification\newFromArray(), newFromLinkTarget(), OldLocalFile\newFromRow(), LocalFile\newFromRow(), ArchivedFile\newFromRow(), newFromRow(), Article\newFromTitle(), Revision\RevisionStore\newRevisionFromArchiveRow(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), InfoAction\pageInfo(), MessageCache\parse(), MediaWiki\parseTitle(), ApiUpload\performUpload(), PopulateContentModel\populateRevisionOrArchive(), RebuildTextIndex\populateSearchIndex(), SpecialBlock\processForm(), CleanupWatchlist\processRow(), CleanupCaps\processRowToLowercase(), CleanupCaps\processRowToUppercase(), SpecialUnblock\processUnblock(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), MessageCache\refreshAndReplaceInternal(), LinkHolderArray\replaceInternal(), ApiQueryDeletedRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryLangBacklinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryCategories\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryLinks\run(), ApiQueryAllImages\run(), ApiQueryQueryPage\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), DoubleRedirectJob\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), ApiOpenSearch\search(), SearchSuggestion\setText(), SpecialAllPages\showChunk(), SpecialWhatLinksHere\showIndirectLinks(), SpecialUpload\showUploadWarning(), CoreParserFunctions\urlFunction(), 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 610 of file Title.php.

References $t, $title, exists(), and makeName().

Referenced by ImageListPager\__construct(), ActiveUsersPager\__construct(), UsersPager\__construct(), AllMessagesTablePager\__construct(), ParserOutput\addTrackingCategory(), CleanupImages\buildSafeTitle(), BenchmarkTitleValue\constructTitleSafe(), NaiveImportTitleFactory\createTitleFromForeignTitle(), NamespaceImportTitleFactory\createTitleFromForeignTitle(), PrefixSearch\defaultSearchBackend(), DifferenceEngine\deletedLink(), MovePageForm\doSubmit(), LinkHolderArray\doVariants(), Revision\ensureTitle(), SpecialLog\execute(), SpecialContributions\execute(), MakeTestEdits\execute(), SpecialExport\execute(), ImportSiteScripts\execute(), RefreshLinks\execute(), RebuildFileCache\execute(), MovePageForm\execute(), ImportImages\execute(), ApiQueryInfo\execute(), SpecialNewpages\form(), Linker\formatLinksInComment(), PageQueryPage\formatResult(), WantedQueryPage\formatResult(), SpecialFewestRevisions\formatResult(), SpecialMostLinkedCategories\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialShortPages\formatResult(), SpecialProtectedtitles\formatRow(), ProtectedPagesPager\formatValue(), ImageListPager\formatValue(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), NamespaceDupes\getAlternateTitle(), getBaseTitle(), LinksUpdate\getCategoryInsertions(), NamespaceDupes\getDestinationTitle(), SpecialUncategorizedCategories\getExceptionList(), SpecialAllPages\getNamespaceKeyAndText(), SpecialEditWatchlist\getNormalForm(), WantedFilesPage\getPageHeader(), NewPagesPager\getQueryInfo(), RandomPage\getRandomTitle(), getRootTitle(), SpecialPage\getSafeTitleFor(), MergeHistoryPager\getStartBody(), LogPager\getStartBody(), getSubpage(), SpecialBlock\getTargetUserTitle(), Category\getTitle(), TrackingCategories\getTrackingCategories(), SpecialUpload\getUploadForm(), SpecialUpload\getWatchCheck(), SpecialEditWatchlist\getWatchlist(), User\idFromName(), ChangeTags\isTagNameValid(), LogPager\limitPerformer(), ArchivedFile\loadFromRow(), Skin\makeNSUrl(), Linker\makeThumbLink2(), TitleFactory\makeTitleSafe(), TitleCleanup\moveInconsistentPage(), MovePage\moveSubpagesInternal(), Category\newFromName(), File\normalizeTitle(), SpecialRandomInCategory\onSubmit(), ImageQueryPage\outputResults(), CoreParserFunctions\pagesincategory(), CleanupImages\processRow(), RefreshLinksJob\run(), CategoryFinder\seed(), RevisionDeleteUser\setUsernameBitfields(), SpecialUndelete\showHistory(), SpecialBookSources\showList(), SpecialUndelete\showList(), SpecialAllPages\showToplevel(), SpecialUpload\showViewDeletedLinks(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), CoreParserFunctions\special(), PrefixSearch\specialSearch(), ApiQueryBase\titlePartToKey(), ApiFileRevert\validateParameters(), and wfStreamThumb().

◆ moveSubpages()

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

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

Deprecated:
since 1.34, use MovePage instead
Parameters
Title$ntMove target
bool$authWhether $wgUser's permissions should be checked
string$reasonThe reason for the move
bool$createRedirectWhether to create redirects from the old subpages to the new ones Ignored if the user doesn't have the 'suppressredirect' right
array$changeTagsApplied to the entry in the move log and redirect page revision
Returns
array Array with old page titles as keys, and strings (new page titles) or getUserPermissionsErrors()-like arrays (errors) as values, or a getUserPermissionsErrors()-like error array with numeric indices if no pages were moved

Definition at line 3660 of file Title.php.

References wfDeprecated().

◆ moveTo()

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

Move a title to a new location.

Deprecated:
since 1.25, use the MovePage class instead
Parameters
Title&$ntThe new title
bool$authIndicates whether $wgUser's permissions should be checked
string$reasonThe reason for the move
bool$createRedirectWhether to create a redirect from the old title to the new title. Ignored if the user doesn't have the suppressredirect right.
array$changeTagsApplied to the entry in the move log and redirect page revision
Returns
array|bool True on success, getUserPermissionsErrors()-like array on failure

Definition at line 3627 of file Title.php.

References wfDeprecated().

◆ nameOf()

static Title::nameOf (   $id)
static

Get the prefixed DB key associated with an ID.

Parameters
int$idThe page_id of the article
Returns
string|null An object representing the article, or null if no such article was found

Definition at line 671 of file Title.php.

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

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

References $t.

Referenced by TitleFactory\newFromDBkey().

◆ newFromID()

◆ 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

Definition at line 490 of file Title.php.

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

Referenced by TitleFactory\newFromIDs(), and Revision\RevisionStore\newRevisionsFromBatch().

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

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

Referenced by ActivityUpdateJob\__construct(), MediaWiki\Linker\LinkRenderer\buildAElement(), castFromLinkTarget(), MediaWiki\Permissions\PermissionManager\checkActionPermissions(), MediaWiki\Permissions\PermissionManager\checkCascadingSourcesRestrictions(), MediaWiki\Permissions\PermissionManager\checkPageRestrictions(), MediaWiki\Permissions\PermissionManager\checkPermissionHooks(), MediaWiki\Permissions\PermissionManager\checkQuickPermissions(), MediaWiki\Permissions\PermissionManager\checkReadPermissions(), MediaWiki\Permissions\PermissionManager\checkSiteConfigPermissions(), MediaWiki\Permissions\PermissionManager\checkSpecialsAndNSPermissions(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), MediaWiki\Permissions\PermissionManager\checkUserConfigPermissions(), ApiExpandTemplates\execute(), ApiComparePages\execute(), ApiQueryRevisionsBase\extractDeprecatedContent(), ApiQueryWatchlist\extractOutputData(), ApiQueryRevisionsBase\extractRevisionInfo(), TemplatesOnThisPageFormatter\formatTemplate(), Revision\MainSlotRoleHandler\getDefaultModel(), ApiComparePages\getDiffRevision(), WANCacheReapUpdate\getEventAffectedKeys(), Linker\getImageLinkMTOParams(), MediaWiki\Linker\LinkRenderer\getLinkURL(), Revision\RevisionRenderer\getRenderedRevision(), Revision\RevisionStore\getRevisionByTitle(), Revision\getTitle(), ApiComparePages\guessTitle(), Revision\RevisionStore\insertRevisionOn(), Revision\MainSlotRoleHandler\isAllowedModel(), MediaWiki\Permissions\PermissionManager\isBlockedFrom(), Linker\makeImageLink(), MediaWiki\Linker\LinkRenderer\makeLink(), Linker\makeSelfLinkObj(), Linker\makeThumbLink2(), TitleFactory\newFromLinkTarget(), Revision\MutableRevisionRecord\newFromParentRevision(), newFromTitleValue(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryRevisions\run(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), DifferenceEngine\setRevisions(), ManualLogEntry\setTarget(), and ApiComparePages\setVals().

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

References newFromTextThrow().

Referenced by DoubleRedirectJob\__construct(), ImageListPager\__construct(), Installer\__construct(), Skin\addToSidebarPlain(), CoreParserFunctions\basepagename(), CoreParserFunctions\basepagenamee(), SkinTemplate\buildPersonalUrls(), ImageListPager\buildQueryConds(), CoreParserFunctions\cascadingsources(), SpecialComparePages\checkExistingTitle(), LocalRepo\checkRedirect(), Skin\checkTitle(), ApiFeedWatchlist\createFeedItem(), SubpageImportTitleFactory\createTitleFromForeignTitle(), CoreParserFunctions\displaytitle(), SpecialExport\doExport(), SpecialRecentChangesLinked\doMainQuery(), PurgeList\doPurge(), GenderCache\doTitlesArray(), Skin\drawCategoryBrowser(), ApiUndelete\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiWatch\execute(), PageExists\execute(), ApiRevisionDelete\execute(), ApiExpandTemplates\execute(), Undelete\execute(), ApiQueryAllMessages\execute(), ApiQueryLangLinks\execute(), SpecialLog\execute(), ApiQueryIWLinks\execute(), ViewCLI\execute(), SpecialGoToInterwiki\execute(), FormatInstallDoc\execute(), NukePage\execute(), SpecialListGroupRights\execute(), SpecialPasswordPolicies\execute(), GetTextMaint\execute(), Protect\execute(), ApiParse\execute(), ApiQueryImageInfo\execute(), FixDoubleRedirects\execute(), ApiQueryLogEvents\execute(), SpecialWhatLinksHere\execute(), RollbackEdits\execute(), EditCLI\execute(), DumpIterator\execute(), ImportTextFiles\execute(), DeleteBatch\execute(), SpecialExpandTemplates\execute(), MoveBatch\execute(), BenchmarkParse\execute(), MovePageForm\execute(), SpecialEditTags\execute(), SpecialFileDuplicateSearch\execute(), UppercaseTitlesForUnicodeTransition\execute(), SpecialSearch\execute(), SpecialRevisionDelete\execute(), SpecialEditWatchlist\extractTitles(), ResourceLoaderWikiModule\fetchTitleInfo(), SpecialMyLanguage\findTitle(), ApiHelp\fixHelpLinks(), Skin\footerLinkTitle(), ApiParse\formatIWLinks(), ApiParse\formatLangLinks(), Linker\formatLinksInComment(), LogFormatter\formatParameterValue(), LogFormatter\formatParameterValueForApi(), SpecialMIMESearch\formatResult(), CoreParserFunctions\fullpagename(), CoreParserFunctions\fullpagenamee(), CoreParserFunctions\gender(), MoveLogFormatter\getActionLinks(), User\getCanonicalName(), Skin\getCategoryLinks(), ResourceLoaderWikiModule\getContent(), Skin\getCopyright(), ApiComparePages\getDiffRevision(), SpecialUncategorizedCategories\getExceptionList(), ApiFeedRecentChanges\getFeedObject(), SpecialPageLanguage\getFormFields(), UserGroupMembership\getGroupPage(), SpecialStatistics\getGroupStats(), ApiPageSet\getInterwikiTitlesAsResult(), SkinTemplate\getLanguages(), IRCColourfulRCFeedFormatter\getLine(), SpecialExport\getLinks(), BlockLogFormatter\getMessageParameters(), MergeLogFormatter\getMessageParameters(), MoveLogFormatter\getMessageParameters(), ProtectLogFormatter\getMessageParameters(), SearchNearMatcher\getNearMatchInternal(), WantedFilesPage\getPageHeader(), UsersPager\getPageHeader(), getParentCategoryTree(), EditPage\getPreloadedContent(), ProtectLogFormatter\getPreloadTitles(), MergeLogFormatter\getPreloadTitles(), MoveLogFormatter\getPreloadTitles(), NewFilesPager\getQueryInfo(), ApiRollback\getRbTitle(), CssContent\getRedirectTarget(), JavaScriptContent\getRedirectTarget(), WikitextContent\getRedirectTargetAndText(), SpecialChangeCredentials\getReturnUrl(), SpecialRecentChangesLinked\getTargetTitle(), ParserOutput\getText(), CLIParser\getTitle(), ApiBase\getTitleFromTitleOrPageId(), ResourceLoaderWikiModule\getTitleInfo(), ApiBase\getTitleOrPageId(), SpecialSearch\goResult(), ApiComparePages\guessTitle(), ApiPageSet\initFromRevIDs(), User\isValidUserName(), LogPager\limitTitle(), PageArchive\listPagesByPrefix(), PageArchive\listPagesBySearch(), LoginSignupSpecialPage\load(), SpecialUndelete\loadRequest(), SpecialMergeHistory\loadRequestParams(), ChangeTags\logTagManagementAction(), MediaWiki\main(), SkinTemplate\makeArticleUrlDetails(), PopulateArchiveRevId\makeDummyRevisionRow(), Skin\makeI18nUrl(), Skin\makeKnownUrlDetails(), SkinTemplate\makeTalkUrlDetails(), PPFuzzTester\makeTitle(), Skin\makeUrl(), Skin\makeUrlDetails(), TitleCleanup\moveIllegalPage(), ResourceLoaderContext\msg(), CoreParserFunctions\mwnamespace(), CoreParserFunctions\namespacee(), CoreParserFunctions\namespacenumber(), TitleFactory\newFromText(), ForeignAPIFile\newFromTitle(), newMainPage(), MediaWikiSite\normalizePageName(), SpecialRandomInCategory\onSubmit(), SpecialChangeContentModel\onSubmit(), SpecialChangeEmail\onSuccess(), WikiExporter\pageByName(), CoreParserFunctions\pageid(), CoreParserFunctions\pagename(), CoreParserFunctions\pagenamee(), CoreParserFunctions\pagesize(), BenchmarkTitleValue\parseTitle(), SpecialPage\prefixSearchString(), SpecialFileDuplicateSearch\prefixSearchSubpages(), ResourceLoaderWikiModule\preloadTitleInfo(), SearchEngine\processCompletionResults(), SpecialBlock\processForm(), WikiImporter\processLogItem(), TitleCleanup\processRow(), CleanupWatchlist\processRow(), CleanupCaps\processRowToUppercase(), CoreParserFunctions\protectionexpiry(), CoreParserFunctions\protectionlevel(), PurgePage\purge(), LocalFile\recordUpload2(), SearchExactMatchRescorer\redirectTargetsToRedirect(), SearchExactMatchRescorer\rescore(), CoreParserFunctions\revisionday(), CoreParserFunctions\revisionday2(), CoreParserFunctions\revisionid(), CoreParserFunctions\revisionmonth(), CoreParserFunctions\revisionmonth1(), CoreParserFunctions\revisiontimestamp(), CoreParserFunctions\revisionuser(), CoreParserFunctions\revisionyear(), SpecialComparePages\revOrTitle(), CoreParserFunctions\rootpagename(), CoreParserFunctions\rootpagenamee(), ApiQueryDeletedRevisions\run(), ApiQueryImages\run(), ApiQueryCategories\run(), ApiQueryLinks\run(), MediaWiki\Rest\Handler\LanguageLinksHandler\run(), MediaWiki\Rest\Handler\PageHistoryHandler\run(), MediaWiki\Rest\Handler\PageHistoryCountHandler\run(), ApiQueryRecentChanges\run(), SpecialEditWatchlist\runWatchUnwatchCompleteHook(), SpecialChangeContentModel\setParameter(), WikiImporter\setTargetRootPage(), ResourceLoaderWikiModule\shouldEmbedModule(), EditPage\showCustomIntro(), SpecialSearch\showResults(), LoginHelper\showReturnToPage(), SpecialEditWatchlist\showTitles(), CoreParserFunctions\subjectpagename(), CoreParserFunctions\subjectpagenamee(), CoreParserFunctions\subjectspace(), CoreParserFunctions\subjectspacee(), WebInstallerName\submit(), CoreParserFunctions\subpagename(), CoreParserFunctions\subpagenamee(), Skin\subPageSubtitle(), 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 352 of file Title.php.

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

Referenced by SpecialRedirect\dispatchFile(), PageDataRequestHandler\handleRequest(), newFromText(), TitleFactory\newFromTextThrow(), SpecialNewSection\onFormSubmit(), SpecialRedirectWithAction\onFormSubmit(), SpecialPageLanguage\onSubmit(), MediaWiki\parseTitle(), ApiPageSet\processTitlesArray(), 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
Parameters
TitleValue$titleValueAssumed to be safe.
string$forceCloneset to NEW_CLONE to ensure a fresh instance is returned.
Returns
Title

Definition at line 254 of file Title.php.

References newFromLinkTarget().

Referenced by SpecialPage\getTitleFor(), and SpecialEditWatchlist\runWatchUnwatchCompleteHook().

◆ newFromURL()

static Title::newFromURL (   $url)
static

THIS IS NOT THE FUNCTION YOU WANT.

Use Title::newFromText().

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

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

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

Parameters
string$urlThe title, as might be taken from a URL
Returns
Title|null The new object, or null on an error

Definition at line 402 of file Title.php.

References $t.

Referenced by TitleFactory\newFromURL(), 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 ResourceloaderContext) to prevent an error.

Note
The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.
Parameters
MessageLocalizer | null$localizerAn optional context to use (since 1.34)
Returns
Title

Definition at line 646 of file Title.php.

References $title, newFromText(), and wfMessage().

Referenced by EmaillingJob\__construct(), Skin\addToSidebarPlain(), Installer\createMainpage(), ApiRsd\execute(), FileDeleteForm\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), SpecialChangeCredentials\getAuthForm(), OOUIHTMLForm\getButtons(), VFormHTMLForm\getButtons(), HTMLForm\getButtons(), SpecialMyLanguage\getRedirect(), XmlDumpWriter\homelink(), Skin\logoText(), Skin\mainPageLink(), PopulateArchiveRevId\makeDummyRevisionRow(), Skin\makeMainPageUrl(), TitleFactory\newMainPage(), SpecialChangeEmail\onSuccess(), MediaWiki\parseTitle(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), LoginHelper\showReturnToPage(), and MediaWikiTitleCodec\splitTitleString().

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

References $mArticleID, $mDbkeyform, and $mNamespace.

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

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

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

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

◆ purgeExpiredRestrictions()

static Title::purgeExpiredRestrictions ( )
static

Purge expired restrictions from the page_restrictions table.

This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows

Definition at line 3009 of file Title.php.

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

Referenced by WikiPage\doUpdateRestrictions().

◆ purgeSquid()

Title::purgeSquid ( )

Purge all applicable CDN URLs.

Definition at line 3574 of file Title.php.

References DeferredUpdates\addUpdate(), getCdnUrls(), and DeferredUpdates\PRESEND.

Referenced by File\purgeDescription().

◆ quickUserCan()

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

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

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

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

Parameters
string$actionAction that permission needs to be checked for
User | null$userUser to check (since 1.19); $wgUser will be used if not provided.
Returns
bool
Exceptions
Exception
Deprecated:
since 1.33, use MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan(..) instead

Definition at line 2370 of file Title.php.

References userCan().

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

Note
This overrides Title::setContentModel()
Parameters
int | bool$idPage ID, 0 for non-existant, or false for "unknown" (lazy-load)

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

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

◆ setContentModel()

Title::setContentModel (   $model)

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

This does not actually change the content model of a title 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

Since
1.28
Parameters
string$modelCONTENT_MODEL_XXX constant

Definition at line 1097 of file Title.php.

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

◆ setFragment()

Title::setFragment (   $fragment)

Set the fragment for this title.

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

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

Access:\n private
Parameters
string$fragmentText

Definition at line 1788 of file Title.php.

Referenced by secureAndSplit().

◆ touchLinks()

Title::touchLinks ( )

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

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

Definition at line 4341 of file Title.php.

References HTMLCacheUpdateJob\newForBacklinks(), NS_CATEGORY, and JobQueueGroup\singleton().

◆ userCan()

Title::userCan (   $action,
  $user = null,
  $rigor = PermissionManager::RIGOR_SECURE 
)

Can $user perform $action on this page?

Parameters
string$actionAction that permission needs to be checked for
User | null$userUser to check (since 1.19); $wgUser will be used if not provided.
string$rigorSame format as Title::getUserPermissionsErrors()
Returns
bool
Exceptions
Exception
Deprecated:
since 1.33, use MediaWikiServices::getInstance()->getPermissionManager()->userCan(..) instead

Definition at line 2389 of file Title.php.

Referenced by quickUserCan().

◆ warnIfPageCannotExist()

Title::warnIfPageCannotExist ( Title  $title,
  $method 
)
private
Parameters
Title$title
string$method
Returns
bool whether a warning was issued

Definition at line 1675 of file Title.php.

References getFullText(), getInterwiki(), getText(), and wfLogWarning().

Referenced by getSubjectPage(), and getTalkPage().

◆ wasLocalInterwiki()

Title::wasLocalInterwiki ( )

Was this a local interwiki link?

Returns
bool

Definition at line 933 of file Title.php.

References $mLocalInterwiki.

Member Data Documentation

◆ $mArticleID

int Title::$mArticleID = -1

Article ID, fetched from the link cache on demand.

Definition at line 92 of file Title.php.

Referenced by getArticleID(), and pageCond().

◆ $mCascadeRestriction

bool Title::$mCascadeRestriction

Cascade restrictions on this page to included templates and images?

Definition at line 124 of file Title.php.

Referenced by areRestrictionsCascading().

◆ $mCascadeSources

array Title::$mCascadeSources

Where are the cascading restrictions coming from on this page?

Definition at line 136 of file Title.php.

Referenced by getCascadeProtectionSources().

◆ $mCascadingRestrictions

Title::$mCascadingRestrictions

Caching the results of getCascadeProtectionSources.

Definition at line 127 of file Title.php.

Referenced by getCascadeProtectionSources().

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

Referenced by getContentModel().

◆ $mDbkeyform

string Title::$mDbkeyform = ''

Main part with underscores.

Definition at line 81 of file Title.php.

Referenced by getCascadeProtectionSources(), getDBkey(), getRedirectsHere(), and pageCond().

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

Referenced by getDbPageLanguageCode().

◆ $mDefaultNamespace

int Title::$mDefaultNamespace = NS_MAIN

Namespace index when there is no namespace.

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

See also
newFromText()

Definition at line 160 of file Title.php.

Referenced by getDefaultNamespace(), and secureAndSplit().

◆ $mEstimateRevisions

int Title::$mEstimateRevisions
private

Estimated number of revisions; null of not loaded.

Definition at line 110 of file Title.php.

Referenced by estimateRevisionCount().

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

◆ $mFragment

string Title::$mFragment = ''

Title fragment (i.e.

the bit after the #)

Definition at line 89 of file Title.php.

Referenced by getFragment(), and getFullText().

◆ $mHasCascadingRestrictions

bool Title::$mHasCascadingRestrictions
protected

Are cascading restrictions in effect on this page?

Definition at line 133 of file Title.php.

Referenced by getCascadeProtectionSources().

◆ $mHasSubpages

bool Title::$mHasSubpages
private

Whether a page has any subpages.

Definition at line 172 of file Title.php.

Referenced by hasSubpages().

◆ $mInterwiki

string Title::$mInterwiki = ''

Interwiki prefix.

Definition at line 85 of file Title.php.

Referenced by getInterwiki(), and getRedirectsHere().

◆ $mIsBigDeletion

bool null Title::$mIsBigDeletion = null
private

Would deleting this page be a big deletion?

Definition at line 186 of file Title.php.

Referenced by isBigDeletion().

◆ $mIsValid

bool null Title::$mIsValid = null
private

Is the title known to be valid?

Definition at line 189 of file Title.php.

Referenced by isValid().

◆ $mLatestID

bool int Title::$mLatestID = false
protected

ID of most recent revision.

Definition at line 95 of file Title.php.

Referenced by getLatestRevID().

◆ $mLength

int Title::$mLength = -1
protected

The page length, 0 for special pages.

Definition at line 163 of file Title.php.

Referenced by getLength().

◆ $mLocalInterwiki

bool Title::$mLocalInterwiki = false
private

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

Definition at line 87 of file Title.php.

Referenced by wasLocalInterwiki().

◆ $mNamespace

int Title::$mNamespace = NS_MAIN

Namespace index, i.e.

one of the NS_xxxx constants

Definition at line 83 of file Title.php.

Referenced by getCascadeProtectionSources(), getEditNotices(), getNamespace(), getRedirectsHere(), getSubpages(), and pageCond().

◆ $mNotificationTimestamp

array Title::$mNotificationTimestamp = []
private

Associative array of user ID -> timestamp/false.

Definition at line 169 of file Title.php.

◆ $mOldRestrictions

string bool Title::$mOldRestrictions = false
protected

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

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

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

◆ $mRedirect

null Title::$mRedirect = null

Is the article at this title a redirect?

Definition at line 166 of file Title.php.

Referenced by isRedirect().

◆ $mRestrictions

array Title::$mRestrictions = []

Array of groups allowed to edit this article.

Definition at line 113 of file Title.php.

Referenced by getAllRestrictions().

◆ $mRestrictionsExpiry

array Title::$mRestrictionsExpiry = []
protected

When do the restrictions on this page expire?

Definition at line 130 of file Title.php.

◆ $mRestrictionsLoaded

bool Title::$mRestrictionsLoaded = false

Boolean for initialisation on demand.

Definition at line 139 of file Title.php.

Referenced by areRestrictionsLoaded().

◆ $mTextform

string Title::$mTextform = ''

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

Definition at line 77 of file Title.php.

Referenced by getSubpageText(), and getText().

◆ $mTitleProtection

mixed Title::$mTitleProtection

Cached value for getTitleProtection (create protection)

Definition at line 152 of file Title.php.

Referenced by getTitleProtectionInternal().

◆ $mTitleValue

TitleValue null Title::$mTitleValue = null
private

A corresponding TitleValue object.

Definition at line 183 of file Title.php.

Referenced by getTitleValue().

◆ $mUrlform

string Title::$mUrlform = ''

URL-encoded form of the main part.

Definition at line 79 of file Title.php.

Referenced by getPartialURL().

◆ $prefixedText

string null Title::$prefixedText = null

Text form including namespace/interwiki, initialised on demand.

Only public to share cache with TitleFormatter

Access:\n private

Definition at line 149 of file Title.php.

Referenced by getPrefixedText().

◆ $titleCache

MapCacheLRU null Title::$titleCache = null
staticprivate

Definition at line 44 of file Title.php.

Referenced by clearCaches(), getTitleCache(), and newFromTextThrow().

◆ CACHE_MAX

const Title::CACHE_MAX = 1000

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

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

Definition at line 51 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 master DB and inject it into link cache.

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

Definition at line 58 of file Title.php.

Referenced by getFirstRevision(), loadFieldFromDB(), and newFromID().

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

Since
1.33

Definition at line 67 of file Title.php.


The documentation for this class was generated from the following file:
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:317