Manual:Title.php

The MediaWiki software's   class implements the  and IDBAccessObject interfaces.

It represents 2>m:Special:MyLanguage/Help:Page name|article titles, which are used for many purposes, including:


 * as the human-readable text title of the article


 * in the URL used to access the article


 * the wikitext link to the article


 * the key into the article database

The class is instantiated with one of these formats.

Once instantiated, the title can be retrieved in other formats or queried for its attributes.

  is intended to be an immutable "value" class, so there are no mutator functions.

To instantiate  , call one of the static factory methods:
 * -  This is not the function you want.  Use Title::newFromText.
 * - returns an array of Titles
 * - Create a new Title from a namespace index and a DB key. Returns null on an error.
 * -  This is not the function you want.  Use Title::newFromText.
 * - returns an array of Titles
 * - Create a new Title from a namespace index and a DB key. Returns null on an error.
 * - Create a new Title from a namespace index and a DB key. Returns null on an error.

Once instantiated, the other non-static accessor methods can be used, such as  </>, <tvar|2> </>, <tvar|3> </>, etc.

If you have a Title object, you can get a:


 * <tvar|1></> object, using <tvar|2> </>


 * <tvar|1></> object, using <tvar|2> </>

This class can fetch various kinds of data from the database; however, it does so inefficiently.

Consider using a <tvar|1></> object instead.

<tvar|1>TitleValue</> is more lightweight and does not rely on global state or the database.

Title structure
A title consists of an optional Interwiki prefix (such as "<tvar|1> </>" for pages from 2>mw:</>|mediawiki.org or "<tvar|3> </>" for 4>w:</>|Wikipedia articles), followed by an optional namespace (such as "<tvar|5> </>"), followed by the page name.

Interwiki prefixes and namespaces
Interwiki prefixes and namespaces follow the same content rules:


 * they must start with a letter


 * they must end with a colon


 * they may only contain digits, letters, the space character and the underscore character


 * spaces and underscores may be used interchangeably


 * they are case-insensitive

Interwiki prefixes and namespaces are only recognized if they are known to a given installation of MediaWiki, either by default or through configuration.

For example: On this wiki, "<tvar|name> </>" is a link to the article "<tvar|1> </>" on Wikipedia, because "<tvar|w> </>" is recognized as one of the allowable interwiki prefixes. The title "<tvar|talk> </>" is a link to the article "name" in the "<tvar|tk1> </>" namespace of the current wiki, because "<tvar|tk2> </>" is a recognized namespace. Both may be present, and if so, the interwiki must come first, for example, "<tvar|tk3> </>".

If a title begins with a colon as its first character, no prefixes are scanned for, and the colon is removed before the title is processed.

Because of this rule, it is possible to have articles with colons in their names.

"<tvar|valid> </>" is a valid title, as is "url>w:Commandos: Behind Enemy Lines</>|Commandos: Behind Enemy Lines", because "<tvar|valid2> </>" and "<tvar|text> </>" are not valid interwikis or namespaces.

Article name
In the article name, spaces and underscores are treated as equivalent and each is converted to the other in the appropriate context (underscore in URL and database keys, spaces in plain text). "Extended" characters in the 0x80..0xFF range are allowed in all places, and are valid characters.

They are encoded in URLs. Extended characters are not urlencoded when used as text or database keys.

Other characters may be ASCII letters, digits, hyphen, comma, period, apostrophe, parentheses and colon.

No other ASCII characters are allowed, and will be deleted if found (they will probably cause a browser to misinterpret the URL).

Canonical forms
The canonical form of a title will always be returned by the object. Canonicalization involves the following:


 * Certain Unicode directional characters (left-to-right mark, etc.) are stripped, since that usually results from errant copy-and-paste.
 * Everything from  onward is stripped, since that's used for section links.
 * Sequences of underscores and/or certain whitespace characters are collapsed into a single underscore (for the URL and DBkey forms) or a single space (for the text form). At the beginning or end of the title (or namespace or interwiki prefix), these are stripped.
 * Recognized interwiki prefixes are canonicalized, meaning that they're put entirely in lowercase.
 * Recognized namespace-names are canonicalized, meaning that the first character is capitalized and subsequent characters are put in lowercase. (This is not done for interwiki-links, however.)
 * Depending on the wiki and the namespace, the first character of a title may be capitalized. (This is not done for interwiki-links, however.)
 * For links to user-pages of anonymous users, the IP address is canonicalized.
 * The canonicalization process also includes some validation logic to reject various kinds of invalid titles (such as ones that are too long, or that contain illegal characters).

Diagrams for MediaWikiTitleCodec Class
A codec for MediaWiki page titles: <tvar|classMediaWikiTitleCodec>&#x5B;code link&#x5D;</>

Example
To check and see if a given page already exists:

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

Decodes any HTML entities in the text. Spaces, prefixes, and an initial ':' indicating the main namespace are accepted.

Note that if the page does not exist, this will not create it.

For that, see <tvar|1>Manual:Article.php</>.

Functions
Many of these functions are used by <tvar|1></> to generate 2>Special:MyLanguage/Help:Magic words</>|magic words.

getArticleID
Get the article ID for this Title from the link cache, adding it if necessary. For "internal" articles, it should return the "page_id" field if the article exists, else it returns 0.

For all external articles it returns 0. All of the IDs for all instances of Title created during a request are cached, so they can be looked up quickly while rendering wikitext with lots of internal links.

getBaseText
Get the base page name, i.e. the leftmost part excluding namespace and before any slashes, without converting spaces to underscores. See magic words <tvar|1></> and <tvar|2></>.

getText
Gets the text form (spaces not underscores) of the main part, i.e. the title excluding namespace, but including slashes and everything after. See magic word <tvar|1></>.

getDBKey
Get the main part (i.e. the title excluding namespace) with underscores.

getPrefixedDBKey
Get the prefixed database key form with underscores.

getFragment
Get the Title fragment (i.e. the bit after the #) in text form.

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

getPartialURL
Get the URL-encoded form of the main part. See magic word <tvar|1></>.

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

getLocalURL
Get a URL with no fragment or server name.

getPrefixedText
Get the prefixed title with spaces. This is the form usually used for display. See magic word <tvar|1></>.

getPrefixedUrl
Get a URL-encoded title (not an actual URL) including interwiki. See magic word <tvar|1></>.

getSubjectNsText
Get the namespace text of the subject (rather than talk) page. See magic words <tvar|1></> and <tvar|2></>.

getSubjectPage
Get a title object associated with the subject page of this talk page. See magic word <tvar|1></>.

getSubpageText
Get the lowest-level subpage name, i.e. the rightmost part after any slashes. See magic word <tvar|1></>.

getSubpageUrlForm
Get a URL-encoded form of the subpage text. See magic word <tvar|1></>.

getTalkNsText
Get the namespace text of the talk page. See magic word <tvar|1></> and <tvar|2></>.

getTalkPage
Get a Title object associated with the talk page of this article. See <tvar|1></> and <tvar|2></>.

getNamespace
Get the namespace index. See <tvar|1></>.