3 * Copyright © 2008 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Session\BotPasswordSessionProvider
;
26 * API module to allow users to log out of the wiki. API equivalent of
31 class ApiLogout
extends ApiBase
{
33 public function execute() {
34 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
36 // Handle bot password logout specially
37 if ( $session->getProvider() instanceof BotPasswordSessionProvider
) {
38 $session->unpersist();
42 // Make sure it's possible to log out
43 if ( !$session->canSetUser() ) {
46 'cannotlogoutnow-text',
47 $session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() )
53 $user = $this->getUser();
54 $oldName = $user->getName();
57 // Give extensions to do something after user logout
59 Hooks
::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
62 public function isReadMode() {
66 protected function getExamplesMessages() {
69 => 'apihelp-logout-example-logout',
73 public function getHelpUrls() {
74 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout';