Manual:Special pages/id

From MediaWiki.org
Jump to: navigation, search
Gnome-preferences-other.svg Extensions:Manual:Extensions PengembanganManual:Developing extensions Tag extensionsManual:Tag extensions Parser functionsManual:Parser functions HooksManual:Hooks Special pagesManual:Special pages KulitManual:Skins Magic wordsManual:Magic words APIAPI:Extensions

Laman istimewa adalah laman yang dibuat oleh perangkat lunak sesuai kebutuhan untuk melakukan fungsi khusus. Misalnya, suatu laman istimewa dapat menampilkan semua laman yang memiliki satu atau lebih tautan ke situs eksternal atau membuat formulir untuk umpan balik dari pengguna. Laman istimewa memiliki ruang nama sendiri (Special:) dan tidak dapat disunting langsung seperti laman lain. Pengembang dapat membuat laman istimewa baru. Laman-laman ini dapat diakses pengguna dan umumnya muncul pada daftar semua laman istimewa di Special:SpecialPages. Beberapa laman hanya tersedia bagi pengguna dengan hak akses tertentu. Laman istimewa lain sama sekali tidak muncul pada daftar laman istimewa dan hanya digunakan untuk keperluan internal wiki.

Informasi umum[edit]

All of the ~75 built-in special pages that come with MediaWiki are called SpecialSomename.php and are located in the includes/specials directory. Special pages created by third party developers are generally stored in the extensions directory in their own file or as part of a larger extension. All special pages inherit from a class called SpecialPage which is defined in includes/SpecialPage.php. When a new special page is created, the user rights needed to access the page can be defined. These rights specify, among other things, whether the page will show up on Special:Specialpages and whether the page is includable in other pages.

Special pages also have unique names that can be customized on a wiki. The general form is "Special:Pagename" where both "Special" and "Pagename" are customizable. The Special pseudo namespace can be translated in other languages. This translated namespace can be produced with the wikitext {{ns:special}}, on this wiki giving "Special". The name of the special page can also be redefined in a system message, for the site language, with the generic name of the special page as the ID.

A special page may or may not allow input. For example, Special:Export allows a user to define a specific page to export by calling Special:Export/Sun. If the special page allows complex input, additional parameters will be sent to the query string component of the the URL for processing, e.g. http://www.mediawiki.org/w/index.php?title=Special:Recentchanges&days=3&limit=250.

Notes:

  • There are various ways to make special pages, but the one below is used by the bulk of official extensions, and adherence to this style is recommended. Also, be sure to include a credits block in the new special page for 'specialpage'. See $wgExtensionCredits for more details.
  • After making a new special page, be sure to add it to Category:Special page extensions so other people can find it.
  • It should be pointed out that the method used below will not work on PHP 4: it depends on "class autoloading" which was introduced with PHP 5. Special pages written in this style are therefore not necessarily compatible with MediaWiki prior to version 1.7.0: if using an earlier version of MediaWiki on a more-recent version of PHP, upgrade MediaWiki.

Templat dasar laman istimewa[edit]

Most special pages require four files: a small setup file, which will be loaded every time MediaWiki starts, an internationalization file, an alias file, and a file with the bulk of the code. All of them should be placed in a new directory inside the MediaWiki extensions/ directory. MediaWiki coding conventions define the four files like this:

  • <special_page_name>.php - The setup file.
  • <special_page_name>_body.php - The special page code.
  • <special_page_name>.i18n.php - The internationalization file.
  • <special_page_name>.alias.php - The alias file.

For longer extensions with many other components besides the special page, you may want to instead name the special page code file Special<special_page_name>.php.

In the example below, <special_page_name> is MyExtension. A working copy is available for download, see further down.

After creating the four files listed below, add the following line to LocalSettings.php

  • require_once( "$IP/extensions/MyExtension/MyExtension.php" );

Berkas Penyiapan[edit]

The setup file (in this example, named MyExtension.php) looks like this:

<?php
# Alert the user that this is not a valid entry point to MediaWiki if they try to access the special pages file directly.
if (!defined('MEDIAWIKI')) {
	echo <<<EOT
To install my extension, put the following line in LocalSettings.php:
require_once( "\$IP/extensions/MyExtension/MyExtension.php" );
EOT;
	exit( 1 );
}

