if ( $user->isBlocked() ) {
$status = SpecialBlock::checkUnblockSelf( $params['user'], $user );
if ( $status !== true ) {
- $this->dieUsageMsg( $status );
+ $msg = $this->parseMsg( $status );
+ $this->dieUsage(
+ $msg['info'],
+ $msg['code'],
+ 0,
+ [ 'blockinfo' => ApiQueryUserInfo::getBlockInfo( $user->getBlock() ) ]
+ );
}
}
- $data = array(
+ // Check if user can add tags
+ if ( !is_null( $params['tags'] ) ) {
+ $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
+ if ( !$ableToTag->isOK() ) {
+ $this->dieStatus( $ableToTag );
+ }
+ }
+
+ $data = [
'Target' => is_null( $params['id'] ) ? $params['user'] : "#{$params['id']}",
- 'Reason' => $params['reason']
- );
+ 'Reason' => $params['reason'],
+ 'Tags' => $params['tags']
+ ];
$block = Block::newFromTarget( $data['Target'] );
$retval = SpecialUnblock::processUnblock( $data, $this->getContext() );
if ( $retval !== true ) {
}
public function getAllowedParams() {
- return array(
- 'id' => array(
+ return [
+ 'id' => [
ApiBase::PARAM_TYPE => 'integer',
- ),
+ ],
'user' => null,
'reason' => '',
- );
- }
-
- public function getParamDescription() {
- $p = $this->getModulePrefix();
-
- return array(
- 'id' => "ID of the block you want to unblock (obtained through list=blocks). " .
- "Cannot be used together with {$p}user",
- 'user' => "Username, IP address or IP range you want to unblock. " .
- "Cannot be used together with {$p}id",
- 'reason' => 'Reason for unblock',
- );
- }
-
- public function getDescription() {
- return 'Unblock a user.';
+ 'tags' => [
+ ApiBase::PARAM_TYPE => 'tags',
+ ApiBase::PARAM_ISMULTI => true,
+ ],
+ ];
}
public function needsToken() {
return 'csrf';
}
- public function getExamples() {
- return array(
- 'api.php?action=unblock&id=105',
- 'api.php?action=unblock&user=Bob&reason=Sorry%20Bob'
- );
+ protected function getExamplesMessages() {
+ return [
+ 'action=unblock&id=105'
+ => 'apihelp-unblock-example-id',
+ 'action=unblock&user=Bob&reason=Sorry%20Bob'
+ => 'apihelp-unblock-example-user',
+ ];
}
public function getHelpUrls() {