Go to the documentation of this file.
55 parent::__construct(
'Block',
'block' );
69 parent::checkExecutePermissions(
$user );
70 # T17810: blocked admins should have limited access here
92 # Extract variables from the request. Try not to get into a situation where we
93 # need to extract *every* variable from the form just for processing here, but
94 # there are legitimate uses for some variables
97 if ( $this->target instanceof
User ) {
98 # Set the 'relevant user' in the skin, so it displays links like Contributions,
99 # User logs, UserRights, etc.
100 $this->
getSkin()->setRelevantUser( $this->target );
103 list( $this->previousTarget, ) =
105 $this->requestedHideUser =
$request->getBool(
'wpHideUser' );
117 $msg = $this->alreadyBlocked ?
'ipb-change-block' :
'ipbsubmit';
122 # Don't need to do anything if the form has been posted
123 if ( !$this->
getRequest()->wasPosted() && $this->preErrors ) {
128 [
'class' =>
'error' ],
153 $enablePartialBlocks = $conf->get(
'EnablePartialBlocks' );
161 'id' =>
'mw-bi-target',
165 'validation-callback' => [ __CLASS__,
'validateTargetField' ],
166 'section' =>
'target',
171 'label-message' =>
'block-prevent-edit',
173 'section' =>
'actions',
174 'disabled' => $enablePartialBlocks ?
false :
true,
177 if ( $enablePartialBlocks ) {
178 $a[
'EditingRestriction'] = [
180 'cssclass' =>
'mw-block-editing-restriction',
182 $this->
msg(
'ipb-sitewide' )->escaped() .
183 new \OOUI\LabelWidget( [
184 'classes' => [
'oo-ui-inline-help' ],
185 'label' => $this->
msg(
'ipb-sitewide-help' )->
text(),
187 $this->
msg(
'ipb-partial' )->escaped() .
188 new \OOUI\LabelWidget( [
189 'classes' => [
'oo-ui-inline-help' ],
190 'label' => $this->
msg(
'ipb-partial-help' )->
text(),
193 'section' =>
'actions',
195 $a[
'PageRestrictions'] = [
196 'type' =>
'titlesmultiselect',
197 'label' => $this->
msg(
'ipb-pages-label' )->text(),
200 'cssclass' =>
'mw-block-restriction',
201 'showMissing' =>
false,
202 'excludeDynamicNamespaces' =>
true,
204 'autocomplete' =>
false
206 'section' =>
'actions',
208 $a[
'NamespaceRestrictions'] = [
209 'type' =>
'namespacesmultiselect',
210 'label' => $this->
msg(
'ipb-namespaces-label' )->text(),
212 'cssclass' =>
'mw-block-restriction',
214 'autocomplete' =>
false
216 'section' =>
'actions',
220 $a[
'CreateAccount'] = [
222 'label-message' =>
'ipbcreateaccount',
224 'section' =>
'actions',
227 if ( self::canBlockEmail(
$user ) ) {
228 $a[
'DisableEmail'] = [
230 'label-message' =>
'ipbemailban',
231 'section' =>
'actions',
236 $a[
'DisableUTEdit'] = [
238 'label-message' =>
'ipb-disableusertalk',
240 'section' =>
'actions',
247 'options' => $suggestedDurations,
248 'default' => $this->
msg(
'ipb-default-expiry' )->inContentLanguage()->text(),
249 'section' =>
'expiry',
253 'type' =>
'selectandother',
258 'maxlength-unit' =>
'codepoints',
259 'options-message' =>
'ipbreason-dropdown',
260 'section' =>
'reason',
265 'label-message' =>
'ipbenableautoblock',
267 'section' =>
'options',
270 # Allow some users to hide name from block log, blocklist and listusers
271 if (
$user->isAllowed(
'hideuser' ) ) {
274 'label-message' =>
'ipbhidename',
275 'cssclass' =>
'mw-block-hideuser',
276 'section' =>
'options',
280 # Watchlist their user page? (Only if user is logged in)
281 if (
$user->isLoggedIn() ) {
284 'label-message' =>
'ipbwatchuser',
285 'section' =>
'options',
291 'label-message' =>
'ipb-hardblock',
293 'section' =>
'options',
296 # This is basically a copy of the Target field, but the user can't change it, so we
297 # can see if the warnings we maybe showed to the user before still apply
298 $a[
'PreviousTarget'] = [
303 # We'll turn this into a checkbox if we need to
307 'label-message' =>
'ipb-confirm',
308 'cssclass' =>
'mw-block-confirm',
314 Hooks::run(
'SpecialBlockModifyFormFields', [ $this, &$a ] );
325 # This will be overwritten by request data
326 $fields[
'Target'][
'default'] = (
string)$this->target;
328 if ( $this->target ) {
331 $errors =
$status->getErrorsArray();
332 $this->preErrors = array_merge( $this->preErrors, $errors );
337 $fields[
'PreviousTarget'][
'default'] = (
string)$this->target;
347 $fields[
'HardBlock'][
'default'] = $block->isHardblock();
348 $fields[
'CreateAccount'][
'default'] = $block->isCreateAccountBlocked();
349 $fields[
'AutoBlock'][
'default'] = $block->isAutoblocking();
351 if ( isset( $fields[
'DisableEmail'] ) ) {
352 $fields[
'DisableEmail'][
'default'] = $block->isEmailBlocked();
355 if ( isset( $fields[
'HideUser'] ) ) {
356 $fields[
'HideUser'][
'default'] = $block->getHideName();
359 if ( isset( $fields[
'DisableUTEdit'] ) ) {
360 $fields[
'DisableUTEdit'][
'default'] = !$block->isUsertalkEditAllowed();
365 if ( !$block->getHideName() || $this->
getUser()->isAllowed(
'hideuser' ) ) {
366 $fields[
'Reason'][
'default'] = $block->getReason();
368 $fields[
'Reason'][
'default'] =
'';
372 # Ok, so we got a POST submission asking us to reblock a user. So show the
373 # confirm checkbox; the user will only see it if they haven't previously
374 $fields[
'Confirm'][
'type'] =
'check';
376 # We got a target, but it wasn't a POST request, so the user must have gone
377 # to a link like [[Special:Block/User]]. We don't need to show the checkbox
378 # as long as they go ahead and block *that* user
379 $fields[
'Confirm'][
'default'] = 1;
382 if ( $block->getExpiry() ==
'infinity' ) {
383 $fields[
'Expiry'][
'default'] =
'infinite';
385 $fields[
'Expiry'][
'default'] =
wfTimestamp( TS_RFC2822, $block->getExpiry() );
388 $this->alreadyBlocked =
true;
389 $this->preErrors[] = [
'ipb-needreblock',
wfEscapeWikiText( (
string)$block->getTarget() ) ];
392 if ( $this->alreadyBlocked || $this->
getRequest()->wasPosted()
393 || $this->
getRequest()->getCheck(
'wpCreateAccount' )
395 $this->
getOutput()->addJsConfigVars(
'wgCreateAccountDirty',
true );
398 # We always need confirmation to do HideUser
399 if ( $this->requestedHideUser ) {
400 $fields[
'Confirm'][
'type'] =
'check';
401 unset( $fields[
'Confirm'][
'default'] );
402 $this->preErrors[] = [
'ipb-confirmhideuser',
'ipb-confirmaction' ];
405 # Or if the user is trying to block themselves
407 $fields[
'Confirm'][
'type'] =
'check';
408 unset( $fields[
'Confirm'][
'default'] );
409 $this->preErrors[] = [
'ipb-blockingself',
'ipb-confirmaction' ];
412 if ( $this->
getConfig()->
get(
'EnablePartialBlocks' ) ) {
414 $fields[
'EditingRestriction'][
'default'] =
'partial';
416 $fields[
'EditingRestriction'][
'default'] =
'sitewide';
419 if ( $block instanceof
Block ) {
420 $pageRestrictions = [];
421 $namespaceRestrictions = [];
422 foreach ( $block->getRestrictions()
as $restriction ) {
423 switch ( $restriction->getType() ) {
424 case PageRestriction::TYPE:
425 if ( $restriction->getTitle() ) {
426 $pageRestrictions[] = $restriction->getTitle()->getPrefixedText();
429 case NamespaceRestriction::TYPE:
430 $namespaceRestrictions[] = $restriction->getValue();
436 !$block->isSitewide() &&
437 empty( $pageRestrictions ) &&
438 empty( $namespaceRestrictions )
440 $fields[
'Editing'][
'default'] =
false;
444 sort( $pageRestrictions );
445 $fields[
'PageRestrictions'][
'default'] = implode(
"\n", $pageRestrictions );
446 sort( $namespaceRestrictions );
447 $fields[
'NamespaceRestrictions'][
'default'] = implode(
"\n", $namespaceRestrictions );
458 'mediawiki.widgets.TagMultiselectWidget.styles',
461 $this->
getOutput()->addModules( [
'mediawiki.special.block' ] );
463 $blockCIDRLimit = $this->
getConfig()->get(
'BlockCIDRLimit' );
464 $text = $this->
msg(
'blockiptext', $blockCIDRLimit[
'IPv4'], $blockCIDRLimit[
'IPv6'] )->parse();
466 $otherBlockMessages = [];
467 if ( $this->target !==
null ) {
469 if ( $this->target instanceof
User ) {
470 $targetName = $this->target->
getName();
472 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
473 Hooks::run(
'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
475 if (
count( $otherBlockMessages ) ) {
476 $s = Html::rawElement(
479 $this->
msg(
'ipb-otherblocks-header',
count( $otherBlockMessages ) )->parse()
484 foreach ( $otherBlockMessages
as $link ) {
485 $list .= Html::rawElement(
'li', [],
$link ) .
"\n";
488 $s .= Html::rawElement(
490 [
'class' =>
'mw-blockip-alreadyblocked' ],
508 $this->
getOutput()->addModuleStyles(
'mediawiki.special' );
511 # Link to the user's contributions, if applicable
512 if ( $this->target instanceof
User ) {
516 $this->
msg(
'ipb-blocklist-contribs', $this->target->getName() )->
text()
520 # Link to unblock the specified user, or to a blank unblock form
521 if ( $this->target instanceof
User ) {
522 $message = $this->
msg(
528 $message = $this->
msg(
'ipb-unblock' )->parse();
536 # Link to the block list
539 $this->
msg(
'ipb-blocklist' )->
text()
544 # Link to edit the block dropdown reasons, if applicable
545 if (
$user->isAllowed(
'editinterface' ) ) {
547 $this->
msg(
'ipbreason-dropdown' )->inContentLanguage()->
getTitle(),
548 $this->
msg(
'ipb-edit-dropdown' )->
text(),
550 [
'action' =>
'edit' ]
554 $text = Html::rawElement(
556 [
'class' =>
'mw-ipb-conveniencelinks' ],
562 # Get relevant extracts from the block and suppression logs, if possible
572 'msgKey' => [
'blocklog-showlog', $userTitle->getText() ],
573 'showIfEmpty' =>
false
578 # Add suppression block entries if allowed
579 if (
$user->isAllowed(
'suppressionlog' ) ) {
587 'conds' => [
'log_action' => [
'block',
'reblock',
'unblock' ] ],
588 'msgKey' => [
'blocklog-showsuppresslog', $userTitle->getText() ],
589 'showIfEmpty' =>
false
632 # The HTMLForm will check wpTarget first and only if it doesn't get
633 # a value use the default, which will be generated from the options
634 # below; so this has to have a higher precedence here than $par, or
635 # we could end up with different values in $this->target and the HTMLForm!
660 if (
$type !==
null ) {
665 return [
null,
null ];
679 $errors =
$status->getErrorsArray();
681 return $form->msg( ...$errors[0] );
711 if ( $unblockStatus !==
true ) {
712 $status->fatal(
'badaccess', $unblockStatus );
722 $status->fatal(
'range_block_disabled' );
730 $status->fatal(
'ip_range_invalid' );
743 $status->fatal(
'badipaddress' );
760 $enablePartialBlocks =
$context->getConfig()->get(
'EnablePartialBlocks' );
761 $isPartialBlock = $enablePartialBlocks &&
762 isset(
$data[
'EditingRestriction'] ) &&
763 $data[
'EditingRestriction'] ===
'partial';
768 # This might have been a hidden field or a checkbox, so interesting data
770 $data[
'Confirm'] = !in_array(
$data[
'Confirm'], [
'',
'0',
null,
false ],
true );
777 $userId =
$user->getId();
779 # Give admins a heads-up before they go and block themselves. Much messier
780 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
781 # permission anyway, although the code does allow for it.
782 # Note: Important to use $target instead of $data['Target']
783 # since both $data['PreviousTarget'] and $target are normalized
784 # but $data['target'] gets overridden by (non-normalized) request variable
785 # from previous request.
789 return [
'ipb-blockingself',
'ipb-confirmaction' ];
799 # This should have been caught in the form field validation
800 return [
'badipaddress' ];
807 ( strlen(
$data[
'Expiry'] ) == 0 ) ||
809 ( strlen(
$data[
'Expiry'] ) > 50 ) ||
813 return [
'ipb_expiry_invalid' ];
819 return [
'ipb_expiry_old' ];
822 if ( !isset(
$data[
'DisableEmail'] ) ) {
823 $data[
'DisableEmail'] =
false;
826 # If the user has done the form 'properly', they won't even have been given the
827 # option to suppress-block unless they have the 'hideuser' permission
828 if ( !isset(
$data[
'HideUser'] ) ) {
829 $data[
'HideUser'] =
false;
832 if (
$data[
'HideUser'] ) {
833 if ( !$performer->isAllowed(
'hideuser' ) ) {
834 # this codepath is unreachable except by a malicious user spoofing forms,
835 # or by race conditions (user has hideuser and block rights, loads block form,
836 # and loses hideuser rights before submission); so need to fail completely
837 # rather than just silently disable hiding
838 return [
'badaccess-group0' ];
841 if ( $isPartialBlock ) {
842 return [
'ipb_hide_partial' ];
845 # Recheck params here...
847 $data[
'HideUser'] =
false; #
IP users should
not be hidden
850 return [
'ipb_expiry_temp' ];
854 # Typically, the user should have a handful of edits.
855 # Disallow hiding users with many edits for performance.
856 return [ [
'ipb_hide_invalid',
858 } elseif ( !
$data[
'Confirm'] ) {
859 return [
'ipb-confirmhideuser',
'ipb-confirmaction' ];
863 # Create block object.
864 $block =
new Block();
866 $block->setBlocker( $performer );
867 $block->setReason(
$data[
'Reason'][0] );
869 $block->isCreateAccountBlocked(
$data[
'CreateAccount'] );
871 $block->isEmailBlocked(
$data[
'DisableEmail'] );
872 $block->isHardblock(
$data[
'HardBlock'] );
873 $block->isAutoblocking(
$data[
'AutoBlock'] );
874 $block->setHideName(
$data[
'HideUser'] );
876 if ( $isPartialBlock ) {
877 $block->isSitewide(
false );
880 $reason = [
'hookaborted' ];
881 if ( !
Hooks::run(
'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
885 $pageRestrictions = [];
886 $namespaceRestrictions = [];
887 if ( $enablePartialBlocks ) {
888 if (
$data[
'PageRestrictions'] !==
'' ) {
889 $pageRestrictions = array_map(
function ( $text ) {
896 }, explode(
"\n",
$data[
'PageRestrictions'] ) );
898 if (
$data[
'NamespaceRestrictions'] !==
'' ) {
899 $namespaceRestrictions = array_map(
function ( $id ) {
901 }, explode(
"\n",
$data[
'NamespaceRestrictions'] ) );
904 $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
905 $block->setRestrictions( $restrictions );
909 # Try to insert block. Is there a conflicting block?
912 # Indicates whether the user is confirming the block and is aware of
913 # the conflict (did not change the block target in the meantime)
914 $blockNotConfirmed = !
$data[
'Confirm'] || ( array_key_exists(
'PreviousTarget',
$data )
917 # Special case for API - T34434
918 $reblockNotAllowed = ( array_key_exists(
'Reblock',
$data ) && !
$data[
'Reblock'] );
920 # Show form unless the user is already aware of this...
921 if ( $blockNotConfirmed || $reblockNotAllowed ) {
922 return [ [
'ipb_already_blocked', $block->getTarget() ] ];
923 # Otherwise, try to update the block...
925 # This returns direct blocks before autoblocks/rangeblocks, since we should
926 # be sure the user is blocked by now it should work for our purposes
928 if ( $block->equals( $currentBlock ) ) {
929 return [ [
'ipb_already_blocked', $block->getTarget() ] ];
931 # If the name was hidden and the blocking user cannot hide
932 # names, then don't allow any block changes...
933 if ( $currentBlock->getHideName() && !$performer->isAllowed(
'hideuser' ) ) {
934 return [
'cant-see-hidden-user' ];
937 $priorBlock = clone $currentBlock;
938 $currentBlock->isHardblock( $block->isHardblock() );
939 $currentBlock->isCreateAccountBlocked( $block->isCreateAccountBlocked() );
940 $currentBlock->setExpiry( $block->getExpiry() );
941 $currentBlock->isAutoblocking( $block->isAutoblocking() );
942 $currentBlock->setHideName( $block->getHideName() );
943 $currentBlock->isEmailBlocked( $block->isEmailBlocked() );
944 $currentBlock->isUsertalkEditAllowed( $block->isUsertalkEditAllowed() );
945 $currentBlock->setReason( $block->getReason() );
947 if ( $enablePartialBlocks ) {
950 $currentBlock->isSitewide( $block->isSitewide() );
953 $blockRestrictionStore = MediaWikiServices::getInstance()->getBlockRestrictionStore();
954 $currentBlock->setRestrictions(
955 $blockRestrictionStore->setBlockId( $currentBlock->getId(), $restrictions )
959 $status = $currentBlock->update();
962 $logaction =
'reblock';
964 # Unset _deleted fields if requested
965 if ( $currentBlock->getHideName() && !
$data[
'HideUser'] ) {
969 # If hiding/unhiding a name, this should go in the private logs
970 if ( (
bool)$currentBlock->getHideName() ) {
971 $data[
'HideUser'] =
true;
974 $block = $currentBlock;
977 $logaction =
'block';
980 Hooks::run(
'BlockIpComplete', [ $block, $performer, $priorBlock ] );
982 # Set *_deleted fields if requested
983 if (
$data[
'HideUser'] ) {
987 # Can't watch a rangeblock
996 # Block constructor sanitizes certain block options on insert
997 $data[
'BlockEmail'] = $block->isEmailBlocked();
998 $data[
'AutoBlock'] = $block->isAutoblocking();
1000 # Prepare log parameters
1002 $logParams[
'5::duration'] =
$data[
'Expiry'];
1004 $logParams[
'sitewide'] = $block->isSitewide();
1006 if ( $enablePartialBlocks && !$block->isSitewide() ) {
1007 if (
$data[
'PageRestrictions'] !==
'' ) {
1008 $logParams[
'7::restrictions'][
'pages'] = explode(
"\n",
$data[
'PageRestrictions'] );
1011 if (
$data[
'NamespaceRestrictions'] !==
'' ) {
1012 $logParams[
'7::restrictions'][
'namespaces'] = explode(
"\n",
$data[
'NamespaceRestrictions'] );
1016 # Make log entry, if the name is hidden, put it in the suppression log
1017 $log_type =
$data[
'HideUser'] ?
'suppress' :
'block';
1020 $logEntry->setComment(
$data[
'Reason'][0] );
1021 $logEntry->setPerformer( $performer );
1022 $logEntry->setParameters( $logParams );
1023 # Relate log ID to block ID (T27763)
1024 $logEntry->setRelations( [
'ipb_id' => $block->getId() ] );
1025 $logId = $logEntry->insert();
1027 if ( !empty(
$data[
'Tags'] ) ) {
1028 $logEntry->setTags(
$data[
'Tags'] );
1031 $logEntry->publish( $logId );
1048 $msg =
$lang ===
null
1049 ?
wfMessage(
'ipboptions' )->inContentLanguage()->text()
1052 if ( $msg ==
'-' ) {
1056 foreach ( explode(
',', $msg )
as $option ) {
1057 if ( strpos( $option,
':' ) ===
false ) {
1058 $option =
"$option:$option";
1061 list( $show,
$value ) = explode(
':', $option );
1065 if ( $a && $includeOther ) {
1068 $a[
wfMessage(
'ipbother' )->text() ] =
'other';
1090 $expiry = strtotime( $expiry );
1092 if ( $expiry < 0 || $expiry ===
false ) {
1127 } elseif ( is_string(
$target ) ) {
1132 # User is trying to unblock themselves
1133 if ( $performer->
isAllowed(
'unblockself' ) ) {
1135 # User blocked themselves and is now trying to reverse it
1139 return 'ipbnounblockself';
1155 # User is trying to block/unblock someone else
1156 return 'ipbblocked';
1173 $blockAllowsUTEdit = $config->get(
'BlockAllowsUTEdit' );
1177 # when blocking a user the option 'anononly' is not available/has no effect
1178 # -> do not write this into log
1181 $flags[] =
'anononly';
1184 if (
$data[
'CreateAccount'] ) {
1186 $flags[] =
'nocreate';
1189 # Same as anononly, this is not displayed when blocking an IP address
1192 $flags[] =
'noautoblock';
1195 if (
$data[
'DisableEmail'] ) {
1197 $flags[] =
'noemail';
1200 if ( $blockAllowsUTEdit &&
$data[
'DisableUTEdit'] ) {
1202 $flags[] =
'nousertalk';
1205 if (
$data[
'HideUser'] ) {
1207 $flags[] =
'hiddenname';
1210 return implode(
',', $flags );
1222 if ( isset(
$data[
'Editing'] ) &&
$data[
'Editing'] ===
false ) {
1223 $data[
'EditingRestriction'] =
'partial';
1224 $data[
'PageRestrictions'] =
'';
1225 $data[
'NamespaceRestrictions'] =
'';
1236 $out->setPageTitle( $this->
msg(
'blockipsuccesssub' ) );
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
return true to allow those checks to and false if checking is done & $user
static newFromId( $id)
Static factory method for creation from a given user ID.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Marks HTML that shouldn't be escaped.
msg( $key)
Wrapper around wfMessage that sets the current context.
getType()
Get the type of target for this particular block.
processing should stop and the error should be shown to the user * false
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
getId()
Get the user's ID.
$wgSysopEmailBans
Allow sysops to ban users from accessing Emailuser.
isAnon()
Get whether the user is anonymous.
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
int $type
Block::TYPE_ constant.
getOutput()
Get the OutputPage being used for this instance.
$wgBlockAllowsUTEdit
Set this to true to allow blocked users to edit their own user talk page.
if(!isset( $args[0])) $lang
static checkUnblockSelf( $target, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to ...
getTitle( $subpage=false)
Get a self-referential title object.
bool $requestedHideUser
Whether the previous submission of the form asked for HideUser.
static processForm(array $data, IContextSource $context)
Given the form data, actually implement a block.
preText()
Add header elements like block log entries, etc.
static canBlockEmail( $user)
Can we do an email block?
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
User string null $target
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo...
User string $previousTarget
The previous block target.
$wgEnableUserEmail
Set to true to enable user-to-user e-mail.
A collection of public static functions to play with IP address and IP ranges.
onSubmit(array $data, HTMLForm $form=null)
Process the form on POST submission.
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
Special page which uses an HTMLForm to handle processing.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
getUserPage()
Get this user's personal page title.
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,...
getSkin()
Shortcut to get the skin being used for this instance.
static unsuppressUserName( $name, $userId, IDatabase $dbw=null)
doesWrites()
Indicates whether this special page may perform database writes.
getLanguage()
Shortcut to get user's language.
checkExecutePermissions(User $user)
Checks that the user can unblock themselves if they are trying to do so.
getName()
Get the name of this Special Page.
$wgHideUserContribLimit
The maximum number of edits a user can have and can still be hidden by users with the hideuser permis...
setParameter( $par)
Handle some magic here.
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
postText()
Add footer elements to the form.
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
$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.
getConfig()
Shortcut to get main config object.
namespace and then decline to actually register it file or subcat img or subcat $title
static parseTarget( $target)
From an existing Block, get the target and the type of target.
maybeAlterFormDefaults(&$fields)
If the user has already been blocked with similar settings, load that block and change the defaults f...
alterForm(HTMLForm $form)
Customizes the HTMLForm a bit.
A special page that allows users with 'block' right to block users from editing pages and other actio...
static getTargetUserTitle( $target)
Get a user page target for things like logs.
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
getUser()
Shortcut to get the User executing this instance.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getBlock( $fromReplica=true)
Get the block affecting the user, or null if the user is not blocked.
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))
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
string null $par
The sub-page of the special page.
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 null
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
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
static newGood( $value=null)
Factory function for good results.
wfIsInfinity( $str)
Determine input string is represents as infinity.
getRequest()
Get the WebRequest being used for this instance.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
isSitewide( $x=null)
Indicates that the block is a sitewide block.
getFormFields()
Get the HTMLForm descriptor array for the block form.
static getMain()
Get the RequestContext object associated with the main request.
blockedBy()
If user is blocked, return the name of the user who placed the block.
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Interface for objects which can provide a MediaWiki context on request.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$wgBlockCIDRLimit
Limits on the possible sizes of range blocks.
static validateTargetField( $value, $alldata, $form)
HTMLForm field validation-callback for Target field.
static validateTarget( $value, User $user)
Validate a block target.
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
getDisplayFormat()
Get display format for the form.
static parseExpiryInput( $expiry)
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034",...
isBlocked( $fromReplica=true)
Check if user is blocked.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
static getSuggestedDurations(Language $lang=null, $includeOther=true)
Get an array of suggested block durations from MediaWiki:Ipboptions.
Class for creating new log entries and inserting them into the database.
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
static suppressUserName( $name, $userId, IDatabase $dbw=null)
MediaWiki Linker LinkRenderer null $linkRenderer
static blockLogFlags(array $data, $type)
Return a comma-delimited list of "flags" to be passed to the log reader for this block,...
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.
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
getName()
Get the user name, or the IP of an anonymous user.
Internationalisation code.
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
isAllowed( $action='')
Internal mechanics of testing a permission.
requiresUnblock()
We allow certain special cases where user is blocked.