$wgExtensionCredits['specialpage'][] = array(
	'name' => 'MyExtension',
	'author' => 'My name',
	'url' => 'http://www.mediawiki.org/wiki/Extension:MyExtension',
	'description' => 'Default description message',
	'descriptionmsg' => 'myextension-desc',
	'version' => '0.0.0',
);

$dir = dirname(__FILE__) . '/';

$wgAutoloadClasses['MyExtension'] = $dir . 'MyExtension_body.php'; # Location of the MyExtension class (Tell MediaWiki to load this file)
$wgExtensionMessagesFiles['MyExtension'] = $dir . 'MyExtension.i18n.php'; # Location of a messages file (Tell MediaWiki to load this file)
$wgExtensionAliasesFiles['MyExtension'] = $dir . 'MyExtension.alias.php'; # Location of an alias file (Tell MediaWiki to load this file)
$wgSpecialPages['MyExtension'] = 'MyExtension'; # Tell MediaWiki about the new special page and its class name

This stub file registers four important things:

  • The location of the MyExtension class
  • The location of a messages file
  • The location of an alias file.
  • The new special page and its class name

You may also want to set a value for $wgSpecialPageGroups so that your special page gets put under the right heading in Special:SpecialPages, e.g.:

$wgSpecialPageGroups['MyExtension'] = 'other';

Berkas Isi[edit]

The body file (in this example, named MyExtension_body.php) will contain a subclass of SpecialPage. It will be loaded automatically when the special page is requested. In this example, the subclass MyExtension is called:

<?php
class MyExtension extends SpecialPage {
	function __construct() {
		parent::__construct( 'MyExtension' );
		wfLoadExtensionMessages('MyExtension');
	}

	function execute( $par ) {
		global $wgRequest, $wgOut;

		$this->setHeaders();

		# Get request data from, e.g.
		$param = $wgRequest->getText('param');

		# Do stuff
		# ...
		$output="Hello world!";
		$wgOut->addWikiText( $output );
	}
}

execute() is the main function that is called when a special page is accessed. The function overloads the function SpecialPage::execute(). It passes a single parameter $par, the subpage component of the current title. For example, if someone follows a link to Special:MyExtension/blah, $par will contain "blah".

Wikitext and HTML output should normally be run via $wgOut -- do not use 'print' or 'echo' directly when working within the wiki's user interface.

However if you're using your special page as an entry point to custom XML or binary output, see Taking over output in your special page.

wfLoadExtensionsMessages('MyExtension') loads the messages defined in the message file that was given in MyExtension.php and that will be explained in the next section.

Berkas Pesan/Internasionalisasi[edit]

All special pages must specify a title to appear in the title and <H1> elements of the extension's page and on Special:SpecialPages. The extension specifies the title through a message. The structure of the message is a key-value pair. The ID, 'myextension', must be in all lowercase when specified in the key portion of the key-value pair, even if everywhere else it is MyExtension. The title, 'My Extension', can be anything, however it is convenient if the page title is the same as the ID. At its barest minimum, the message file (in this example, named MyExtension.i18n.php) should look like:

<?php
$messages = array();

$messages['en'] = array(
	'myextension' => 'My Extension',
);


The message file can contain a great deal more information. The following example adds a description of the extension. It also adds a text for browsers specifying a preference for German.

<?php
$messages = array();

/* *** English *** */
$messages['en'] = array(
	'myextension' => 'My Extension',
	'myextension-desc' => "Extension's description",
);

/* *** German (Deutsch) *** */
$messages['de'] = array(
	'myextension' => 'Meine Erweiterung',
	'myextension-desc' => 'Beschreibung der Erweiterung',
);


Note that IDs should not start with an uppercase letter, and that a space in the ID should be written in the code as an underscore. For the page header and linking, the usual rules for page names apply. If $wgCapitalLinks is true, a lowercase letter is converted to uppercase, and an underscore is displayed as a space. For example: instead of the above, we could have used 'my_extension' => 'My extension', assuming we consistently identified the extension as my_extension elsewhere.

Berkas Alias[edit]

This file (in this example, named MyExtension.alias.php) has about the same format as the messages file.

<?php
$aliases = array();

/** English */
$aliases['en'] = array(
	'MyExtension' => array( 'MyExtension' ),
);

/** German (Deutsch) */
$aliases['de'] = array(
	'MyExtension' => array( 'MeineErweiterung', 'Meine Erweiterung' ),
);

