API:Users

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki PHP action API documentation.
MediaWiki APIsAPI:Main page

MediaWiki PHP action API

v · d · e

Get information about a list of users. This module cannot be used as a generator. This module is implemented by ApiQueryUsers.php.

Parameters[edit | edit source]

  • ususers: A list of user names to get information for
  • ustoken: Which tokens to get 1.16+ (deprecated in 1.24)
  • usprop: Which properties to get (Default: none)
    • blockinfo: Whether the user is blocked, by whom and why
    • groups: All groups the user belongs to
    • implicitgroups: All groups a user is automatically a member of 1.18+
    • rights: All rights the user has 1.17+
    • editcount: The number of edits the user has made
    • registration: The time and date the user registered at 1.13+
    • emailable: Whether the user can and wants to receive e-mail through Special:Emailuser 1.14+
    • gender: Tags the gender of the user. Returns "male", "female", or "unknown" 1.16+

Example[edit | edit source]

Getting information about a list of users

Error Codes[edit | edit source]

None