Represents a title within MediaWiki. More...
Public Member Functions | |
| __clone () | |
| __sleep () | |
| __toString () | |
| Return a string representation of this title. | |
| __wakeup () | |
| areCascadeProtectionSourcesLoaded () | |
| Determines whether cascading protection sources have already been loaded from the database. | |
| areRestrictionsCascading () | |
| Returns cascading restrictions for the current article. | |
| areRestrictionsLoaded () | |
| Accessor for mRestrictionsLoaded. | |
| canExist () | |
| Can this title represent a page in the wiki's database? | |
| canHaveTalkPage () | |
| Can this title have a corresponding talk page? | |
| canUseNoindex () | |
| Whether the magic words INDEX and NOINDEX function for this page. | |
| createFragmentTarget (string $fragment) | |
| Creates a new Title for a different fragment of the same page. | |
| deleteTitleProtection () | |
| Remove any title protection due to page existing. | |
| equals (object $other) | |
| Compares with another Title. | |
| estimateRevisionCount () | |
| Get the approximate revision count of this page. | |
| exists ( $flags=0) | |
| Check if page exists. | |
| fixSpecialName () | |
| If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary. | |
| flushRestrictions () | |
| Flush the protection cache in this object and force reload from the database. | |
| getAllRestrictions () | |
| Accessor/initialisation for mRestrictions. | |
| getArticleID ( $flags=0) | |
| Get the article ID for this Title from the link cache, adding it if necessary. | |
| getBacklinkCache () | |
| Get a backlink cache object. | |
| getBaseText () | |
| Get the base page name without a namespace, i.e. | |
| getBaseTitle () | |
| Get the base page name title, i.e. | |
| getBrokenLinksFrom () | |
| Get an array of Title objects referring to non-existent articles linked from this page. | |
| getCanonicalURL ( $query='', $query2=false) | |
| Get the URL for a canonical link, for use in things like IRC and e-mail notifications. | |
| getCascadeProtectionSources ( $getPages=true) | |
| Cascading protection: Get the source of any cascading restrictions on this page. | |
| getCategorySortkey ( $prefix='') | |
| Returns the raw sort key to be used for categories, with the specified prefix. | |
| getCdnUrls () | |
| Get a list of URLs to purge from the CDN cache when this page changes. | |
| getContentModel ( $flags=0) | |
| Get the page's content model id, see the CONTENT_MODEL_XXX constants. | |
| getDBkey () | |
| Get the main part with underscores. | |
| getDefaultMessageText () | |
| Get the default (plain) message contents for an page that overrides an interface message key. | |
| getDeletedEditsCount () | |
| Is there a version of this page in the deletion archive? | |
| getEditNotices ( $oldid=0) | |
| Get a list of rendered edit notices for this page. | |
| getEditURL () | |
| Get the edit URL for this Title. | |
| getFragment () | |
| Get the Title fragment (i.e. | |
| getFragmentForURL () | |
| Get the fragment in URL form, including the "#" character if there is one. | |
| getFullText () | |
| Get the prefixed title with spaces, plus any fragment (part beginning with '#') | |
| getFullURL ( $query='', $query2=false, $proto=PROTO_RELATIVE) | |
| Get a real URL referring to this title, with interwiki link and fragment. | |
| getFullUrlForRedirect ( $query='', $proto=PROTO_CURRENT) | |
| Get a url appropriate for making redirects based on an untrusted url arg. | |
| getId ( $wikiId=self::LOCAL) | |
| Returns the page ID. | |
| getInternalURL ( $query='', $query2=false) | |
| Get the URL form for an internal link. | |
| getInterwiki () | |
| Get the interwiki prefix. | |
| getLatestRevID ( $flags=0) | |
| What is the page_latest field for this page? | |
| getLength ( $flags=0) | |
| What is the length of this page? Uses link cache, adding it if necessary. | |
| getLinksFrom ( $options=[], $table='pagelinks', $prefix='pl') | |
| Get an array of Title objects linked from this Title Also stores the IDs in the link cache. | |
| getLinksTo ( $options=[], $table='pagelinks', $prefix='pl') | |
| Get an array of Title objects linking to this Title Also stores the IDs in the link cache. | |
| getLinkURL ( $query='', $query2=false, $proto=false) | |
| Get a URL that's the simplest URL that will be valid to link, locally, to the current Title. | |
| getLocalURL ( $query='', $query2=false) | |
| Get a URL with no fragment or server name (relative URL) from a Title object. | |
| getNamespace () | |
| Get the namespace index, i.e. | |
| getNamespaceKey ( $prepend='nstab-') | |
| Generate strings used for xml 'id' names in monobook tabs. | |
| getNotificationTimestamp (User $user) | |
| Get the timestamp when this page was updated since the user last saw it. | |
| getNsText () | |
| Get the namespace text. | |
| getOtherPage () | |
| Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page. | |
| getPageLanguage () | |
| Get the language in which the content of this page is written in wikitext. | |
| getPageViewLanguage () | |
| Get the language in which the content of this page is written when viewed by user. | |
| getParentCategories () | |
| Get categories to which this Title belongs and return an array of categories' names. | |
| getParentCategoryTree ( $children=[]) | |
| Get a tree of parent categories. | |
| getPartialURL () | |
| Get the URL-encoded form of the main part. | |
| getPrefixedDBkey () | |
| Get the prefixed database key form. | |
| getPrefixedText () | |
| Get the prefixed title with spaces. | |
| getPrefixedURL () | |
| Get a URL-encoded title (not an actual URL) including interwiki. | |
| getRedirectsHere ( $ns=null) | |
| Get all extant redirects to this Title. | |
| getRestrictionExpiry ( $action) | |
| Get the expiry time for the restriction against a given action. | |
| getRestrictions ( $action) | |
| Accessor/initialisation for mRestrictions. | |
| getRestrictionTypes () | |
| Returns restriction types for the current Title. | |
| getRootText () | |
| Get the root page name text without a namespace, i.e. | |
| getRootTitle () | |
| Get the root page name title, i.e. | |
| getSkinFromConfigSubpage () | |
| Trim down a .css, .json, or .js subpage title to get the corresponding skin name. | |
| getSubjectNsText () | |
| Get the namespace text of the subject (rather than talk) page. | |
| getSubjectPage () | |
| Get a title object associated with the subject page of this talk page. | |
| getSubpage ( $text) | |
| Get the title for a subpage of the current page. | |
| getSubpages ( $limit=-1) | |
| Get all subpages of this page. | |
| getSubpageText () | |
| Get the lowest-level subpage name, i.e. | |
| getSubpageUrlForm () | |
| Get a URL-encoded form of the subpage text. | |
| getTalkNsText () | |
| Get the namespace text of the talk page. | |
| getTalkPage () | |
| Get a Title object associated with the talk page of this article. | |
| getTalkPageIfDefined () | |
| Get a Title object associated with the talk page of this article, if such a talk page can exist. | |
| getTemplateLinksFrom ( $options=[]) | |
| Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache. | |
| getTemplateLinksTo ( $options=[]) | |
| Get an array of Title objects using this Title as a template Also stores the IDs in the link cache. | |
| getText () | |
| Get the text form (spaces not underscores) of the main part. | |
| getTitleProtection () | |
| Is this title subject to title protection? Title protection is the one applied against creation of such title. | |
| getTitleValue () | |
| Get a TitleValue object representing this Title. | |
| getTouched ( $flags=self::READ_NORMAL) | |
| Get the last touched timestamp. | |
| getTransWikiID () | |
| Returns the DB name of the distant wiki which owns the object. | |
| getWikiId () | |
| Returns false to indicate that this Title belongs to the local wiki. | |
| hasContentModel ( $id) | |
| Convenience method for checking a title's content model name. | |
| hasDeletedEdits () | |
| Is there a version of this page in the deletion archive? | |
| hasFragment () | |
| Check if a Title fragment is set. | |
| hasSourceText () | |
| Does this page have source text? | |
| hasSubjectNamespace ( $ns) | |
| Returns true if the title has the same subject namespace as the namespace specified. | |
| hasSubpages () | |
| Does this have subpages? (Warning, usually requires an extra DB query.) | |
| inNamespace (int $ns) | |
| Returns true if the title is inside the specified namespace. | |
| inNamespaces (... $namespaces) | |
| Returns true if the title is inside one of the specified namespaces. | |
| invalidateCache ( $purgeTime=null) | |
| Updates page_touched for this page; called from LinksUpdate.php. | |
| isAlwaysKnown () | |
| Should links to this title be shown as potentially viewable (i.e. | |
| isBigDeletion () | |
| Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit. | |
| isCascadeProtected () | |
| Cascading protection: Return true if cascading restrictions apply to this page, false if not. | |
| isContentPage () | |
| Is this Title in a namespace which contains content? In other words, is this a content page, for the purposes of calculating statistics, etc? | |
| isConversionTable () | |
| Is this a conversion table for the LanguageConverter? | |
| isDeleted () | |
| Is there a version of this page in the deletion archive? | |
| isDeletedQuick () | |
| Is there a version of this page in the deletion archive? | |
| isExternal () | |
| Is this Title interwiki? | |
| isKnown () | |
| Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages). | |
| isLocal () | |
| Determine whether the object refers to a page within this project (either this wiki or a wiki with a local interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local ) | |
| isMainPage () | |
| Is this the mainpage? | |
| isMovable () | |
| Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable. | |
| isNewPage ( $flags=self::READ_NORMAL) | |
| Check if this is a new page. | |
| isProtected ( $action='') | |
| Does the title correspond to a protected article? | |
| isRawHtmlMessage () | |
| Is this a message which can contain raw HTML? | |
| isRedirect ( $flags=0) | |
| Is this an article that is a redirect page? Uses link cache, adding it if necessary. | |
| isSameLinkAs (LinkTarget $other) | |
| isSamePageAs (PageReference $other) | |
| isSemiProtected ( $action='edit') | |
| Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels? | |
| isSingleRevRedirect () | |
| Locks the page row and check if this page is single revision redirect. | |
| isSiteConfigPage () | |
| Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI. | |
| isSiteCssConfigPage () | |
| Is this a sitewide CSS "config" page? | |
| isSiteJsConfigPage () | |
| Is this a sitewide JS "config" page? | |
| isSiteJsonConfigPage () | |
| Is this a sitewide JSON "config" page? | |
| isSpecial ( $name) | |
| Returns true if this title resolves to the named special page. | |
| isSpecialPage () | |
| Returns true if this is a special page. | |
| isSubpage () | |
| Is this a subpage? | |
| isSubpageOf (Title $title) | |
| Check if this title is a subpage of another title. | |
| isTalkPage () | |
| Is this a talk page of some sort? | |
| isTrans () | |
| Determine whether the object refers to a page within this project and is transcludable. | |
| isUserConfigPage () | |
| Is this a "config" (.css, .json, or .js) sub-page of a user page? | |
| isUserCssConfigPage () | |
| Is this a CSS "config" sub-page of a user page? | |
| isUserJsConfigPage () | |
| Is this a JS "config" sub-page of a user page? | |
| isUserJsonConfigPage () | |
| Is this a JSON "config" sub-page of a user page? | |
| isValid () | |
| Returns true if the title is a valid link target, and that it has been properly normalized. | |
| isValidRedirectTarget () | |
| Check if this Title is a valid redirect target. | |
| isWikitextPage () | |
| Does that page contain wikitext, or it is JS, CSS or whatever? | |
| loadFromRow ( $row) | |
| Load Title object fields from a DB row. | |
| loadRestrictions ( $flags=0) | |
| Load restrictions from the page_restrictions table. | |
| loadRestrictionsFromRows ( $rows) | |
| Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page. | |
| pageCond () | |
| Get an associative array for selecting this title from the "page" table. | |
| purgeSquid () | |
| Purge all applicable CDN URLs. | |
| resetArticleID ( $id) | |
| Inject a page ID, reset DB-loaded fields, and clear the link cache for this title. | |
| setContentModel ( $model) | |
| Set a proposed content model for the page for permissions checking. | |
| setFragment ( $fragment) | |
| Set the fragment for this title. | |
| toPageIdentity () | |
| Returns the page represented by this Title as a ProperPageIdentity. | |
| toPageRecord ( $flags=0) | |
| Returns the page represented by this Title as a ProperPageRecord. | |
| touchLinks () | |
| Update page_touched timestamps and send CDN purge messages for pages linking to this title. | |
| wasLocalInterwiki () | |
| Was this a local interwiki link? | |
 Public Member Functions inherited from MediaWiki\Page\PageIdentity | |
| exists () | |
| Checks if the page currently exists. | |
| Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity | |
| assertWiki ( $wikiId) | |
| Throws if $wikiId is different from the return value of getWikiId(). | |
Static Public Member Functions | |
| static | capitalize ( $text, $ns=NS_MAIN) |
| Capitalize a text string for a title if it belongs to a namespace that capitalizes. | |
| static | castFromLinkTarget ( $linkTarget) |
| Same as newFromLinkTarget, but if passed null, returns null. | |
| static | castFromPageIdentity (?PageIdentity $pageIdentity) |
| Return a Title for a given PageIdentity. | |
| static | castFromPageReference (?PageReference $pageReference) |
| Return a Title for a given Reference. | |
| static | clearCaches () |
| static | compare ( $a, $b) |
| Callback for usort() to do title sorts by (namespace, title) | |
| static | convertByteClassToUnicodeClass ( $byteClass) |
| Utility method for converting a character sequence from bytes to Unicode. | |
| static | getFilteredRestrictionTypes ( $exists=true) |
| Get a filtered list of all restriction types supported by this wiki. | |
| static | legalChars () |
| Get a regex character class describing the legal characters in a link. | |
| static | makeName ( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false) |
| Make a prefixed DB key from a DB key and a namespace index. | |
| static | makeTitle ( $ns, $title, $fragment='', $interwiki='') |
| Create a new Title from a namespace index and a DB key. | |
| static | makeTitleSafe ( $ns, $title, $fragment='', $interwiki='') |
| Create a new Title from a namespace index and a DB key. | |
| static | newFromDBkey ( $key) |
| Create a new Title from a prefixed DB key. | |
| static | newFromID ( $id, $flags=0) |
| Create a new Title from an article ID. | |
| static | newFromIDs ( $ids) |
| Make an array of titles from an array of IDs. | |
| static | newFromLinkTarget (LinkTarget $linkTarget, $forceClone='') |
| Returns a Title given a LinkTarget. | |
| static | newFromRow ( $row) |
| Make a Title object from a DB row. | |
| static | newFromText ( $text, $defaultNamespace=NS_MAIN) |
| Create a new Title from text, such as what one would find in a link. | |
| static | newFromTextThrow ( $text, $defaultNamespace=NS_MAIN) |
| Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null. | |
| static | newFromTitleValue (TitleValue $titleValue, $forceClone='') |
| Returns a Title given a TitleValue. | |
| static | newFromURL ( $url) |
| THIS IS NOT THE FUNCTION YOU WANT. | |
| static | newMainPage (MessageLocalizer $localizer=null) |
| Create a new Title for the Main Page. | |
| static | purgeExpiredRestrictions () |
| Purge expired restrictions from the page_restrictions table. | |
Public Attributes | |
| const | GAID_FOR_UPDATE = 512 |
| Used to be GAID_FOR_UPDATE define(). | |
| const | NEW_CLONE = 'clone' |
| Flag for use with factory methods like newFromLinkTarget() that have a $forceClone parameter. | |
| Public Attributes inherited from IDBAccessObject | |
| const | READ_NONE = -1 |
| Constants for object loading bitfield flags (higher => higher QoS) | |
Static Protected Member Functions | |
| static | getSelectFields () |
| Returns a list of fields that are to be selected for initializing Title objects. | |
Private member variables | |
Please use the accessor functions instead.
| |
| int | $mArticleID = -1 |
| Article ID, fetched from the link cache on demand. | |
| string null | $prefixedText = null |
| Text form including namespace/interwiki, initialised on demand. | |
| null bool | $mRedirect = null |
| Is the article at this title a redirect? | |
| bool int | $mLatestID = false |
| ID of most recent revision. | |
| int | $mLength = -1 |
| The page length, 0 for special pages. | |
Detailed Description
Represents a title within MediaWiki.
Optionally may contain an interwiki designation or namespace.
- Note
- This class can fetch various kinds of data from the database; however, it does so inefficiently.
- Consider using a TitleValue object instead. TitleValue is more lightweight and does not rely on global state or the database.
Member Function Documentation
◆ __clone()
◆ __sleep()
◆ __toString()
| Title::__toString | ( | ) |
Return a string representation of this title.
- Returns
- string Representation of this title
Implements MediaWiki\Linker\LinkTarget.
◆ __wakeup()
| Title::__wakeup | ( | ) |
Definition at line 4129 of file Title.php.
References wfUrlencode().
◆ areCascadeProtectionSourcesLoaded()
| Title::areCascadeProtectionSourcesLoaded | ( | ) |
Determines whether cascading protection sources have already been loaded from the database.
- Deprecated
- since 1.37, use RestrictionStore::areCascadeProtectionSourcesLoaded instead
- Returns
- bool
- Since
- 1.23
◆ areRestrictionsCascading()
| Title::areRestrictionsCascading | ( | ) |
Returns cascading restrictions for the current article.
- Deprecated
- since 1.37, use RestrictionStore::areRestrictionsCascading instead
- Returns
- bool
◆ areRestrictionsLoaded()
| Title::areRestrictionsLoaded | ( | ) |
Accessor for mRestrictionsLoaded.
- Deprecated
- since 1.37, use RestrictionStore::areRestrictionsLoaded instead
- Returns
- bool Whether or not the page's restrictions have already been loaded from the database
- Since
- 1.23
◆ canExist()
| Title::canExist | ( | ) |
Can this title represent a page in the wiki's database?
Titles can exist as pages in the database if they are valid, and they are not Special pages, interwiki links, or fragment-only links.
- See also
- isValid()
- Returns
- bool true if and only if this title can be used to perform an edit.
Implements MediaWiki\Page\PageIdentity.
Definition at line 1232 of file Title.php.
Referenced by RequestContext\canUseWikiPage().
◆ 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.
◆ canUseNoindex()
| Title::canUseNoindex | ( | ) |
Whether the magic words INDEX and NOINDEX function for this page.
- Returns
- bool
Definition at line 3853 of file Title.php.
References $wgExemptFromUserRobotsControl.
◆ capitalize()
|
static |
◆ castFromLinkTarget()
|
static |
◆ castFromPageIdentity()
|
static |
◆ castFromPageReference()
|
static |
◆ clearCaches()
◆ compare()
|
static |
◆ convertByteClassToUnicodeClass()
|
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
◆ createFragmentTarget()
| Title::createFragmentTarget | ( | string | $fragment | ) |
Creates a new Title for a different fragment of the same page.
- Since
- 1.27
- Parameters
-
string $fragment
- Returns
- Title
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1823 of file Title.php.
Referenced by SpecialWhatLinksHere\listItem().
◆ deleteTitleProtection()
| Title::deleteTitleProtection | ( | ) |
Remove any title protection due to page existing.
- Deprecated
- since 1.37, do not use (this is only for WikiPage::onArticleCreate)
◆ equals()
| Title::equals | ( | object | $other | ) |
Compares with another Title.
A Title object is considered equal to another Title if it has the same text, the same interwiki prefix, and the same namespace.
- Note
- This is different from isSameLinkAs(), which also compares the fragment part, and from isSamePageAs(), which takes into account the page ID.
@phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
- Parameters
-
object $other
- Returns
- bool true if $other is a Title and refers to the same page.
Definition at line 3404 of file Title.php.
Referenced by MediaWiki\Block\Restriction\PageRestriction\matches(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().
◆ estimateRevisionCount()
| Title::estimateRevisionCount | ( | ) |
Get the approximate revision count of this page.
- Returns
- int
Definition at line 3376 of file Title.php.
References $dbr, DB_REPLICA, and wfGetDB().
◆ exists()
| Title::exists | ( | $flags = 0 | ) |
Check if page exists.
For historical reasons, this function simply checks for the existence of the title in the page table, and will thus return false for interwiki links, special pages and the like. If you want to know if a title can be meaningfully viewed, you should probably call the isKnown() method instead.
- Parameters
-
int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
- Returns
- bool
Definition at line 3477 of file Title.php.
Referenced by RedirectSpecialArticle\getRedirectQuery(), and SpecialUpload\getUploadForm().
◆ fixSpecialName()
| Title::fixSpecialName | ( | ) |
If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary.
Otherwise, return $this
- Returns
- Title
Definition at line 1301 of file Title.php.
References NS_SPECIAL.
◆ flushRestrictions()
| Title::flushRestrictions | ( | ) |
Flush the protection cache in this object and force reload from the database.
This is used when updating protection from WikiPage::doUpdateRestrictions().
- Deprecated
- since 1.37, now internal
◆ getAllRestrictions()
| Title::getAllRestrictions | ( | ) |
Accessor/initialisation for mRestrictions.
- Deprecated
- since 1.37, use RestrictionStore::getAllRestrictions instead
- Returns
- array Keys are actions, values are arrays as returned by Title::getRestrictions()
- Since
- 1.23
◆ getArticleID()
| Title::getArticleID | ( | $flags = 0 | ) |
Get the article ID for this Title from the link cache, adding it if necessary.
- Parameters
-
int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
- Returns
- int The ID
Definition at line 2824 of file Title.php.
Referenced by MediaWiki\Block\Restriction\PageRestriction\newFromTitle().
◆ getBacklinkCache()
| Title::getBacklinkCache | ( | ) |
Get a backlink cache object.
- Deprecated
- since 1.37, use BacklinkCacheFactory::getBacklinkCache()
- Returns
- BacklinkCache
◆ getBaseText()
| Title::getBaseText | ( | ) |
Get the base page name without a namespace, i.e.
the part before the subpage name
- Note
- the return value may contain trailing whitespace and is thus not safe for use with makeTitle or TitleValue.
- Example:
- Title::newFromText('User:Foo/Bar/Baz')->getBaseText();# returns: 'Foo/Bar'static newFromText( $text, $defaultNamespace=NS_MAIN)Create a new Title from text, such as what one would find in a link.Definition Title.php:370
- Returns
- string Base name
◆ getBaseTitle()
| Title::getBaseTitle | ( | ) |
Get the base page name title, i.e.
the part before the subpage name.
- Example:
- Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();# returns: Title{User:Foo/Bar}
- Returns
- Title
- Since
- 1.20
Definition at line 2051 of file Title.php.
References $title.
◆ getBrokenLinksFrom()
| Title::getBrokenLinksFrom | ( | ) |
Get an array of Title objects referring to non-existent articles linked from this page.
- Todo
- check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case).
- Returns
- Title[]
Definition at line 3161 of file Title.php.
References $dbr, $res, DB_REPLICA, and wfGetDB().
◆ getCanonicalURL()
| Title::getCanonicalURL | ( | $query = '', | |
| $query2 = false ) |
Get the URL for a canonical link, for use in things like IRC and e-mail notifications.
Uses $wgCanonicalServer and the GetCanonicalURL hook.
NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
- See also
- self::getLocalURL for the arguments.
- Parameters
-
string | array $query string | bool $query2 Deprecated
- Returns
- string The URL
- Since
- 1.18
Definition at line 2388 of file Title.php.
References PROTO_CANONICAL, and wfExpandUrl().
◆ getCascadeProtectionSources()
| Title::getCascadeProtectionSources | ( | $getPages = true | ) |
Cascading protection: Get the source of any cascading restrictions on this page.
- Deprecated
- since 1.37, use RestrictionStore::getCascadeProtectionSources instead
- Parameters
-
bool $getPages Whether or not to retrieve the actual pages that the restrictions have come from and the actual restrictions themselves.
- Returns
- array Two elements: First is an array of Title objects of the pages from which cascading restrictions have come if $getPages is true, or a bool indicating whether any cascading protection applies if $getPages was set to false. Second is an array like that returned by Title::getAllRestrictions(), or an empty array if $getPages is false.
◆ getCategorySortkey()
| Title::getCategorySortkey | ( | $prefix = '' | ) |
Returns the raw sort key to be used for categories, with the specified prefix.
This will be fed to Collation::getSortKey() to get a binary sortkey that can be used for actual sorting.
- Parameters
-
string $prefix The prefix to be used, specified using {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no prefix.
- Returns
- string
◆ getCdnUrls()
| Title::getCdnUrls | ( | ) |
Get a list of URLs to purge from the CDN cache when this page changes.
- Deprecated
- since 1.35 Use HtmlCacheUpdater
- Returns
- string[]
◆ getContentModel()
| Title::getContentModel | ( | $flags = 0 | ) |
Get the page's content model id, see the CONTENT_MODEL_XXX constants.
- Todo
- Deprecate this in favor of SlotRecord::getModel()
- Parameters
-
int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
- Returns
- string Content model id
Definition at line 1088 of file Title.php.
Referenced by MediaWiki\EditPage\TextConflictHelper\__construct(), and SpecialWhatLinksHere\wlhLink().
◆ getDBkey()
| Title::getDBkey | ( | ) |
Get the main part with underscores.
- Returns
- string Main part of the title, with underscores
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1057 of file Title.php.
Referenced by ArchivedFile\__construct(), DoubleRedirectJob\fixRedirects(), UploadBase\getTitle(), and ForeignAPIFile\newFromTitle().
◆ getDefaultMessageText()
| Title::getDefaultMessageText | ( | ) |
Get the default (plain) message contents for an page that overrides an interface message key.
Primary use cases:
- Article:
- Show default when viewing the page. The Article::getSubstituteContent method displays the default message content, instead of the 'noarticletext' placeholder message normally used.
- EditPage:
- Title of edit page. When creating an interface message override, the editor is told they are "Editing the page", instead of "Creating the page". (EditPage::setHeaders)
- Edit notice. The 'translateinterface' edit notice is shown when creating or editing an interface message override. (EditPage::showIntro)
- Opening the editor. The contents of the localisation message are used as contents of the editor when creating a new page in the MediaWiki namespace. This simplifies the process for editors when "changing" an interface message by creating an override. (EditPage::getContentObject)
- Showing a diff. The left-hand side of a diff when an editor is previewing their changes before saving the creation of a page in the MediaWiki namespace. (EditPage::showDiff)
- Disallowing a save. When attempting to create a MediaWiki-namespace page with the proposed content matching the interface message default, the save is rejected, the same way we disallow blank pages from being created. (EditPage::internalAttemptSave)
- ApiEditPage:
- Default content, when using the 'prepend' or 'append' feature.
- SkinTemplate:
- Label the create action as "Edit", if the page can be an override.
- Returns
- string|bool
Definition at line 3621 of file Title.php.
References $lang, NS_MEDIAWIKI, and wfMessage().
◆ getDeletedEditsCount()
| Title::getDeletedEditsCount | ( | ) |
◆ getEditNotices()
| Title::getEditNotices | ( | $oldid = 0 | ) |
Get a list of rendered edit notices for this page.
Array is keyed by the original message key, and values are rendered using parseAsBlock, so they will already be wrapped in paragraphs.
- Since
- 1.21
- Parameters
-
int $oldid Revision ID that's being edited
- Returns
- string[]
Definition at line 4009 of file Title.php.
References wfMessage().
◆ getEditURL()
| Title::getEditURL | ( | ) |
◆ getFilteredRestrictionTypes()
|
static |
Get a filtered list of all restriction types supported by this wiki.
- Deprecated
- since 1.37, use RestrictionStore::listAllRestrictionTypes instead
- Parameters
-
bool $exists True to get all restriction types that apply to titles that do exist, False for all restriction types that apply to titles that do not exist
- Returns
- array
◆ 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.
◆ getFragmentForURL()
| Title::getFragmentForURL | ( | ) |
◆ 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 1914 of file Title.php.
Referenced by WikitextContentHandler\makeRedirectContent(), and WikitextContent\updateRedirect().
◆ getFullURL()
| Title::getFullURL | ( | $query = '', | |
| $query2 = false, | |||
| $proto = PROTO_RELATIVE ) |
Get a real URL referring to this title, with interwiki link and fragment.
- See also
- self::getLocalURL for the arguments.
- wfExpandUrl
- Parameters
-
string | array $query string | string[] | bool $query2 string | int | null $proto Protocol type to use in URL
- Returns
- string The URL
Definition at line 2180 of file Title.php.
References wfExpandUrl().
Referenced by CssContentHandler\makeRedirectContent(), and JavaScriptContentHandler\makeRedirectContent().
◆ getFullUrlForRedirect()
| Title::getFullUrlForRedirect | ( | $query = '', | |
| $proto = PROTO_CURRENT ) |
Get a url appropriate for making redirects based on an untrusted url arg.
This is basically the same as getFullUrl(), but in the case of external interwikis, we send the user to a landing page, to prevent possible phishing attacks and the like.
- Note
- Uses current protocol by default, since technically relative urls aren't allowed in redirects per HTTP spec, so this is not suitable for places where the url gets cached, as might pollute between https and non-https users.
- See also
- self::getLocalURL for the arguments.
- Parameters
-
array | string $query string $proto Protocol type to use in URL
- Returns
- string A url suitable to use in an HTTP location header.
Definition at line 2213 of file Title.php.
References SpecialPage\getTitleFor().
◆ getId()
| Title::getId | ( | $wikiId = self::LOCAL | ) |
Returns the page ID.
If this ID is 0, this means the page does not exist.
- See also
- getArticleID()
- Since
- 1.36, since 1.35.6 as an alias of getArticleId()
- Parameters
-
string | false $wikiId The wiki ID expected by the caller.
- Exceptions
-
PreconditionException if this Title instance does not represent a proper page, that is, if it is a section link, interwiki link, link to a special page, or such. PreconditionException if $wikiId is not false.
- Returns
- int
Implements MediaWiki\Page\PageIdentity.
◆ getInternalURL()
| Title::getInternalURL | ( | $query = '', | |
| $query2 = false ) |
Get the URL form for an internal link.
- Used in various CDN-related code, in case we have a different internal hostname for the server from the exposed one.
This uses $wgInternalServer to qualify the path, or $wgServer if $wgInternalServer is not set. If the server variable used is protocol-relative, the URL will be expanded to http://
- See also
- self::getLocalURL for the arguments.
- Parameters
-
string | array $query string | bool $query2 Deprecated
- Returns
- string The URL
Definition at line 2366 of file Title.php.
References $wgInternalServer, $wgServer, PROTO_HTTP, and wfExpandUrl().
◆ getInterwiki()
| Title::getInterwiki | ( | ) |
Get the interwiki prefix.
Use Title::isExternal to check if a interwiki is set
- Returns
- string Interwiki prefix
Implements MediaWiki\Linker\LinkTarget.
Definition at line 967 of file Title.php.
Referenced by WikitextContentHandler\makeRedirectContent().
◆ getLatestRevID()
| Title::getLatestRevID | ( | $flags = 0 | ) |
◆ getLength()
| Title::getLength | ( | $flags = 0 | ) |
◆ getLinksFrom()
| Title::getLinksFrom | ( | $options = [], | |
| $table = 'pagelinks', | |||
| $prefix = 'pl' ) |
Get an array of Title objects linked from this Title Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
- Parameters
-
array $options Query option to Database::select() string $table Table name string $prefix Fields prefix
- Returns
- Title[] List of Titles linking here
Definition at line 3083 of file Title.php.
References $res, DB_REPLICA, and wfGetDB().
◆ getLinksTo()
| Title::getLinksTo | ( | $options = [], | |
| $table = 'pagelinks', | |||
| $prefix = 'pl' ) |
Get an array of Title objects linking to this Title Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
- Parameters
-
array $options May be FOR UPDATE string $table Table name string $prefix Fields prefix
- Returns
- Title[]
Definition at line 3017 of file Title.php.
References $res, DB_PRIMARY, DB_REPLICA, and wfGetDB().
◆ getLinkURL()
| Title::getLinkURL | ( | $query = '', | |
| $query2 = false, | |||
| $proto = false ) |
Get a URL that's the simplest URL that will be valid to link, locally, to the current Title.
It includes the fragment, but does not include the server unless action=render is used (or the link is external). If there's a fragment but the prefixed text is empty, we just return a link to the fragment.
The result obviously should not be URL-escaped, but does need to be HTML-escaped if it's being output in HTML.
- Parameters
-
string | array $query bool $query2 string | int | bool $proto A PROTO_* constant on how the URL should be expanded, or false (default) for no expansion
- See also
- self::getLocalURL for the arguments.
- Returns
- string The URL
◆ getLocalURL()
| Title::getLocalURL | ( | $query = '', | |
| $query2 = false ) |
Get a URL with no fragment or server name (relative URL) from a Title object.
If this page is generated with action=render, however, $wgServer is prepended to make an absolute URL.
- See also
- self::getFullURL to always get an absolute URL.
- self::getLinkURL to always get a URL that's the simplest URL that will be valid to link, locally, to the current Title.
- self::newFromText to produce a Title object.
- Parameters
-
string | array $query An optional query string, not used for interwiki links. Can be specified as an associative array as well, e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped). Some query patterns will trigger various shorturl path replacements. string | string[] | bool $query2 An optional secondary query array. This one MUST be an array. If a string is passed it will be interpreted as a deprecated variant argument and urlencoded into a variant= argument. This second query argument will be added to the $query The second parameter is deprecated since 1.19. Pass it as a key,value pair in the first parameter array instead.
- Returns
- string
Definition at line 2247 of file Title.php.
References $matches, $wgActionPaths, $wgArticlePath, $wgMainPageIsDomainRoot, $wgScript, $wgVariantArticlePath, wfAppendQuery(), and wfUrlencode().
◆ getNamespace()
| Title::getNamespace | ( | ) |
Get the namespace index, i.e.
one of the NS_xxxx constants.
- Returns
- int Namespace index
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1066 of file Title.php.
Referenced by SubpageImportTitleFactory\__construct(), LinkHolderArray\doVariants(), DoubleRedirectJob\fixRedirects(), LinkHolderArray\makeHolder(), WikitextContentHandler\makeRedirectContent(), MediaWiki\Block\Restriction\NamespaceRestriction\matches(), ImageQueryPage\outputResults(), and MovePageForm\showForm().
◆ getNamespaceKey()
| Title::getNamespaceKey | ( | $prepend = 'nstab-' | ) |
◆ getNotificationTimestamp()
| Title::getNotificationTimestamp | ( | User | $user | ) |
Get the timestamp when this page was updated since the user last saw it.
- Deprecated
- since 1.35, hard deprecated since 1.39
- Parameters
-
User $user
- Returns
- string|bool|null String timestamp, false if not watched, null if nothing is unseen
Definition at line 3733 of file Title.php.
References wfDeprecated().
◆ getNsText()
| Title::getNsText | ( | ) |
◆ getOtherPage()
| Title::getOtherPage | ( | ) |
Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page.
- Deprecated
- since 1.34, use NamespaceInfo::getAssociatedPage
- Since
- 1.25
- Exceptions
-
MWException If the page doesn't have an other page
- Returns
- Title
◆ getPageLanguage()
| Title::getPageLanguage | ( | ) |
Get the language in which the content of this page is written in wikitext.
Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).
- Since
- 1.18
- Returns
- Language|StubUserLang
Definition at line 3920 of file Title.php.
References $wgLang, $wgLanguageCode, and wfGetLangObj().
◆ getPageViewLanguage()
| Title::getPageViewLanguage | ( | ) |
Get the language in which the content of this page is written when viewed by user.
Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).
- Since
- 1.20
- Returns
- Language|StubUserLang
Definition at line 3961 of file Title.php.
References $wgLang, and wfGetLangObj().
◆ getParentCategories()
| Title::getParentCategories | ( | ) |
Get categories to which this Title belongs and return an array of categories' names.
- Returns
- string[] Array of parents in the form: $parent => $currentarticle
Definition at line 3257 of file Title.php.
References $dbr, $res, DB_REPLICA, NS_CATEGORY, and wfGetDB().
◆ getParentCategoryTree()
| Title::getParentCategoryTree | ( | $children = [] | ) |
◆ getPartialURL()
| Title::getPartialURL | ( | ) |
◆ 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 1878 of file Title.php.
References $s.
Referenced by PPTemplateFrame_Hash\__construct(), PPFrame_Hash\loopCheck(), and LinkHolderArray\makeHolder().
◆ getPrefixedText()
| Title::getPrefixedText | ( | ) |
Get the prefixed title with spaces.
This is the form usually used for display
- Returns
- string The prefixed title, with spaces
Definition at line 1890 of file Title.php.
References $s.
Referenced by SpecialChangeContentModel\setParameter(), MovePageForm\showForm(), and SpecialWhatLinksHere\wlhLink().
◆ getPrefixedURL()
| Title::getPrefixedURL | ( | ) |
Get a URL-encoded title (not an actual URL) including interwiki.
- Returns
- string The URL-encoded form
Definition at line 2123 of file Title.php.
References $s, and wfUrlencode().
◆ getRedirectsHere()
| Title::getRedirectsHere | ( | $ns = null | ) |
◆ getRestrictionExpiry()
| Title::getRestrictionExpiry | ( | $action | ) |
Get the expiry time for the restriction against a given action.
- Deprecated
- since 1.37, use RestrictionStore::getRestrictionExpiry instead
- Parameters
-
string $action
- Returns
- string|bool 14-char timestamp, or 'infinity' if the page is protected forever or not protected at all, or false if the action is not recognised.
◆ getRestrictions()
| Title::getRestrictions | ( | $action | ) |
Accessor/initialisation for mRestrictions.
- Deprecated
- since 1.37, use RestrictionStore::getRestrictions instead
- Parameters
-
string $action Action that permission needs to be checked for
- Returns
- array Restriction levels needed to take the action. All levels are required. Note that restriction levels are normally user rights, but 'sysop' and 'autoconfirmed' are also allowed for backwards compatibility. These should be mapped to 'editprotected' and 'editsemiprotected' respectively.
◆ getRestrictionTypes()
| Title::getRestrictionTypes | ( | ) |
Returns restriction types for the current Title.
- Deprecated
- since 1.37, use RestrictionStore::listApplicableRestrictionTypes instead
- Returns
- array Applicable restriction types
◆ 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
◆ getRootTitle()
| Title::getRootTitle | ( | ) |
Get the root page name title, i.e.
the leftmost part before any slashes
- Example:
- Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();# returns: Title{User:Foo}
- Returns
- Title
- Since
- 1.20
Definition at line 2001 of file Title.php.
References $title.
◆ getSelectFields()
|
staticprotected |
Returns a list of fields that are to be selected for initializing Title objects.
- Deprecated
- since 1.36, use PageStore::newSelectQueryBuilder() instead. Hard deprecated in 1.39, remove in 1.40
- Returns
- array
Definition at line 506 of file Title.php.
References wfDeprecated().
◆ getSkinFromConfigSubpage()
| Title::getSkinFromConfigSubpage | ( | ) |
◆ getSubjectNsText()
| Title::getSubjectNsText | ( | ) |
◆ 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 1683 of file Title.php.
References $title.
◆ getSubpage()
| Title::getSubpage | ( | $text | ) |
Get the title for a subpage of the current page.
- Example:
- # returns: Title{User:Foo/Bar/Baz/Asdf}
- Parameters
-
string $text The subpage name to add to the title
- Returns
- Title|null Subpage title, or null on an error
- Since
- 1.20
◆ getSubpages()
| Title::getSubpages | ( | $limit = -1 | ) |
Get all subpages of this page.
- Parameters
-
int $limit Maximum number of subpages to fetch; -1 for no limit
- Returns
- TitleArray|array TitleArray, or empty array if this page's namespace doesn't allow subpages
Definition at line 2724 of file Title.php.
References TitleArray\newFromResult().
◆ getSubpageText()
| Title::getSubpageText | ( | ) |
Get the lowest-level subpage name, i.e.
the rightmost part after any slashes
- Example:
- Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();# returns: "Baz"
- Returns
- string Subpage name
◆ getSubpageUrlForm()
| Title::getSubpageUrlForm | ( | ) |
Get a URL-encoded form of the subpage text.
- Returns
- string URL-encoded subpage name
Definition at line 2112 of file Title.php.
References wfUrlencode().
◆ getTalkNsText()
| Title::getTalkNsText | ( | ) |
◆ getTalkPage()
| Title::getTalkPage | ( | ) |
Get a Title object associated with the talk page of this article.
- Deprecated
- since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage() with NamespaceInfo::canHaveTalkPage(). Note that the new method will throw if asked for the talk page of a section-only link, or of an interwiki link.
- Returns
- Title The object for the talk page
- Exceptions
-
MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL or because it's a relative link, or an interwiki link.
Definition at line 1638 of file Title.php.
References $title.
Referenced by MovePageForm\showForm().
◆ getTalkPageIfDefined()
| Title::getTalkPageIfDefined | ( | ) |
◆ getTemplateLinksFrom()
| Title::getTemplateLinksFrom | ( | $options = [] | ) |
◆ getTemplateLinksTo()
| Title::getTemplateLinksTo | ( | $options = [] | ) |
◆ getText()
| Title::getText | ( | ) |
Get the text form (spaces not underscores) of the main part.
- Returns
- string Main part of the title
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1039 of file Title.php.
Referenced by TraditionalImageGallery\getCaptionHtml(), and MovePageForm\showForm().
◆ getTitleProtection()
| Title::getTitleProtection | ( | ) |
Is this title subject to title protection? Title protection is the one applied against creation of such title.
- Deprecated
- since 1.37, use RestrictionStore::getRestrictions() instead
- Returns
- array|bool An associative array representing any existent title protection, or false if there's none.
◆ getTitleValue()
| Title::getTitleValue | ( | ) |
Get a TitleValue object representing this Title.
- Note
- Not all valid Titles have a corresponding valid TitleValue (e.g. TitleValues cannot represent page-local links that have a fragment but no title text).
- Returns
- TitleValue|null
Definition at line 1016 of file Title.php.
References wfDebug().
◆ getTouched()
| Title::getTouched | ( | $flags = self::READ_NORMAL | ) |
Get the last touched timestamp.
- Parameters
-
int $flags one of the READ_XXX constants. For historical reasons, an IDatabase instance is also accepted here. If an IDatabase is passed, a deprecation warning is triggered, caches will be bypassed, and the primary database connection will be used. However, the IDatabase instance itself will be ignored.
- Returns
- string|false Last-touched timestamp
Definition at line 3711 of file Title.php.
References wfDeprecatedMsg().
◆ getTransWikiID()
| Title::getTransWikiID | ( | ) |
◆ getWikiId()
| Title::getWikiId | ( | ) |
Returns false to indicate that this Title belongs to the local wiki.
- Note
- The behavior of this method if considered undefined for interwiki links. At the moment, this method always returns false. But this may change in the future.
- Since
- 1.36
- Returns
- bool false
Implements MediaWiki\Page\PageReference.
◆ hasContentModel()
| Title::hasContentModel | ( | $id | ) |
◆ hasDeletedEdits()
| Title::hasDeletedEdits | ( | ) |
◆ hasFragment()
| Title::hasFragment | ( | ) |
Check if a Title fragment is set.
- Returns
- bool
- Since
- 1.23
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1777 of file Title.php.
Referenced by CoreParserFunctions\displaytitle().
◆ hasSourceText()
| Title::hasSourceText | ( | ) |
Does this page have source text?
- Returns
- bool
Definition at line 3562 of file Title.php.
References NS_MEDIAWIKI, and wfMessage().
◆ hasSubjectNamespace()
| Title::hasSubjectNamespace | ( | $ns | ) |
Returns true if the title has the same subject namespace as the namespace specified.
For example this method will take NS_USER and return true if namespace is either NS_USER or NS_USER_TALK since both of them have NS_USER as their subject namespace.
This is MUCH simpler than individually testing for equivalence against both NS_USER and NS_USER_TALK, and is also forward compatible.
- Since
- 1.19
- Parameters
-
int $ns
- Returns
- bool
◆ hasSubpages()
| Title::hasSubpages | ( | ) |
◆ inNamespace()
| Title::inNamespace | ( | int | $ns | ) |
Returns true if the title is inside the specified namespace.
- Parameters
-
int $ns The namespace
- Returns
- bool
- Since
- 1.19
Implements MediaWiki\Linker\LinkTarget.
◆ inNamespaces()
| Title::inNamespaces | ( | $namespaces | ) |
◆ 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 3644 of file Title.php.
References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\getDomainID(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), Wikimedia\Rdbms\IDatabase\update(), and wfGetDB().
◆ isAlwaysKnown()
| Title::isAlwaysKnown | ( | ) |
Should links to this title be shown as potentially viewable (i.e.
as "bluelinks"), even if there's no record by this title in the page table?
This function is semi-deprecated for public use, as well as somewhat misleadingly named. You probably just want to call isKnown(), which calls this function internally.
(ISSUE: Most of these checks are cheap, but the file existence check can potentially be quite expensive. Including it here fixes a lot of existing code, but we might want to add an optional parameter to skip it and any other expensive checks.)
- Returns
- bool
Definition at line 3499 of file Title.php.
References NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, and NS_SPECIAL.
◆ isBigDeletion()
| Title::isBigDeletion | ( | ) |
Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.
- Deprecated
- since 1.37 External callers shouldn't need to know about this.
- Returns
- bool
Definition at line 3347 of file Title.php.
References $dbr, $wgDeleteRevisionsLimit, DB_REPLICA, and wfGetDB().
◆ isCascadeProtected()
| Title::isCascadeProtected | ( | ) |
Cascading protection: Return true if cascading restrictions apply to this page, false if not.
- Deprecated
- since 1.37, use RestrictionStore::isCascadeProtected instead
- Returns
- bool If the page is subject to cascading restrictions.
◆ isContentPage()
| Title::isContentPage | ( | ) |
◆ isConversionTable()
| Title::isConversionTable | ( | ) |
Is this a conversion table for the LanguageConverter?
- Returns
- bool
Definition at line 1431 of file Title.php.
References NS_MEDIAWIKI.
◆ isDeleted()
| Title::isDeleted | ( | ) |
Is there a version of this page in the deletion archive?
- Deprecated
- since 1.36. Use self::getDeletedEditsCount()
- Returns
- int The number of archived revisions
◆ isDeletedQuick()
| Title::isDeletedQuick | ( | ) |
Is there a version of this page in the deletion archive?
- Deprecated
- since 1.36, Use self::hasDeletedEdits()
- Returns
- bool
◆ isExternal()
| Title::isExternal | ( | ) |
Is this Title interwiki?
- Returns
- bool
Implements MediaWiki\Linker\LinkTarget.
Definition at line 956 of file Title.php.
Referenced by LinkHolderArray\makeHolder().
◆ isKnown()
| Title::isKnown | ( | ) |
Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).
Adding something else to this function will cause inconsistency since LinkHolderArray calls isAlwaysKnown() and does its own page existence check.
- Returns
- bool
◆ 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
◆ isMainPage()
| Title::isMainPage | ( | ) |
◆ isMovable()
| Title::isMovable | ( | ) |
◆ isNewPage()
| Title::isNewPage | ( | $flags = self::READ_NORMAL | ) |
◆ isProtected()
| Title::isProtected | ( | $action = '' | ) |
Does the title correspond to a protected article?
- Deprecated
- since 1.37, use RestrictionStore::isProtected instead
- Parameters
-
string $action The action the page is protected from, by default checks all actions.
- Returns
- bool
◆ isRawHtmlMessage()
| Title::isRawHtmlMessage | ( | ) |
Is this a message which can contain raw HTML?
- Returns
- bool
- Since
- 1.32
Definition at line 1607 of file Title.php.
References $wgRawHtmlMessages, and NS_MEDIAWIKI.
◆ isRedirect()
| Title::isRedirect | ( | $flags = 0 | ) |
Is this an article that is a redirect page? Uses link cache, adding it if necessary.
This is intended to provide fast access to page_is_redirect for linking. In rare cases, there might not be a valid target in the redirect table even though this function returns true.
To find a redirect target, just call WikiPage::getRedirectTarget() and check if it returns null, there's no need to call this first.
- Parameters
-
int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
- Returns
- bool
◆ isSameLinkAs()
| Title::isSameLinkAs | ( | LinkTarget | $other | ) |
- See also
- LinkTarget::isSameLinkAs()
- Since
- 1.36
- Parameters
-
LinkTarget $other
- Returns
- bool
Implements MediaWiki\Linker\LinkTarget.
◆ isSamePageAs()
| Title::isSamePageAs | ( | PageReference | $other | ) |
- See also
- PageReference::isSamePageAs()
- Since
- 1.36
- Parameters
-
PageReference $other
- Returns
- bool
Implements MediaWiki\Page\PageReference.
◆ isSemiProtected()
| Title::isSemiProtected | ( | $action = 'edit' | ) |
Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?
- Deprecated
- since 1.37, use RestrictionStore::isSemiProtected instead
- Parameters
-
string $action Action to check (default: edit)
- Returns
- bool
◆ 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 3218 of file Title.php.
References DB_PRIMARY, and wfGetDB().
◆ isSiteConfigPage()
| Title::isSiteConfigPage | ( | ) |
Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI.
This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
This method does not return true for per-user JS/JSON/CSS. Use isUserConfigPage() for that!
Note that this method should not return true for pages that contain and show "inactive" CSS, JSON, or JS.
- Returns
- bool
- Since
- 1.31
◆ isSiteCssConfigPage()
| Title::isSiteCssConfigPage | ( | ) |
Is this a sitewide CSS "config" page?
- Returns
- bool
- Since
- 1.32
Definition at line 1553 of file Title.php.
References CONTENT_MODEL_CSS, and NS_MEDIAWIKI.
◆ isSiteJsConfigPage()
| Title::isSiteJsConfigPage | ( | ) |
Is this a sitewide JS "config" page?
- Returns
- bool
- Since
- 1.31
Definition at line 1589 of file Title.php.
References CONTENT_MODEL_JAVASCRIPT, and NS_MEDIAWIKI.
◆ isSiteJsonConfigPage()
| Title::isSiteJsonConfigPage | ( | ) |
Is this a sitewide JSON "config" page?
- Returns
- bool
- Since
- 1.32
Definition at line 1571 of file Title.php.
References CONTENT_MODEL_JSON, and NS_MEDIAWIKI.
◆ isSpecial()
| Title::isSpecial | ( | $name | ) |
◆ isSpecialPage()
| Title::isSpecialPage | ( | ) |
Returns true if this is a special page.
- Returns
- bool
Definition at line 1273 of file Title.php.
References NS_SPECIAL.
Referenced by SkinTemplate\buildPersonalUrls().
◆ isSubpage()
◆ isSubpageOf()
| Title::isSubpageOf | ( | Title | $title | ) |
◆ isTalkPage()
| Title::isTalkPage | ( | ) |
◆ isTrans()
| Title::isTrans | ( | ) |
◆ isUserConfigPage()
| Title::isUserConfigPage | ( | ) |
◆ isUserCssConfigPage()
| Title::isUserCssConfigPage | ( | ) |
Is this a CSS "config" sub-page of a user page?
- Returns
- bool
- Since
- 1.31
Definition at line 1511 of file Title.php.
References CONTENT_MODEL_CSS, and NS_USER.
◆ isUserJsConfigPage()
| Title::isUserJsConfigPage | ( | ) |
Is this a JS "config" sub-page of a user page?
- Returns
- bool
- Since
- 1.31
Definition at line 1539 of file Title.php.
References CONTENT_MODEL_JAVASCRIPT, and NS_USER.
◆ isUserJsonConfigPage()
| Title::isUserJsonConfigPage | ( | ) |
Is this a JSON "config" sub-page of a user page?
- Returns
- bool
- Since
- 1.31
Definition at line 1525 of file Title.php.
References CONTENT_MODEL_JSON, and NS_USER.
◆ isValid()
| Title::isValid | ( | ) |
Returns true if the title is a valid link target, and that it has been properly normalized.
This method checks that the title is syntactically valid, and that the namespace it refers to exists.
Titles constructed using newFromText() or makeTitleSafe() are always valid.
- Note
- Code that wants to check whether the title can represent a page that can be created and edited should use canExist() instead. Examples of valid titles that cannot "exist" are Special pages, interwiki links, and on-page section links that only have the fragment part set.
- See also
- canExist()
- Returns
- bool
◆ isValidRedirectTarget()
| Title::isValidRedirectTarget | ( | ) |
Check if this Title is a valid redirect target.
- Returns
- bool
Definition at line 3811 of file Title.php.
References $wgInvalidRedirectTargets.
Referenced by WikitextContent\getRedirectTargetAndText(), and XmlDumpWriter\openPage().
◆ isWikitextPage()
| Title::isWikitextPage | ( | ) |
Does that page contain wikitext, or it is JS, CSS or whatever?
- Returns
- bool
Definition at line 1444 of file Title.php.
References CONTENT_MODEL_WIKITEXT.
◆ legalChars()
|
static |
Get a regex character class describing the legal characters in a link.
- Returns
- string The list of characters, not delimited
Definition at line 734 of file Title.php.
References $wgLegalTitleChars.
◆ loadFromRow()
| Title::loadFromRow | ( | $row | ) |
◆ loadRestrictions()
| Title::loadRestrictions | ( | $flags = 0 | ) |
Load restrictions from the page_restrictions table.
- Deprecated
- since 1.37, no public replacement
- Parameters
-
int $flags A bit field. If self::READ_LATEST is set, skip replicas and read from the primary DB.
◆ loadRestrictionsFromRows()
| Title::loadRestrictionsFromRows | ( | $rows | ) |
Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page.
Public for usage by LiquidThreads.
- Deprecated
- since 1.37, use RestrictionStore::loadRestrictionsFromRows instead
- Parameters
-
stdClass[] $rows Array of db result objects
◆ makeName()
|
static |
Make a prefixed DB key from a DB key and a namespace index.
- Parameters
-
int $ns Numerical representation of the namespace string $title The DB key form the title string $fragment The link fragment (after the "#") string $interwiki The interwiki prefix bool $canonicalNamespace If true, use the canonical name for $ns instead of the localized version.
- Returns
- string The prefixed form of the title
Definition at line 854 of file Title.php.
References $title.
◆ makeTitle()
|
static |
Create a new Title from a namespace index and a DB key.
It's assumed that $ns and $title are safe, for instance when they came directly from the database or a special page name, not from user input.
No validation is applied. For convenience, spaces are normalized to underscores, so that e.g. user_text fields can be used directly.
- Note
- This method may return Title objects that are "invalid" according to the isValid() method. This is usually caused by configuration changes: e.g. a namespace that was once defined is no longer configured, or a character that was once allowed in titles is now forbidden.
- Parameters
-
int $ns The namespace of the article string $title The unprefixed database key form string $fragment The link fragment (after the "#") string $interwiki The interwiki prefix
- Returns
- Title The new object
Definition at line 638 of file Title.php.
References $t, $title, and wfUrlencode().
◆ makeTitleSafe()
|
static |
Create a new Title from a namespace index and a DB key.
The parameters will be checked for validity, which is a bit slower than makeTitle() but safer for user-provided data.
The Title object returned by this method is guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
- Parameters
-
int $ns The namespace of the article string $title Database key form string $fragment The link fragment (after the "#") string $interwiki Interwiki prefix
- Returns
- Title|null The new object, or null on an error
◆ newFromDBkey()
|
static |
◆ newFromID()
|
static |
◆ newFromIDs()
|
static |
Make an array of titles from an array of IDs.
- Parameters
-
int[] $ids Array of IDs
- Returns
- Title[] Array of Titles
- Deprecated
- since 1.38 use a PageStore QueryBuilder instead
Definition at line 545 of file Title.php.
References $dbr, $res, DB_REPLICA, wfDeprecated(), and wfGetDB().
◆ newFromLinkTarget()
|
static |
Returns a Title given a LinkTarget.
If the given LinkTarget is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget is already a Title instance, that instance is copied using the clone operator.
- Parameters
-
LinkTarget $linkTarget Assumed to be safe. string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
- Returns
- Title
Definition at line 282 of file Title.php.
References MediaWiki\Linker\LinkTarget\getFragment(), MediaWiki\Linker\LinkTarget\getInterwiki(), MediaWiki\Linker\LinkTarget\getNamespace(), and MediaWiki\Linker\LinkTarget\getText().
◆ newFromRow()
|
static |
◆ newFromText()
|
static |
Create a new Title from text, such as what one would find in a link.
Decodes any HTML entities in the text. Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
- Note
- The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.
- Parameters
-
string | int | null $text The link text; spaces, prefixes, and an initial ':' indicating the main namespace are accepted. int $defaultNamespace The namespace to use if none is specified by a prefix. If you want to force a specific namespace even if $text might begin with a namespace prefix, use makeTitle() or makeTitleSafe().
- Exceptions
-
InvalidArgumentException
◆ newFromTextThrow()
|
static |
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
- Note
- The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.
- See also
- Title::newFromText
- Since
- 1.25
- Parameters
-
string $text Title text to check int $defaultNamespace
- Exceptions
-
MalformedTitleException If the title is invalid.
- Returns
- Title
◆ newFromTitleValue()
|
static |
Returns a Title given a TitleValue.
If the given TitleValue is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue is already a Title instance, that instance is copied using the clone operator.
- Deprecated
- since 1.34, use newFromLinkTarget or castFromLinkTarget. Hard deprecated in 1.39.
- Parameters
-
TitleValue $titleValue Assumed to be safe. string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
- Returns
- Title
Definition at line 266 of file Title.php.
References wfDeprecated().
◆ newFromURL()
|
static |
THIS IS NOT THE FUNCTION YOU WANT.
Use Title::newFromText().
Example of wrong and broken code: $title = Title::newFromURL( $request->getText( 'title' ) );
Example of right code: $title = Title::newFromText( $request->getText( 'title' ) );
Create a new Title from URL-encoded text. Ensures that the given title's length does not exceed the maximum.
- Parameters
-
string $url The title, as might be taken from a URL
- Returns
- Title|null The new object, or null on an error
Definition at line 467 of file Title.php.
References $t.
◆ newMainPage()
|
static |
Create a new Title for the Main Page.
This uses the 'mainpage' interface message, which could be specified in $wgForceUIMsgAsContentMsg. If that is the case, then calling this method will use the user language, which would involve initialising the session via RequestContext::getMain()->getLanguage(). For session-less endpoints, be sure to pass in a MessageLocalizer (such as your own RequestContext or ResourceLoader Context) to prevent an error.
- Note
- The Title instance returned by this method is not guaranteed to be a fresh instance. It may instead be a cached instance created previously, with references to it remaining elsewhere.
- Parameters
-
MessageLocalizer | null $localizer An optional context to use (since 1.34)
- Returns
- Title
Definition at line 700 of file Title.php.
References $title, and wfMessage().
◆ pageCond()
| Title::pageCond | ( | ) |
◆ purgeExpiredRestrictions()
|
static |
Purge expired restrictions from the page_restrictions table.
This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
Definition at line 2655 of file Title.php.
References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\selectFieldValues(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and wfGetDB().
◆ purgeSquid()
| Title::purgeSquid | ( | ) |
Purge all applicable CDN URLs.
- Deprecated
- since 1.35 Use HtmlCacheUpdater
◆ resetArticleID()
| Title::resetArticleID | ( | $id | ) |
Inject a page ID, reset DB-loaded fields, and clear the link cache for this title.
This can be called on page insertion to allow loading of the new page_id without having to create a new Title instance. Likewise with deletion.
This is also used during page moves, to reflect the change in the relationship between article ID and title text.
- Note
- This overrides Title::setContentModel()
- Parameters
-
int | bool $id Page ID, 0 for non-existent, or false for "unknown" (lazy-load)
◆ setContentModel()
| Title::setContentModel | ( | $model | ) |
Set a proposed content model for the page for permissions checking.
This does not actually change the content model of a title in the DB. It only affects this particular Title instance. The content model is forced to remain this value until another setContentModel() call.
ContentHandler::canBeUsedOn() should be checked before calling this if there is any doubt regarding the applicability of the content model
- Warning
- This must only be used if the caller controls the further use of this Title object, to avoid other code unexpectedly using the new value.
- Since
- 1.28
- Parameters
-
string $model CONTENT_MODEL_XXX constant
◆ setFragment()
| Title::setFragment | ( | $fragment | ) |
Set the fragment for this title.
Removes the first character from the specified fragment before setting, so it assumes you're passing it with an initial "#".
- Warning
- This must only be used if the caller controls the further use of this Title object, to avoid other code unexpectedly using the new value.
- Parameters
-
string $fragment Text
◆ toPageIdentity()
| Title::toPageIdentity | ( | ) |
Returns the page represented by this Title as a ProperPageIdentity.
The ProperPageIdentity returned by this method is guaranteed to be immutable. If this Title does not represent a proper page, an exception is thrown.
It is preferred to use this method rather than using the Title as a PageIdentity directly.
- Returns
- ProperPageIdentity
- Exceptions
-
PreconditionException if the page is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such.
- Since
- 1.36
◆ toPageRecord()
| Title::toPageRecord | ( | $flags = 0 | ) |
Returns the page represented by this Title as a ProperPageRecord.
The PageRecord returned by this method is guaranteed to be immutable, the page is guaranteed to exist.
- Note
- For now, this method queries the database on every call.
- Since
- 1.36
- Parameters
-
int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
- Returns
- ExistingPageRecord
- Exceptions
-
PreconditionException if the page does not exist, or is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such.
◆ 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 3684 of file Title.php.
References NS_CATEGORY.
◆ wasLocalInterwiki()
| Title::wasLocalInterwiki | ( | ) |
Member Data Documentation
◆ $mArticleID
| int Title::$mArticleID = -1 |
◆ $mLatestID
|
protected |
◆ $mLength
|
protected |
◆ $mRedirect
| null bool Title::$mRedirect = null |
◆ $prefixedText
| string null Title::$prefixedText = null |
Text form including namespace/interwiki, initialised on demand.
Only public to share cache with TitleFormatter
- Access: internal
◆ GAID_FOR_UPDATE
| const Title::GAID_FOR_UPDATE = 512 |
Used to be GAID_FOR_UPDATE define().
Used with getArticleID() and friends to use the primary DB and inject it into link cache.
- Deprecated
- since 1.34, use Title::READ_LATEST instead.
◆ NEW_CLONE
| const Title::NEW_CLONE = 'clone' |
The documentation for this class was generated from the following file:
- includes/Title.php