It allows the page title to be translated to another language. The page title can be customized into another language, the URL of the page would still be something like .../Special:MyExtension, even when the user language is not English. In this example, the special page MyExtension registers an alias so the page becomes accessible via .../Special:My_Extension eg. .../Spezial:Meine_Erweiterung in German, and so on.


A version of this example has been tested, and is checked in to MediaWiki SVN in examples/FourFileTemplate.

Berkas penting lain[edit]

SpecialPage.php[edit]

Constructor[edit]

You can overload the constructor to initialize your own data, but the main reason you would want to do it is to change the behavior of the SpecialPage class itself. When you call the base class constructor from your child class, the following parameters are available:

function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false )
  • string $name Name of the special page, as seen in links and URLs
  • string $restriction User right required, e.g. "block" or "delete"
  • boolean $listed Whether the page is listed in Special:Specialpages
  • string $function A global function to call at run time if your subclass doesn't override execute(). By default it is constructed from $name as "wfSpecial$name".
  • string $file File which is included by execute(). It is also constructed from $name by default
  • boolean $includable Whether the special page can be included from other pages using {{Special:...}}

SpecialPage->setHeaders()[edit]

This initialises the OutputPage object $wgOut with the name and description of your special page. It should always be called from your execute() method.

SpecialPage->including()[edit]

This returns a boolean value telling you what context the special page is being called from: false if it is a separate web page, and true if it is being included from within another web page. Usually you will want to strip down the presentation somewhat if the page is being included.

Including from another web page is only possible if you declared the page to be includable in the constructor. You can do this by adding the following in the __construct() method after the parent class initalization:

$this->mIncludable = true;

SpecialPage->execute()[edit]

This is the function which your child class should overload. It passes a single parameter, usually referred to cryptically as $par. This parameter is the subpage component of the current title. For example, if someone follows a link to Special:MyExtension/blah, $par will contain "blah".

OutputPage.php[edit]

The global variable $wgOut (of type OutputPage) is the variable you will use the most, because it is the way to send output to the browser (no, you don't use echo or print). If you want to use it somewhere, declare the variable global:

function randomFunction() {
	global $wgOut;
	$wgOut->addHTML('<b>This is not a pipe...</b>');
}

You can inspect the OutputPage class by viewing includes/OutputPage.php (indeed, all of these can be inspected), but there are a few methods you should definitely know about.

OutputPage->addHTML()[edit]

Essentially the quick and dirty substitute for echo. It takes your input and adds it to the buffer: no questions asked. In the below action, if $action contains user-data, it could easily have XSS, evil stuff, or the spawn of Satan injected in. You're better off using escaping (such as with the php function htmlentities) or the XML builders class to build trusted output.

$wgOut->addHTML('<form action="'.$action.'" method="post">');

OutputPage->addWikiText()[edit]

For most output, you should be using this function. It's a bit of a black magic function: wikitext goes in, HTML comes out, and a whole lotta arcane code and demon summonings happen in between.

$wgOut->addWikiText("This is some ''lovely'' [[wikitext]] that will '''get''' parsed nicely.");

What's worth noting is that the parser will view your chunks as cohesive wholes and paragraph accordingly. That is...

$wgOut->addWikiText('* Item 1');
$wgOut->addWikiText('* Item 2');
$wgOut->addWikiText('* Item 3');

Will output three lists with one item each, which probably wasn't intended.

Warning Warning: If your special page is intended to be included in other pages, you should probably not use addWikiText() (or any other function that calls the parser). Due to a bug in MediaWiki (Bug 16129), an included special page will mess up any inclusion before it on the same including page, showing strings like UNIQ10842e596cbb71da.
workaround #1[edit]

As a workaround, you can have your extensions convert Wikitext to HTML using a separate Parser object and then use addHTML(). Example:

$wgOut->addHTML(sandboxParse("Here's some '''formatted''' text."));
function sandboxParse($wikiText) {
	global $wgTitle, $wgUser;
	$myParser = new Parser();
	$myParserOptions = new ParserOptions();
	$myParserOptions->initialiseFromUser($wgUser);
	$result = $myParser->parse($wikiText, $wgTitle, $myParserOptions);
	return $result->getText();
}
workaround #2[edit]

I tried the above, and found that the same problem now applied to any <tag>s in the transcluded text. This won't be a problem for a lot of extensions, but the extension I was writing was intended to show wikitext from another page as part of its functionality, so this was a problem.

The process for parsing a page which transcludes a special page seems to be this:

  1. Replace {{Special:MyExtension}} with a UNIQ-QINU marker (because SpecialPage output is expected to be ready-to-output HTML)
  2. Replace any <tag>s with QINU markers as above
  3. Parse everything else from wikitext to HTML
  4. Replace all QINU markers with their respective stored values, in a single pass

The process for parsing a page which transcludes a non-special page, though, is apparently like this:

  1. Replace {{:Normal Article Name}} or {{Template Name}} with contents of transcluded page (because transcluded pages contain unparsed wikitext)
  2. Replace any <tag>s with QINU markers as above
  3. Parse everything else from wikitext to HTML
  4. Replace all QINU markers with their respective stored values, in a single pass

The problem is apparently that in the earlier case, the parsing of the SpecialPage's wiki text is lacking the final QINU decoding step (why?), so all the QINU markers are left undecoded. (This may be a leftover from using the same syntax to invoke transclusion of a wikitext page, which is just pasted straight into the host page's wikitext contents and parsed, as is used to invoke transclusion of a SpecialPage, which must not be parsed at all. Wherever the code is that decides "wait, this is a special page -- replace it with a QINU", it should be doing the extra unstripGeneral before doing the QINU substitution.)

