Go to the documentation of this file.
84 self::getTitleValueFor(
$name, $subpage, $fragment )
98 $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
99 getLocalNameFor(
$name, $subpage );
112 $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
113 getLocalNameFor(
$name, $subpage );
139 $name =
'', $restriction =
'', $listed =
true,
140 $function =
false,
$file =
'', $includable =
false
142 $this->mName =
$name;
143 $this->mRestriction = $restriction;
144 $this->mListed = $listed;
145 $this->mIncludable = $includable;
181 return wfSetVar( $this->mListed, $listed );
191 return wfSetVar( $this->mListed, $x );
229 return wfSetVar( $this->mIncluding, $x );
237 if ( !isset( $this->mLocalName ) ) {
238 $this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
239 getLocalNameFor( $this->mName );
291 return $user->isAllowed( $this->mRestriction );
340 $reasonMsg =
'exception-nologin-text', $titleMsg =
'exception-nologin'
342 if ( $this->
getUser()->isAnon() ) {
401 $level = $level ?: $this->
getName();
402 $key =
'SpecialPage:reauth:' . $this->
getName();
405 $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
406 if ( $securityStatus === AuthManager::SEC_OK ) {
407 $uniqueId =
$request->getVal(
'postUniqueId' );
409 $key .=
':' . $uniqueId;
411 $data = $session->getSecret( $key );
413 $session->remove( $key );
418 } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
420 $queryParams =
$request->getQueryValues();
427 $key .=
':' . $uniqueId;
428 $queryParams[
'postUniqueId'] = $uniqueId;
431 $session->setSecret( $key,
$data );
436 'returnto' => $this->
getFullTitle()->getPrefixedDBkey(),
437 'returntoquery' =>
wfArrayToCgi( array_diff_key( $queryParams, [
'title' =>
true ] ) ),
446 $titleMessage =
wfMessage(
'specialpage-securitylevel-not-allowed-title' );
447 $errorMessage =
wfMessage(
'specialpage-securitylevel-not-allowed' );
502 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
503 $searchEngine->setLimitOffset( $limit, $offset );
504 $searchEngine->setNamespaces( [] );
505 $result = $searchEngine->defaultPrefixSearch( $search );
506 return array_map(
function (
Title $t ) {
507 return $t->getPrefixedText();
523 $escaped = preg_quote( $search,
'/' );
524 return array_slice( preg_grep(
"/^$escaped/i",
525 array_slice( $subpages, $offset ) ), 0, $limit );
533 $out->setArticleRelated(
false );
536 if ( $this->
getConfig()->
get(
'UseMediaWikiUIEverywhere' ) ) {
537 $out->addModuleStyles( [
538 'mediawiki.ui.input',
539 'mediawiki.ui.radio',
540 'mediawiki.ui.checkbox',
552 final public function run( $subPage ) {
562 if ( !
Hooks::run(
'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
580 Hooks::run(
'SpecialPageAfterExecute', [ $this, $subPage ] );
634 if ( $summaryMessageKey ==
'' ) {
635 $msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->
getName() ) .
638 $msg = $summaryMessageKey;
640 if ( !$this->
msg( $msg )->isDisabled() && !$this->
including() ) {
642 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
656 return $this->
msg( strtolower( $this->mName ) )->text();
702 wfDebug( __METHOD__ .
" called and \$mContext is null. " .
703 "Return RequestContext::getMain(); for sanity\n" );
786 return 'noindex,nofollow';
796 public function msg( $key ) {
797 $message = $this->
getContext()->msg( ...func_get_args() );
803 $message->setInterfaceMessageFlag(
false );
817 foreach ( $this->
getConfig()->
get(
'FeedClasses' )
as $format => $class ) {
818 $theseParams =
$params + [
'feedformat' => $format ];
820 $this->
getOutput()->addFeedLink( $format, $url );
838 MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->
getName() ) .
841 if ( !$msg->isDisabled() ) {
843 $this->
getOutput()->addHelpLink( $helpUrl,
true );
845 $this->
getOutput()->addHelpLink( $to, $overrideBaseUrl );
861 $msg = $this->
msg(
'specialpages-specialpagegroup-' . strtolower(
$name ) )->inContentLanguage();
862 if ( !$msg->isBlank() ) {
863 $group = $msg->text();
909 if ( $this->linkRenderer ) {
912 return MediaWikiServices::getInstance()->getLinkRenderer();
935 array $query = [], $atend =
false, $subpage =
false
939 # Make 'previous' link
940 $prev = $this->
msg(
'prevn' )->numParams( $limit )->text();
942 $plink = $this->
numLink( max( $offset - $limit, 0 ), $limit,
$query,
943 $prev,
'prevn-title',
'mw-prevlink', $subpage );
945 $plink = htmlspecialchars( $prev );
949 $next = $this->
msg(
'nextn' )->numParams( $limit )->text();
951 $nlink = htmlspecialchars( $next );
953 $nlink = $this->
numLink( $offset + $limit, $limit,
954 $query, $next,
'nextn-title',
'mw-nextlink', $subpage );
957 # Make links to set number of items per page
959 foreach ( [ 20, 50, 100, 250, 500 ]
as $num ) {
961 $lang->formatNum( $num ),
'shown-title',
'mw-numlink', $subpage );
964 return $this->
msg(
'viewprevnext' )->rawParams( $plink, $nlink,
$lang->pipeList( $numLinks ) )->
981 $tooltipMsg, $class, $subpage =
false
983 $query = [
'limit' => $limit,
'offset' => $offset ] +
$query;
984 $tooltip = $this->
msg( $tooltipMsg )->numParams( $limit )->text();
986 return Html::element(
'a', [
'href' => $href,
987 'title' => $tooltip,
'class' => $class ],
$link );
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
getPageTitle( $subpage=false)
Get a self-referential title object.
getFinalGroupName()
Get the group that the special page belongs in on Special:SpecialPage Use this method,...
return true to allow those checks to and false if checking is done & $user
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Some internal bits split of from Skin.php.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
msg( $key)
Wrapper around wfMessage that sets the current context.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
getOutput()
Get the OutputPage being used for this instance.
isExpensive()
Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in ...
if(!isset( $args[0])) $lang
getTitle( $subpage=false)
Get a self-referential title object.
maxIncludeCacheTime()
How long to cache page when it is being included.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Redirect a user to the login page.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
setReauthPostData(array $data)
Record preserved POST data after a reauthentication.
__construct( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
Default constructor for special pages Derivative classes should call this from their constructor Note...
displayRestrictionError()
Output an error message telling the user what access level they have to have.
setListed( $listed)
Set whether this page is listed in Special:Specialpages, at run-time.
wfReadOnly()
Check whether the wiki is in read-only mode.
getLocalName()
Get the localised name of the special page.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
IContextSource $mContext
Current request context.
getSkin()
Shortcut to get the skin being used for this instance.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Show an error when a user tries to do something they do not have the necessary permissions for.
getLanguage()
Shortcut to get user's language.
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
getName()
Get the name of this Special Page.
isListed()
Whether this special page is listed in Special:SpecialPages.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Interface for localizing messages in MediaWiki.
getRestriction()
Get the permission that a user must have to execute this page.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
static getSafeTitleFor( $name, $subpage=false)
Get a localised Title object for a page name with a possibly unvalidated subpage.
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
getConfig()
Shortcut to get main config object.
namespace and then decline to actually register it file or subcat img or subcat $title
addFeedLinks( $params)
Adds RSS/atom links.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
checkLoginSecurityLevel( $level=null)
Verifies that the user meets the security level, possibly reauthenticating them in the process.
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
numLink( $offset, $limit, array $query, $link, $tooltipMsg, $class, $subpage=false)
Helper function for buildPrevNextNavigation() that generates links.
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
getFullTitle()
Return the full title, including $par.
isRestricted()
Can be overridden by subclasses with more complicated permissions schemes.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getUser()
Shortcut to get the User executing this instance.
isIncludable()
Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
afterExecute( $subPage)
Gets called after.
beforeExecute( $subPage)
Gets called before.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getContext()
Gets the context this SpecialPage is executed in.
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
setLinkRenderer(LinkRenderer $linkRenderer)
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Allows to change the fields on the form that will be generated $name
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
getRobotPolicy()
Return the robot policy.
static prefixSearchArray( $search, $limit, array $subpages, $offset)
Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as op...
Parent class for all special pages.
listed( $x=null)
Get or set whether this special page is listed in Special:SpecialPages.
buildPrevNextNavigation( $offset, $limit, array $query=[], $atend=false, $subpage=false)
Generate (prev x| next x) (20|50|100...) type links for paging.
isCached()
Is this page cached? Expensive pages are cached or disabled in miser mode.
getRequest()
Get the WebRequest being used for this instance.
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
static getMain()
Get the RequestContext object associated with the main request.
run( $subPage)
Entry point.
execute( $subPage)
Default execute method Checks user permissions.
Interface for objects which can provide a MediaWiki context on request.
Represents a title within MediaWiki.
static makeUrl( $name, $urlaction='')
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept for prefix searches.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
setContext( $context)
Sets the context this SpecialPage is executed in.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
doesWrites()
Indicates whether this special page may perform database writes.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
MediaWiki Linker LinkRenderer null $linkRenderer
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
An error page which can definitely be safely rendered using the OutputPage.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
including( $x=null)
Whether the special page is being evaluated via transclusion.
Represents a page (or page fragment) title within MediaWiki.
static newFromTitleValue(TitleValue $titleValue, $forceClone='')
Returns a Title given a TitleValue.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....