ApiLogout.php

Go to the documentation of this file.

<?php
class ApiLogout extends ApiBase {

        public function execute() {
                $user = $this->getUser();
                $oldName = $user->getName();
                $user->logout();

                // Give extensions to do something after user logout
                $injected_html = '';
                wfRunHooks( 'UserLogoutComplete', array( &$user, &$injected_html, $oldName ) );
        }

        public function isReadMode() {
                return false;
        }

        public function getAllowedParams() {
                return array();
        }

        public function getResultProperties() {
                return array();
        }

        public function getParamDescription() {
                return array();
        }

        public function getDescription() {
                return 'Log out and clear session data';
        }

        public function getExamples() {
                return array(
                        'api.php?action=logout' => 'Log the current user out',
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Logout';
        }
}