So I just did the following -- after this line:

$htOut = $wgParser->recursiveTagParse($iText);

...I added these lines (the second one is only because the function definition for the first one recommends it):

$htOut = $wgParser->mStripState->unstripGeneral($htOut);
$htOut = $wgParser->mStripState->unstripNoWiki($htOut);

Since I have now documented this, of course, I will now find a tragic flaw with it and feel really stupid... but as long as it seems to be working, I had to note it here. (It is also important to note the problem with work-around #1.) Also, I have only tested this with MediaWiki 1.10.1. The problem still exists under MW 1.14, but this solution may or may not work. --Woozle 18:26, 9 April 2009 (UTC)

workaround #3[edit]

The following function returns a parsed string without embedded parser comments

function efParse( $wikiText ) {
	global $wgOut;
	return $wgOut->parseInline( $wikiText );
}

Tested with MediaWiki 1.15.1 and PHP 5.2.12 --Wikinaut 12:31, 15 January 2010 (UTC)

wfMsg()[edit]

In most of the real special pages, you will rarely see $wgOut->addWikitext() without wfMsg() popping in.

wfMsg() is a MediaWiki internationalization (i18n) function.

OutputPage->showErrorPage()[edit]

An error page is shown. The arguments $title and $msg specify keys into wfMsg(), not text. An example:

$wgOut->showErrorPage('error','badarticleerror');
  • 'error' refers to the text "Error".
  • 'badarticleerror' refers to the text "This action cannot be performed on this page.".

WebRequest.php[edit]

The WebRequest class is used to obtain information from the GET and POST arrays. Using this is recommended over directly accessing the superglobals, since the object does fun stuff like magic_quotes cleaning. The WebRequest object is accessible from extensions by including the global $wgRequest in the code.

WebRequest->getVal($key)[edit]

Returns a string that corresponds to the form input with the name $key.

WebRequest->get*()[edit]

Returns an int, bool, etc depending on the function called. For checkboxes for example, the function getBool is useful.

WebRequest->wasPosted()[edit]

Returns true if a form was posted.

Database.php[edit]

MediaWiki has a load of convenience functions and wrappers for interacting with the database. It also has an interesting load balancing scheme in place. It's recommended you use these wrappers. Check out Database.php for a complete listing of all the convenience functions, because these docs will only tell you about the non-obvious caveats. See Manual:Database access.

wfGetDB()[edit]

As this name suggests, this function gets you a reference of the database. There is no global that contains a database object.

When you call the function, you should pass it a parameter, the constant DB_MASTER or DB_SLAVE. Generally, you interact with the slave database when you're only performing read operations, and interact with the master when you're writing to the database. It's real easy to do, so do it, even if you only have one database.

User.php[edit]

The User class is used to represent users on the system. The global $wgUser represents the currently logged in user, and is usually what you will deal with when manipulating users.

User->isAllowed($right)[edit]

Returns true or false depending on whether the user is allowed to do $right.

User->isBlocked()[edit]

Returns true if a user is blocked.

Title.php[edit]

Title represents the name of a page in the wiki. This is useful because MediaWiki does all sorts of fun escaping and special case logic to page names, so instead of rolling your own convert title to URL function, you create a Title object with your page name, and then use escapeLocalURL() to get a URL to that page.

Title::makeTitle()[edit]

Title->escapeLocalURL()[edit]

FAQ[edit]

Menyetel Nama Ekstensi[edit]

MediaWiki does not set the title of the extension, which is the developer's job. It will look for the name of the extension when Special:Specialpages is called or the special page is loaded (specifically right before the registered wfSpecial*() function is called). Use $wgOut to title the extension like: $wgOut->setPagetitle("your title");

The place where the extension can be found (as specified by what is passed into the SpecialPage constructor) is the key--except that it is not capitalized because of getDescription(), the internally used function that finds out the title (or, what they call description) of the special page, strtolower the name. "ThisIsACoolSpecialPage"'s key would be "thisisacoolspecialpage."

Theoretically, getDescription can be overloaded in order to avoid interacting with the message cache but, as the source code states: "Derived classes can override this, but usually it is easier to keep the default behavior. Messages can be added at run-time--see MessageCache.php". Furthermore, this prevents the MediaWiki namespace from overloading the message, as below.

Melokalkan Nama Ekstensi[edit]

So you've just installed a shiny new MediaWiki extension and realize: "Oh no, my wiki is in French, but the page is showing up as English!" Most people wouldn't care, but it's actually a quite simple task to fix (as long as the developer used the method explained on this page). No noodling around in source code. Let's say the name of the page is DirtyPages and the name comes out to "List of Dirty Pages" but you want it to be (and excuse my poor French) "Liste de Pages Sales". Well, it's as simple as this:

  1. Navigate to MediaWiki:DirtyPages, this page may not exist, but edit it anyway
  2. Insert "Liste de Pages Sales" and save

And voilà (pardon the pun), the change is applied.

This is also useful for customizing the title for your wiki within your language: for instance, the developer called it "List of Dirty Pages" but you don't like that name, so you rename it "List of Pages needing Cleanup". Check out Special:Allmessages to learn more.

Also, if your extension has a large block of text that does change, like a warning, don't directly output the text. Instead, add it to the message cache and when the time comes to output the text in your code, do this:

$wgOut->addWikiText( wfMsg( 'dirtypageshelp' ) );

Then this message too can be customized at MediaWiki:Dirtypageshelp.

See also Help:System message.

Membatasi laman hanya untuk pengurus dan pengguna lain dengan hak khusus[edit]

Some special pages are omitted from the special page list unless the user has particular rights, such as being a sysop. To restrict your special page similarly, set the restriction parameter in the constructor. A typical sysop right is editinterface:

function __construct() {
	parent::__construct( 'MyExtension', 'editinterface' ); // restrict to sysops
}

Or you can create your own right in the setup file and assign it to sysops, e.g.:

$wgGroupPermissions['sysop']['myright'] = true;
$wgAvailableRights[] = 'myright';

and then call the constructor with your right:

function __construct() {
	parent::__construct( 'MyExtension', 'myright' );
}

Even if you restrict your page, your extension should check that the proper right is present, in case a user can somehow access it directly:

function execute( $par ) {
	// ...
	global $wgUser;
	if ( !$this->userCanExecute($wgUser) ) {
		$this->displayRestrictionError();
		return;
	}
	// ...
}

Menonaktifkan laman Special:UserLogin dan Special:UserLogout[edit]

In LocalSettings.php you can use the SpecialPage_initList hook to unset unwanted built-in special pages. See "making a few SpecialPages restricted" if you need conditional unsetting of special pages for example for certain user groups. The general message "You have requested an invalid special page." is shown if users try to access such unset special pages.

function disableSomeSpecialPages(&$list) {
	unset($list['Userlogout']);
	unset($list['Userlogin']);
	return true;
}
$wgHooks['SpecialPage_initList'][]='disableSomeSpecialPages';


ManualManual:Contents FAQManual:FAQInstallation guideManual:Installation guideSystem administrationManual:System administration
EkstensiManual:Extensions: Ekstensi tagManual:Tag extensionsParser functionsManual:Parser functionsPengaitManual:HooksLaman istimewaManual:Special pagesKulitManual:SkinsMagic wordsManual:Magic words
Bahasa:Project:Language policy English  • Deutsch • Bahasa Indonesia • 日本語 • русский • 中文