4 * Removes all users from a given user group.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
25 use MediaWiki\User\User
;
27 require_once __DIR__
. '/Maintenance.php';
29 class EmptyUserGroup
extends Maintenance
{
30 public function __construct() {
31 parent
::__construct();
32 $this->addDescription( 'Remove all users from a given user group' );
33 $this->addArg( 'group', 'Group to be removed', true );
34 $this->setBatchSize( 100 );
37 public function execute() {
38 $group = $this->getArg( 0 );
39 $userGroupManager = $this->getServiceContainer()->getUserGroupManager();
42 $this->output( "Removing users from $group...\n" );
44 $users = User
::findUsersByGroup( $group, $this->getBatchSize() );
45 if ( iterator_count( $users ) === 0 ) {
49 foreach ( $users as $user ) {
50 $totalCount +
= (int)$userGroupManager->removeUserFromGroup( $user, $group );
52 $this->waitForReplication();
55 $this->output( " ...done! Removed $totalCount users in total.\n" );
57 $this->output( " ...nothing to do, group was empty.\n" );
62 $maintClass = EmptyUserGroup
::class;
63 require_once RUN_MAINTENANCE_IF_MAIN
;