BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
User Class Reference
Inheritance diagram for User:
Collaboration diagram for User:

Public Member Functions

 __construct ()
 
 __toString ()
 
 isSafeToLoad ()
 
 load ($flags=self::READ_NORMAL)
 
 loadFromId ($flags=self::READ_NORMAL)
 
 getMutableCacheKeys (WANObjectCache $cache)
 
 isIPRange ()
 
 isValidPassword ($password)
 
 getPasswordValidity ($password)
 
 checkPasswordValidity ($password)
 
 loadDefaults ($name=false)
 
 isItemLoaded ($item, $all= 'all')
 
 loadFromDatabase ($flags=self::READ_LATEST)
 
 addAutopromoteOnceGroups ($event)
 
 clearInstanceCache ($reloadFrom=false)
 
 isDnsBlacklisted ($ip, $checkWhitelist=false)
 
 inDnsBlacklist ($ip, $bases)
 
 isPingLimitable ()
 
 pingLimiter ($action= 'edit', $incrBy=1)
 
 isBlocked ($bFromSlave=true)
 
 getBlock ($bFromSlave=true)
 
 isBlockedFrom ($title, $bFromSlave=false)
 
 blockedBy ()
 
 blockedFor ()
 
 getBlockId ()
 
 isBlockedGlobally ($ip= '')
 
 getGlobalBlock ($ip= '')
 
 isLocked ()
 
 isHidden ()
 
 getId ()
 
 setId ($v)
 
 getName ()
 
 setName ($str)
 
 getActorId (IDatabase $dbw=null)
 
 getTitleKey ()
 
 getNewtalk ()
 
 getNewMessageLinks ()
 
 setNewtalk ($val, $curRev=null)
 
 clearSharedCache ($mode= 'changed')
 
 invalidateCache ()
 
 touch ()
 
 validateCache ($timestamp)
 
 getTouched ()
 
 getDBTouched ()
 
 setPassword ($str)
 
 setInternalPassword ($str)
 
 changeAuthenticationData (array $data)
 
 getToken ($forceCreation=true)
 
 setToken ($token=false)
 
 setNewpassword ($str, $throttle=true)
 
 getEmail ()
 
 getEmailAuthenticationTimestamp ()
 
 setEmail ($str)
 
 setEmailWithConfirmation ($str)
 
 getRealName ()
 
 setRealName ($str)
 
 getOption ($oname, $defaultOverride=null, $ignoreHidden=false)
 
 getOptions ($flags=0)
 
 getBoolOption ($oname)
 
 getIntOption ($oname, $defaultOverride=0)
 
 setOption ($oname, $val)
 
 getTokenFromOption ($oname)
 
 resetTokenFromOption ($oname)
 
 getOptionKinds (IContextSource $context, $options=null)
 
 resetOptions ($resetKinds=[ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused'], IContextSource $context=null)
 
 getDatePreference ()
 
 requiresHTTPS ()
 
 getStubThreshold ()
 
 getRights ()
 
 getGroups ()
 
 getGroupMemberships ()
 
 getEffectiveGroups ($recache=false)
 
 getAutomaticGroups ($recache=false)
 
 getFormerGroups ()
 
 getEditCount ()
 
 addGroup ($group, $expiry=null)
 
 removeGroup ($group)
 
 isLoggedIn ()
 
 isAnon ()
 
 isBot ()
 
 isAllowedAny ()
 
 isAllowedAll ()
 
 isAllowed ($action= '')
 
 useRCPatrol ()
 
 useNPPatrol ()
 
 useFilePatrol ()
 
 getRequest ()
 
 isWatched ($title, $checkRights=self::CHECK_USER_RIGHTS)
 
 addWatch ($title, $checkRights=self::CHECK_USER_RIGHTS)
 
 removeWatch ($title, $checkRights=self::CHECK_USER_RIGHTS)
 
 clearNotification (&$title, $oldid=0)
 
 clearAllNotifications ()
 
 getExperienceLevel ()
 
 setCookies ($request=null, $secure=null, $rememberMe=false)
 
 logout ()
 
 doLogout ()
 
 saveSettings ()
 
 idForName ($flags=0)
 
 addToDatabase ()
 
 spreadAnyEditBlock ()
 
 isBlockedFromCreateAccount ()
 
 isBlockedFromEmailuser ()
 
 isAllowedToCreateAccount ()
 
 getUserPage ()
 
 getTalkPage ()
 
 isNewbie ()
 
 checkPassword ($password)
 
 checkTemporaryPassword ($plaintext)
 
 getEditTokenObject ($salt= '', $request=null)
 
 getEditToken ($salt= '', $request=null)
 
 matchEditToken ($val, $salt= '', $request=null, $maxage=null)
 
 matchEditTokenNoSuffix ($val, $salt= '', $request=null, $maxage=null)
 
 sendConfirmationMail ($type= 'created')
 
 sendMail ($subject, $body, $from=null, $replyto=null)
 
 confirmEmail ()
 
 invalidateEmail ()
 
 setEmailAuthenticationTimestamp ($timestamp)
 
 canSendEmail ()
 
 canReceiveEmail ()
 
 isEmailConfirmed ()
 
 isEmailConfirmationPending ()
 
 getRegistration ()
 
 getFirstEditTimestamp ()
 
 changeableGroups ()
 
 incEditCount ()
 
 incEditCountImmediate ()
 
 addNewUserLogEntry ($action=false, $reason= '')
 
 addNewUserLogEntryAutoCreate ()
 
 getInstanceForUpdate ()
 
 equals (User $user)
 
- Public Member Functions inherited from MediaWiki\User\UserIdentity
 getActorId ()
 

Static Public Member Functions

static purge ($wikiId, $userId)
 
static whoIs ($id)
 
static whoIsReal ($id)
 
static idFromName ($name, $flags=self::READ_NORMAL)
 
static resetIdByNameCache ()
 
static isIP ($name)
 
static isValidUserName ($name)
 
static isUsableName ($name)
 
static findUsersByGroup ($groups, $limit=5000, $after=null)
 
static isCreatableName ($name)
 
static getCanonicalName ($name, $validate= 'valid')
 
static randomPassword ()
 
static getDefaultOptions ()
 
static getDefaultOption ($opt)
 
static isLocallyBlockedProxy ($ip)
 
static listOptionKinds ()
 
static createNew ($name, $params=[])
 
static getGroupPermissions ($groups)
 
static getGroupsWithPermission ($role)
 
static groupHasPermission ($group, $role)
 
static isEveryoneAllowed ($right)
 
static getGroupName ($group)
 
static getGroupMember ($group, $username= '#')
 
static getAllGroups ()
 
static getAllRights ()
 
static getImplicitGroups ()
 
static getGroupPage ($group)
 
static makeGroupLinkHTML ($group, $text= '')
 
static makeGroupLinkWiki ($group, $text= '')
 
static changeableByGroup ($group)
 
static getRightDescription ($right)
 
static getGrantName ($grant)
 
static selectFields ()
 
static getQueryInfo ()
 
static newFatalPermissionDeniedStatus ($permission)
 
newFrom*() static factory methods
static newFromName ($name, $validate= 'valid')
 
static newFromId ($id)
 
static newFromActorId ($id)
 
static newFromAnyId ($userId, $userName, $actorId)
 
static newFromConfirmationCode ($code, $flags=0)
 
static newFromSession (WebRequest $request=null)
 
static newFromRow ($row, $data=null)
 
static newSystemUser ($name, $options=[])
 

Public Attributes

const TOKEN_LENGTH = 32
 
const INVALID_TOKEN = '*** INVALID ***'
 
const EDIT_TOKEN_SUFFIX = Token::SUFFIX
 
const VERSION = 12
 
const GETOPTIONS_EXCLUDE_DEFAULTS = 1
 
const CHECK_USER_RIGHTS = true
 
const IGNORE_USER_RIGHTS = false
 
 $mFrom
 
 $mBlockedby
 
 $mRights
 
 $mHideName
 
 $mOptions
 
 $mBlock
 
- Public Attributes inherited from IDBAccessObject
const READ_NORMAL = 0
 
const READ_LATEST = 1
 
const READ_LOCKING = 3
 
const READ_EXCLUSIVE = 7
 
const READ_LATEST_IMMUTABLE = 8
 
const READ_NONE = -1
 

Static Public Attributes

static $idCacheByName = []
 

Protected Member Functions

 getCacheKey (WANObjectCache $cache)
 
 loadFromCache ()
 
 setItemLoaded ($item)
 
 loadFromRow ($row, $data=null)
 
 loadFromUserObject ($user)
 
 makeUpdateConditions (Database $db, array $conditions)
 
 checkAndSetTouched ()
 
 getBlockFromCookieValue ($blockCookieVal)
 
 checkNewtalk ($field, $id)
 
 updateNewtalk ($field, $id, $curRev=null)
 
 deleteNewtalk ($field, $id)
 
 spreadBlock ()
 
 confirmationToken (&$expiration)
 
 confirmationTokenUrl ($token)
 
 invalidationTokenUrl ($token)
 
 getTokenUrl ($page, $token)
 
 initEditCount ($add=0)
 
 loadOptions ($data=null)
 
 saveOptions ()
 

Protected Attributes

 $mNewtalk
 
 $mDatePreference
 
 $mHash
 
 $mBlockreason
 
 $mEffectiveGroups
 
 $mImplicitGroups
 
 $mFormerGroups
 
 $mGlobalBlock
 
 $mLocked
 
 $mAllowUsertalk
 
 $queryFlagsUsed = self::READ_NORMAL
 

Static Protected Attributes

static $mCacheVars
 
static $mCoreRights
 
static $mAllRights = false
 
 $mId
 
 $mName
 
 $mRealName
 
 $mEmail
 
 $mTouched
 
 $mEmailAuthenticated
 
 $mActorId
 
 $mQuickTouched
 
 $mToken
 
 $mEmailToken
 
 $mEmailTokenExpires
 
 $mRegistration
 
 $mEditCount
 
 $mGroupMemberships
 
 $mOptionOverrides
 
 $mOptionsLoaded
 
 $mLoadedItems = []
 

Detailed Description

The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time). Client classes use the getXXX() functions to access these fields. These functions do all the work of determining whether the user is logged in, whether the requested option can be satisfied from cookies or whether a database query is needed. Most of the settings needed for rendering normal pages are set in the cookie to minimize use of the database.

Constructor & Destructor Documentation

User::__construct ( )

Lightweight constructor for an anonymous user. Use the User::newFrom* factory functions for other kinds of users.

See Also
newFromName()
newFromId()
newFromActorId()
newFromConfirmationCode()
newFromSession()
newFromRow()

Member Function Documentation

User::__toString ( )
Returns
string
User::addAutopromoteOnceGroups (   $event)

Add the user to the group if he/she meets given criteria.

Contrary to autopromotion by $wgAutopromote, the group will be possible to remove manually via Special:UserRights. In such case it will not be re-added automatically. The user will also not lose the group if they no longer meet the criteria.

Parameters
string$eventKey in $wgAutopromoteOnce (each one has groups/criteria)
Returns
array Array of groups the user has been promoted to.
See Also
$wgAutopromoteOnce
User::addGroup (   $group,
  $expiry = null 
)

Add the user to the given group. This takes immediate effect. If the user is already in the group, the expiry time will be updated to the new expiry time. (If $expiry is omitted or null, the membership will be altered to never expire.)

Parameters
string$groupName of the group to add
string$expiryOptional expiry timestamp in any format acceptable to wfTimestamp(), or null if the group assignment should not expire
Returns
bool
User::addNewUserLogEntry (   $action = false,
  $reason = '' 
)

Add a newuser log entry for this user. Before 1.19 the return value was always true.

Deprecated:
since 1.27, AuthManager handles logging
Parameters
string | bool$actionAccount creation type.
  • String, one of the following values:
    • 'create' for an anonymous user creating an account for himself. This will force the action's performer to be the created user itself, no matter the value of $wgUser
    • 'create2' for a logged in user creating an account for someone else
    • 'byemail' when the created user will receive its password by e-mail
    • 'autocreate' when the user is automatically created (such as by CentralAuth).
  • Boolean means whether the account was created by e-mail (deprecated):
    • true will be converted to 'byemail'
    • false will be converted to 'create' if this object is the same as $wgUser and to 'create2' otherwise
string$reasonUser supplied reason
Returns
bool true
User::addNewUserLogEntryAutoCreate ( )

Add an autocreate newuser log entry for this user Used by things like CentralAuth and perhaps other authplugins. Consider calling addNewUserLogEntry() directly instead.

Deprecated:
since 1.27, AuthManager handles logging
Returns
bool
User::addToDatabase ( )

Add this existing user object to the database. If the user already exists, a fatal status object is returned, and the user object is initialised with the data from the database.

Previously, this function generated a DB error due to a key conflict if the user already existed. Many extension callers use this function in code along the lines of:

$user = User::newFromName( $name ); if ( !$user->isLoggedIn() ) { $user->addToDatabase(); } // do something with $user...

However, this was vulnerable to a race condition (T18020). By initialising the user object if the user exists, we aim to support this calling sequence as far as possible.

Note that if the user exists, this function will acquire a write lock, so it is still advisable to make the call conditional on isLoggedIn(), and to commit the transaction after calling.

Exceptions
MWException
Returns
Status
User::addWatch (   $title,
  $checkRights = self::CHECK_USER_RIGHTS 
)

Watch an article.

Since
1.22 $checkRights parameter added
Parameters
Title$titleTitle of the article to look at
bool$checkRightsWhether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
User::blockedBy ( )

If user is blocked, return the name of the user who placed the block

Returns
string Name of blocker
User::blockedFor ( )

If user is blocked, return the specified reason for the block

Returns
string Blocking reason
User::canReceiveEmail ( )

Is this user allowed to receive e-mails within limits of current site configuration?

Returns
bool
User::canSendEmail ( )

Is this user allowed to send e-mails within limits of current site configuration?

Returns
bool
static User::changeableByGroup (   $group)
static

Returns an array of the groups that a particular group can add/remove.

Parameters
string$groupThe group to check for whether it can add/remove
Returns
array Array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ), 'add-self' => array( addablegroups to self), 'remove-self' => array( removable groups from self) )
User::changeableGroups ( )

Returns an array of groups that this user can add and remove

Returns
array Array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ), 'add-self' => array( addablegroups to self), 'remove-self' => array( removable groups from self) )
User::changeAuthenticationData ( array  $data)

Changes credentials of the user.

This is a convenience wrapper around AuthManager::changeAuthenticationData. Note that this can return a status that isOK() but not isGood() on certain types of failures, e.g. when no provider handled the change.

Parameters
array$dataA set of authentication data in fieldname => value format. This is the same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
Returns
Status
Since
1.27
User::checkAndSetTouched ( )
protected

Bump user_touched if it didn't change since this object was loaded

On success, the mTouched field is updated. The user serialization cache is always cleared.

Returns
bool Whether user_touched was actually updated
Since
1.26
User::checkNewtalk (   $field,
  $id 
)
protected

Internal uncached check for new messages

See Also
getNewtalk()
Parameters
string$field'user_ip' for anonymous users, 'user_id' otherwise
string | int$idUser's IP address for anonymous users, User ID otherwise
Returns
bool True if the user has new messages
User::checkPassword (   $password)

Check to see if the given clear-text password is one of the accepted passwords

Deprecated:
since 1.27, use AuthManager instead
Parameters
string$passwordUser password
Returns
bool True if the given password is correct, otherwise False
User::checkPasswordValidity (   $password)

Check if this is a valid password for this user

Create a Status object based on the password's validity. The Status should be set to fatal if the user should not be allowed to log in, and should have any errors that would block changing the password.

If the return value of this is not OK, the password should not be checked. If the return value is not Good, the password can be checked, but the user should not be able to set their password to this.

Parameters
string$passwordDesired password
Returns
Status
Since
1.23
User::checkTemporaryPassword (   $plaintext)

Check if the given clear-text password matches the temporary password sent by e-mail for password reset operations.

Deprecated:
since 1.27, use AuthManager instead
Parameters
string$plaintext
Returns
bool True if matches, false otherwise
User::clearAllNotifications ( )

Resets all of the given user's page-change notification timestamps. If e-notif e-mails are on, they will receive notification mails on the next change of any watched page.

Note
If the user doesn't have 'editmywatchlist', this will do nothing.
User::clearInstanceCache (   $reloadFrom = false)

Clear various cached data stored in this object. The cache of the user table data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.

Parameters
bool | string$reloadFromReload user and user_groups table data from a given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
User::clearNotification ( $title,
  $oldid = 0 
)

Clear the user's notification timestamp for the given title. If e-notif e-mails are on, they will receive notification mails on the next change of the page if it's watched etc.

Note
If the user doesn't have 'editmywatchlist', this will do nothing.
Parameters
Title&$titleTitle of the article to look at
int$oldidThe revision id being viewed. If not given or 0, latest revision is assumed.
User::clearSharedCache (   $mode = 'changed')

Clear user data from memcached

Use after applying updates to the database; caller's responsibility to update user_touched if appropriate.

Called implicitly from invalidateCache() and saveSettings().

Parameters
string$modeUse 'refresh' to clear now; otherwise before DB commit
User::confirmationToken ( $expiration)
protected

Generate, store, and return a new e-mail confirmation code. A hash (unsalted, since it's used as a key) is stored.

Note
Call saveSettings() after calling this function to commit this change to the database.
Parameters
string&$expirationAccepts the expiration time
Returns
string New token
User::confirmationTokenUrl (   $token)
protected

Return a URL the user can use to confirm their email address.

Parameters
string$tokenAccepts the email confirmation token
Returns
string New token URL
User::confirmEmail ( )

Mark the e-mail address confirmed.

Note
Call saveSettings() after calling this function to commit the change.
Returns
bool
static User::createNew (   $name,
  $params = [] 
)
static

Add a user to the database, return the user object

Parameters
string$nameUsername to add
array$paramsArray of Strings Non-default parameters to save to the database as user_* fields:
  • email: The user's email address.
  • email_authenticated: The email authentication timestamp.
  • real_name: The user's real name.
  • options: An associative array of non-default options.
  • token: Random authentication token. Do not set.
  • registration: Registration timestamp. Do not set.
Returns
User|null User object, or null if the username already exists.
User::deleteNewtalk (   $field,
  $id 
)
protected

Clear the new messages flag for the given user

Parameters
string$field'user_ip' for anonymous users, 'user_id' otherwise
string | int$idUser's IP address for anonymous users, User ID otherwise
Returns
bool True if successful, false otherwise
User::doLogout ( )

Clear the user's session, and reset the instance cache.

See Also
logout()
User::equals ( User  $user)

Checks if two user objects point to the same user.

Since
1.25
Parameters
User$user
Returns
bool
static User::findUsersByGroup (   $groups,
  $limit = 5000,
  $after = null 
)
static

Return the users who are members of the given group(s). In case of multiple groups, users who are members of at least one of them are returned.

Parameters
string | array$groupsA single group name or an array of group names
int$limitMax number of users to return. The actual limit will never exceed 5000 records; larger values are ignored.
int$afterID the user to start after
Returns
UserArrayFromResult
User::getActorId ( IDatabase  $dbw = null)

Get the user's actor ID.

Since
1.31
Parameters
IDatabase | null$dbwAssign a new actor ID, using this DB handle, if none exists
Returns
int The actor's ID, or 0 if no actor ID exists and $dbw was null
static User::getAllGroups ( )
static

Return the set of defined explicit groups. The implicit groups (by default *, 'user' and 'autoconfirmed') are not included, as they are defined automatically, not in the database.

Returns
array Array of internal group names
static User::getAllRights ( )
static

Get a list of all available permissions.

Returns
string[] Array of permission names
User::getAutomaticGroups (   $recache = false)

Get the list of implicit group memberships this user has. This includes 'user' if logged in, '*' for all accounts, and autopromoted groups

Parameters
bool$recacheWhether to avoid the cache
Returns
array Array of String internal group names
User::getBlock (   $bFromSlave = true)

Get the block affecting the user, or null if the user is not blocked

Parameters
bool$bFromSlaveWhether to check the replica DB instead of the master
Returns
Block|null
User::getBlockFromCookieValue (   $blockCookieVal)
protected

Try to load a Block from an ID given in a cookie value.

Parameters
string | null$blockCookieValThe cookie value to check.
Returns
Block|bool The Block object, or false if none could be loaded.
User::getBlockId ( )

If user is blocked, return the ID for the block

Returns
int Block ID
User::getBoolOption (   $oname)

Get the user's current setting for a given option, as a boolean value.

Parameters
string$onameThe option to check
Returns
bool User's current value for the option
See Also
getOption()
User::getCacheKey ( WANObjectCache  $cache)
protected
Since
1.27
Parameters
WANObjectCache$cache
Returns
string
static User::getCanonicalName (   $name,
  $validate = 'valid' 
)
static

Given unvalidated user input, return a canonical username, or false if the username is invalid.

Parameters
string$nameUser input
string | bool$validateType of validation to use:
  • false No validation
  • 'valid' Valid for batch processes
  • 'usable' Valid for batch processes and login
  • 'creatable' Valid for batch processes, login and account creation
Exceptions
InvalidArgumentException
Returns
bool|string
User::getDatePreference ( )

Get the user's preferred date format.

Returns
string User's preferred date format
User::getDBTouched ( )

Get the user_touched timestamp field (time of last DB updates)

Returns
string TS_MW Timestamp
Since
1.26
static User::getDefaultOption (   $opt)
static

Get a given default option value.

Parameters
string$optName of option to retrieve
Returns
string Default option value
static User::getDefaultOptions ( )
static

Combine the language default options with any site-specific options and add the default language variants.

Returns
array Array of String options
User::getEditCount ( )

Get the user's edit count.

Returns
int|null Null for anonymous users
User::getEditToken (   $salt = '',
  $request = null 
)

Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.

The $salt for 'edit' and 'csrf' tokens is the default (empty string).

Since
1.19
Parameters
string | array$saltArray of Strings Optional function-specific data for hashing
WebRequest | null$requestWebRequest object to use or null to use $wgRequest
Returns
string The new edit token
User::getEditTokenObject (   $salt = '',
  $request = null 
)

Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.

Since
1.27
Parameters
string | array$saltArray of Strings Optional function-specific data for hashing
WebRequest | null$requestWebRequest object to use or null to use $wgRequest
Returns
MediaWiki The new edit token
User::getEffectiveGroups (   $recache = false)

Get the list of implicit group memberships this user has. This includes all explicit groups, plus 'user' if logged in, '*' for all accounts, and autopromoted groups

Parameters
bool$recacheWhether to avoid the cache
Returns
array Array of String internal group names
User::getEmail ( )

Get the user's e-mail address

Returns
string User's email address
User::getEmailAuthenticationTimestamp ( )

Get the timestamp of the user's e-mail authentication

Returns
string TS_MW timestamp
User::getExperienceLevel ( )

Compute experienced level based on edit count and registration date.

Returns
string 'newcomer', 'learner', or 'experienced'
User::getFirstEditTimestamp ( )

Get the timestamp of the first edit

Returns
string|bool Timestamp of first edit, or false for non-existent/anonymous user accounts.
User::getFormerGroups ( )

Returns the groups the user has belonged to.

The user may still belong to the returned groups. Compare with getGroups().

The function will not return groups the user had belonged to before MW 1.17

Returns
array Names of the groups the user has belonged to.
User::getGlobalBlock (   $ip = '')

Check if user is blocked on all wikis. Do not use for actual edit permission checks! This is intended for quick UI checks.

Parameters
string$ipIP address, uses current client if none given
Returns
Block|null Block object if blocked, null otherwise
Exceptions
FatalError
MWException
static User::getGrantName (   $grant)
static

Get the name of a given grant

Since
1.29
Parameters
string$grantGrant to query
Returns
string Localized name of the grant
static User::getGroupMember (   $group,
  $username = '#' 
)
static

Get the localized descriptive name for a member of a group, if it exists

Deprecated:
since 1.29 Use UserGroupMembership::getGroupMemberName instead
Parameters
string$groupInternal group name
string$usernameUsername for gender (since 1.19)
Returns
string Localized name for group member
User::getGroupMemberships ( )

Get the list of explicit group memberships this user has, stored as UserGroupMembership objects. Implicit groups are not included.

Returns
UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
Since
1.29
static User::getGroupName (   $group)
static

Get the localized descriptive name for a group, if it exists

Deprecated:
since 1.29 Use UserGroupMembership::getGroupName instead
Parameters
string$groupInternal group name
Returns
string Localized descriptive group name
static User::getGroupPage (   $group)
static

Get the title of a page describing a particular group

Deprecated:
since 1.29 Use UserGroupMembership::getGroupPage instead
Parameters
string$groupInternal group name
Returns
Title|bool Title of the page if it exists, false otherwise
static User::getGroupPermissions (   $groups)
static

Get the permissions associated with a given list of groups

Parameters
array$groupsArray of Strings List of internal group names
Returns
array Array of Strings List of permission key names for given groups combined
User::getGroups ( )

Get the list of explicit group memberships this user has. The implicit * and user groups are not included.

Returns
array Array of String internal group names
static User::getGroupsWithPermission (   $role)
static

Get all the groups who have a given permission

Parameters
string$roleRole to check
Returns
array Array of Strings List of internal group names with the given permission
User::getId ( )

Get the user's ID.

Returns
int The user's ID; 0 if the user is anonymous or nonexistent

Implements MediaWiki\User\UserIdentity.

static User::getImplicitGroups ( )
static

Get a list of implicit groups

Returns
array Array of Strings Array of internal group names
User::getInstanceForUpdate ( )

Get a new instance of this user that was loaded from the master via a locking read

Use this instead of the main context User when updating that user. This avoids races where that user was loaded from a replica DB or even the master but without proper locks.

Returns
User|null Returns null if the user was not found in the DB
Since
1.27
User::getIntOption (   $oname,
  $defaultOverride = 0 
)

Get the user's current setting for a given option, as an integer value.

Parameters
string$onameThe option to check
int$defaultOverrideA default value returned if the option does not exist
Returns
int User's current value for the option
See Also
getOption()
User::getMutableCacheKeys ( WANObjectCache  $cache)
Parameters
WANObjectCache$cache
Returns
string[]
Since
1.28
User::getName ( )

Get the user name, or the IP of an anonymous user

Returns
string User's name or IP address

Implements MediaWiki\User\UserIdentity.

User::getNewMessageLinks ( )

Return the data needed to construct links for new talk page message alerts. If there are new messages, this will return an associative array with the following data: wiki: The database name of the wiki link: Root-relative link to the user's talk page rev: The last talk page revision that the user has seen or null. This is useful for building diff links. If there are no new messages, it returns an empty array.

Note
This function was designed to accomodate multiple talk pages, but currently only returns a single link and revision.
Returns
array
User::getNewtalk ( )

Check if the user has new messages.

Returns
bool True if the user has new messages
User::getOption (   $oname,
  $defaultOverride = null,
  $ignoreHidden = false 
)

Get the user's current setting for a given option.

Parameters
string$onameThe option to check
string | array$defaultOverrideA default value returned if the option does not exist
bool$ignoreHiddenWhether to ignore the effects of $wgHiddenPrefs
Returns
string|array|int|null User's current value for the option
See Also
getBoolOption()
getIntOption()
User::getOptionKinds ( IContextSource  $context,
  $options = null 
)

Return an associative array mapping preferences keys to the kind of a preference they're used for. Different kinds are handled differently when setting or reading preferences.

See User::listOptionKinds for the list of valid option types that can be provided.

See Also
User::listOptionKinds
Parameters
IContextSource$context
array$optionsAssoc. array with options keys to check as keys. Defaults to $this->mOptions.
Returns
array The key => kind mapping data
User::getOptions (   $flags = 0)

Get all user's options

Parameters
int$flagsBitwise combination of: User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set to the default value. (Since 1.25)
Returns
array
User::getPasswordValidity (   $password)

Given unvalidated password input, return error message on failure.

Parameters
string$passwordDesired password
Returns
bool|string|array True on success, string or array of error message on failure
static User::getQueryInfo ( )
static

Return the tables, fields, and join conditions to be selected to create a new user object.

Since
1.31
Returns
array With three keys:
  • tables: (string[]) to include in the $table to IDatabase->select()
  • fields: (string[]) to include in the $vars to IDatabase->select()
  • joins: (array) to include in the $join_conds to IDatabase->select()
User::getRealName ( )

Get the user's real name

Returns
string User's real name
User::getRegistration ( )

Get the timestamp of account creation.

Returns
string|bool|null Timestamp of account creation, false for non-existent/anonymous user accounts, or null if existing account but information is not in database.
User::getRequest ( )

Get the WebRequest object to use with this object

Returns
WebRequest
static User::getRightDescription (   $right)
static

Get the description of a given right

Since
1.29
Parameters
string$rightRight to query
Returns
string Localized description of the right
User::getRights ( )

Get the permissions this user has.

Returns
string[] permission names
User::getStubThreshold ( )

Get the user preferred stub threshold

Returns
int
User::getTalkPage ( )

Get this user's talk page title.

Returns
Title User's talk page title
User::getTitleKey ( )

Get the user's name escaped by underscores.

Returns
string Username escaped by underscores.
User::getToken (   $forceCreation = true)

Get the user's current token.

Parameters
bool$forceCreationForce the generation of a new token if the user doesn't have one (default=true for backwards compatibility).
Returns
string|null Token
User::getTokenFromOption (   $oname)

Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes).

Parameters
string$onameThe option name to retrieve the token from
Returns
string|bool User's current value for the option, or false if this option is disabled.
See Also
resetTokenFromOption()
getOption()
Deprecated:
since 1.26 Applications should use the OAuth extension
User::getTokenUrl (   $page,
  $token 
)
protected

Internal function to format the e-mail validation/invalidation URLs. This uses a quickie hack to use the hardcoded English names of the Special: pages, for ASCII safety.

Note
Since these URLs get dropped directly into emails, using the short English names avoids insanely long URL-encoded links, which also sometimes can get corrupted in some browsers/mailers (T8957 with Gmail and Internet Explorer).
Parameters
string$pageSpecial page
string$token
Returns
string Formatted URL
User::getTouched ( )

Get the user touched timestamp

Use this value only to validate caches via inequalities such as in the case of HTTP If-Modified-Since response logic

Returns
string TS_MW Timestamp
User::getUserPage ( )

Get this user's personal page title.

Returns
Title User's personal page title
static User::groupHasPermission (   $group,
  $role 
)
static

Check, if the given group has the given permission

If you're wanting to check whether all users have a permission, use User::isEveryoneAllowed() instead. That properly checks if it's revoked from anyone.

Since
1.21
Parameters
string$groupGroup to check
string$roleRole to check
Returns
bool
User::idForName (   $flags = 0)

If only this user's username is known, and it exists, return the user ID.

Parameters
int$flagsBitfield of User:READ_* constants; useful for existence checks
Returns
int
static User::idFromName (   $name,
  $flags = self::READ_NORMAL 
)
static

Get database id given a user name

Parameters
string$nameUsername
int$flagsUser::READ_* constant bitfield
Returns
int|null The corresponding user's ID, or null if user is nonexistent
User::incEditCount ( )

Deferred version of incEditCountImmediate()

This function, rather than incEditCountImmediate(), should be used for most cases as it avoids potential deadlocks caused by concurrent editing.

User::incEditCountImmediate ( )

Increment the user's edit-count field. Will have no effect for anonymous users.

Since
1.26
User::inDnsBlacklist (   $ip,
  $bases 
)

Whether the given IP is in a given DNS blacklist.

Parameters
string$ipIP to check
string | array$basesArray of Strings: URL of the DNS blacklist
Returns
bool True if blacklisted.
User::initEditCount (   $add = 0)
protected

Initialize user_editcount from data out of the revision table

Parameters
int$addEdits to add to the count from the revision table
Returns
int Number of edits
User::invalidateCache ( )

Immediately touch the user data cache for this account

Calls touch() and removes account data from memcached

User::invalidateEmail ( )

Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed.

Note
Call saveSettings() after calling this function to commit the change.
Returns
bool Returns true
User::invalidationTokenUrl (   $token)
protected

Return a URL the user can use to invalidate their email address.

Parameters
string$tokenAccepts the email confirmation token
Returns
string New token URL
User::isAllowed (   $action = '')

Internal mechanics of testing a permission

Parameters
string$action
Returns
bool
User::isAllowedAll ( )
Parameters
string$permissions,...Permissions to test
Returns
bool True if the user is allowed to perform all of the given actions
User::isAllowedAny ( )

Check if user is allowed to access a feature / make an action

Parameters
string$permissions,...Permissions to test
Returns
bool True if user is allowed to perform any of the given actions
User::isAllowedToCreateAccount ( )

Get whether the user is allowed to create an account.

Returns
bool
User::isAnon ( )

Get whether the user is anonymous

Returns
bool
User::isBlocked (   $bFromSlave = true)

Check if user is blocked

Parameters
bool$bFromSlaveWhether to check the replica DB instead of the master. Hacked from false due to horrible probs on site.
Returns
bool True if blocked, false otherwise
User::isBlockedFrom (   $title,
  $bFromSlave = false 
)

Check if user is blocked from editing a particular article

Parameters
Title$titleTitle to check
bool$bFromSlaveWhether to check the replica DB instead of the master
Returns
bool
User::isBlockedFromCreateAccount ( )

Get whether the user is explicitly blocked from account creation.

Returns
bool|Block
User::isBlockedFromEmailuser ( )

Get whether the user is blocked from using Special:Emailuser.

Returns
bool
User::isBlockedGlobally (   $ip = '')

Check if user is blocked on all wikis. Do not use for actual edit permission checks! This is intended for quick UI checks.

Parameters
string$ipIP address, uses current client if none given
Returns
bool True if blocked, false otherwise
User::isBot ( )
Returns
bool Whether this user is flagged as being a bot role account
Since
1.28
static User::isCreatableName (   $name)
static

Usernames which fail to pass this function will be blocked from new account registrations, but may be used internally either by batch processes or by user accounts which have already been created.

Additional blacklisting may be added here rather than in isValidUserName() to avoid disrupting existing accounts.

Parameters
string$nameString to match
Returns
bool
User::isDnsBlacklisted (   $ip,
  $checkWhitelist = false 
)

Whether the given IP is in a DNS blacklist.

Parameters
string$ipIP to check
bool$checkWhitelistWhether to check the whitelist first
Returns
bool True if blacklisted.
User::isEmailConfirmationPending ( )

Check whether there is an outstanding request for e-mail confirmation.

Returns
bool
User::isEmailConfirmed ( )

Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration?

Note
If $wgEmailAuthentication is on, this may require the user to have confirmed their address by returning a code or using a password sent to the address from the wiki.
Returns
bool
static User::isEveryoneAllowed (   $right)
static

Check if all users may be assumed to have the given permission

We generally assume so if the right is granted to '*' and isn't revoked on any group. It doesn't attempt to take grants or other extension limitations on rights into account in the general case, though, as that would require it to always return false and defeat the purpose. Specifically, session-based rights restrictions (such as OAuth or bot passwords) are applied based on the current session.

Since
1.22
Parameters
string$rightRight to check
Returns
bool
User::isHidden ( )

Check if user account is hidden

Returns
bool True if hidden, false otherwise
static User::isIP (   $name)
static

Does the string match an anonymous IP address?

This function exists for username validation, in order to reject usernames which are similar in form to IP addresses. Strings such as 300.300.300.300 will return true because it looks like an IP address, despite not being strictly valid.

We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP address because the usemod software would "cloak" anonymous IP addresses like this, if we allowed accounts like this to be created new users could get the old edits of these anonymous users.

Parameters
string$nameName to match
Returns
bool
User::isIPRange ( )

Is the user an IP range?

Since
1.30
Returns
bool
User::isItemLoaded (   $item,
  $all = 'all' 
)

Return whether an item has been loaded.

Parameters
string$itemItem to check. Current possibilities:
  • id
  • name
  • realname
string$all'all' to check if the whole object has been loaded or any other string to check if only the item is available (e.g. for optimisation)
Returns
bool
static User::isLocallyBlockedProxy (   $ip)
static

Check if an IP address is in the local proxy list

Parameters
string$ip
Returns
bool
User::isLocked ( )

Check if user account is locked

Returns
bool True if locked, false otherwise
User::isLoggedIn ( )

Get whether the user is logged in

Returns
bool
User::isNewbie ( )

Determine whether the user is a newbie. Newbies are either anonymous IPs, or the most recently created accounts.

Returns
bool
User::isPingLimitable ( )

Is this user subject to rate limiting?

Returns
bool True if rate limited
User::isSafeToLoad ( )

Test if it's safe to load this User object.

You should typically check this before using $wgUser or RequestContext::getUser in a method that might be called before the system has been fully initialized. If the object is unsafe, you should use an anonymous user:

$user = $wgUser->isSafeToLoad() ? $wgUser : new User;
Since
1.27
Returns
bool
static User::isUsableName (   $name)
static

Usernames which fail to pass this function will be blocked from user login and new account registrations, but may be used internally by batch processes.

If an account already exists in this form, login will be blocked by a failure to pass this function.

Parameters
string$nameName to match
Returns
bool
User::isValidPassword (   $password)

Is the input a valid password for this user?

Parameters
string$passwordDesired password
Returns
bool
static User::isValidUserName (   $name)
static

Is the input a valid username?

Checks if the input is a valid username, we don't want an empty string, an IP address, anything that contains slashes (would mess up subpages), is longer than the maximum allowed username size or doesn't begin with a capital letter.

Parameters
string$nameName to match
Returns
bool
User::isWatched (   $title,
  $checkRights = self::CHECK_USER_RIGHTS 
)

Check the watched status of an article.

Since
1.22 $checkRights parameter added
Parameters
Title$titleTitle of the article to look at
bool$checkRightsWhether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
Returns
bool
static User::listOptionKinds ( )
static

Return a list of the types of user options currently returned by User::getOptionKinds().

Currently, the option kinds are:

  • 'registered' - preferences which are registered in core MediaWiki or by extensions using the UserGetDefaultOptions hook.
  • 'registered-multiselect' - as above, using the 'multiselect' type.
  • 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
  • 'userjs' - preferences with names starting with 'userjs-', intended to be used by user scripts.
  • 'special' - "preferences" that are not accessible via User::getOptions or User::setOptions.
  • 'unused' - preferences about which MediaWiki doesn't know anything. These are usually legacy options, removed in newer versions.

The API (and possibly others) use this function to determine the possible option types for validation purposes, so make sure to update this when a new option kind is added.

See Also
User::getOptionKinds
Returns
array Option kinds
User::load (   $flags = self::READ_NORMAL)

Load the user table data for this object from the source given by mFrom.

Parameters
int$flagsUser::READ_* constant bitfield
User::loadDefaults (   $name = false)

Set cached properties to default.

Note
This no longer clears uncached lazy-initialised properties; the constructor does that instead.
Parameters
string | bool$name
User::loadFromCache ( )
protected

Load user data from shared cache, given mId has already been set.

Returns
bool True
Since
1.25
User::loadFromDatabase (   $flags = self::READ_LATEST)

Load user and user_group data from the database. $this->mId must be set, this is how the user is identified.

Parameters
int$flagsUser::READ_* constant bitfield
Returns
bool True if the user exists, false if the user is anonymous
User::loadFromId (   $flags = self::READ_NORMAL)

Load user table data, given mId has already been set.

Parameters
int$flagsUser::READ_* constant bitfield
Returns
bool False if the ID does not exist, true otherwise
User::loadFromRow (   $row,
  $data = null 
)
protected

Initialize this object from a row from the user table.

Parameters
stdClass$rowRow from the user table to load.
array$dataFurther user data to load into the object

user_groups Array of arrays or stdClass result rows out of the user_groups table. Previously you were supposed to pass an array of strings here, but we also need expiry info nowadays, so an array of strings is ignored. user_properties Array with properties out of the user_properties table

User::loadFromUserObject (   $user)
protected

Load the data for this user object from another user object.

Parameters
User$user
User::loadOptions (   $data = null)
protected

Load the user options either from cache, the database or an array

Parameters
array$dataRows for the current user out of the user_properties table
User::logout ( )

Log this user out.

static User::makeGroupLinkHTML (   $group,
  $text = '' 
)
static

Create a link to the group in HTML, if available; else return the group name.

Deprecated:
since 1.29 Use UserGroupMembership::getLink instead, or make the link yourself if you need custom text
Parameters
string$groupInternal name of the group
string$textThe text of the link
Returns
string HTML link to the group
static User::makeGroupLinkWiki (   $group,
  $text = '' 
)
static

Create a link to the group in Wikitext, if available; else return the group name.

Deprecated:
since 1.29 Use UserGroupMembership::getLink instead, or make the link yourself if you need custom text
Parameters
string$groupInternal name of the group
string$textThe text of the link
Returns
string Wikilink to the group
User::makeUpdateConditions ( Database  $db,
array  $conditions 
)
protected

Builds update conditions. Additional conditions may be added to $conditions to protected against race conditions using a compare-and-set (CAS) mechanism based on comparing $this->mTouched with the user_touched field.

Parameters
Database$db
array$conditionsWHERE conditions for use with Database::update
Returns
array WHERE conditions for use with Database::update
User::matchEditToken (   $val,
  $salt = '',
  $request = null,
  $maxage = null 
)

Check given value against the token value stored in the session. A match should confirm that the form was submitted from the user's own login session, not a form submission from a third-party site.

Parameters
string$valInput value to compare
string | array$saltOptional function-specific data for hashing
WebRequest | null$requestObject to use or null to use $wgRequest
int$maxageFail tokens older than this, in seconds
Returns
bool Whether the token matches
User::matchEditTokenNoSuffix (   $val,
  $salt = '',
  $request = null,
  $maxage = null 
)

Check given value against the token value stored in the session, ignoring the suffix.

Parameters
string$valInput value to compare
string | array$saltOptional function-specific data for hashing
WebRequest | null$requestObject to use or null to use $wgRequest
int$maxageFail tokens older than this, in seconds
Returns
bool Whether the token matches
static User::newFatalPermissionDeniedStatus (   $permission)
static

Factory function for fatal permission-denied errors

Since
1.22
Parameters
string$permissionUser right required
Returns
Status
static User::newFromActorId (   $id)
static

Static factory method for creation from a given actor ID.

Since
1.31
Parameters
int$idValid actor ID
Returns
User The corresponding User object
static User::newFromAnyId (   $userId,
  $userName,
  $actorId 
)
static

Static factory method for creation from an ID, name, and/or actor ID

This does not check that the ID, name, and actor ID all correspond to the same user.

Since
1.31
Parameters
int | null$userIdUser ID, if known
string | null$userNameUser name, if known
int | null$actorIdActor ID, if known
Returns
User
static User::newFromConfirmationCode (   $code,
  $flags = 0 
)
static

Factory method to fetch whichever user has a given email confirmation code. This code is generated when an account is created or its e-mail address has changed.

If the code is invalid or has expired, returns NULL.

Parameters
string$codeConfirmation code
int$flagsUser::READ_* bitfield
Returns
User|null
static User::newFromId (   $id)
static

Static factory method for creation from a given user ID.

Parameters
int$idValid user ID
Returns
User The corresponding User object
static User::newFromName (   $name,
  $validate = 'valid' 
)
static

Static factory method for creation from username.

This is slightly less efficient than newFromId(), so use newFromId() if you have both an ID and a name handy.

Parameters
string$nameUsername, validated by Title::newFromText()
string | bool$validateValidate username. Takes the same parameters as User::getCanonicalName(), except that true is accepted as an alias for 'valid', for BC.
Returns
User|bool User object, or false if the username is invalid (e.g. if it contains illegal characters or is an IP address). If the username is not present in the database, the result will be a user object with a name, zero user ID and default settings.
static User::newFromRow (   $row,
  $data = null 
)
static

Create a new user object from a user row. The row should have the following fields from the user table in it:

  • either user_name or user_id to load further data if needed (or both)
  • user_real_name
  • all other fields (email, etc.) It is useless to provide the remaining fields if either user_id, user_name and user_real_name are not provided because the whole row will be loaded once more from the database when accessing them.
Parameters
stdClass$rowA row from the user table
array$dataFurther data to load into the object (see User::loadFromRow for valid keys)
Returns
User
static User::newFromSession ( WebRequest  $request = null)
static

Create a new user object using data from session. If the login credentials are invalid, the result is an anonymous user.

Parameters
WebRequest | null$requestObject to use; $wgRequest will be used if omitted.
Returns
User
static User::newSystemUser (   $name,
  $options = [] 
)
static

Static factory method for creation of a "system" user from username.

A "system" user is an account that's used to attribute logged actions taken by MediaWiki itself, as opposed to a bot or human user. Examples might include the 'Maintenance script' or 'Conversion script' accounts used by various scripts in the maintenance/ directory or accounts such as 'MediaWiki message delivery' used by the MassMessage extension.

This can optionally create the user if it doesn't exist, and "steal" the account if it does exist.

"Stealing" an existing user is intended to make it impossible for normal authentication processes to use the account, effectively disabling the account for normal use:

  • Email is invalidated, to prevent account recovery by emailing a temporary password and to disassociate the account from the existing human.
  • The token is set to a magic invalid value, to kill existing sessions and to prevent $this->setToken() calls from resetting the token to a valid value.
  • SessionManager is instructed to prevent new sessions for the user, to do things like deauthorizing OAuth consumers.
  • AuthManager is instructed to revoke access, to invalidate or remove passwords and other credentials.
Parameters
string$nameUsername
array$optionsOptions are:
  • validate: As for User::getCanonicalName(), default 'valid'
  • create: Whether to create the user if it doesn't already exist, default true
  • steal: Whether to "disable" the account for normal use if it already exists, default false
Returns
User|null
Since
1.27
User::pingLimiter (   $action = 'edit',
  $incrBy = 1 
)

Primitive rate limits: enforce maximum actions per time period to put a brake on flooding.

The method generates both a generic profiling point and a per action one (suffix being "-$action".

Note
When using a shared cache like memcached, IP-address last-hit counters will be shared across wikis.
Parameters
string$actionAction to enforce; 'edit' if unspecified
int$incrByPositive amount to increment counter by [defaults to 1]
Returns
bool True if a rate limiter was tripped
static User::purge (   $wikiId,
  $userId 
)
static
Since
1.27
Parameters
string$wikiId
int$userId
static User::randomPassword ( )
static

Return a random password.

Deprecated:
since 1.27, use PasswordFactory::generateRandomPasswordString()
Returns
string New random password
User::removeGroup (   $group)

Remove the user from the given group. This takes immediate effect.

Parameters
string$groupName of the group to remove
Returns
bool
User::removeWatch (   $title,
  $checkRights = self::CHECK_USER_RIGHTS 
)

Stop watching an article.

Since
1.22 $checkRights parameter added
Parameters
Title$titleTitle of the article to look at
bool$checkRightsWhether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
User::requiresHTTPS ( )

Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what.

Returns
bool
static User::resetIdByNameCache ( )
static

Reset the cache used in idFromName(). For use in tests.

User::resetOptions (   $resetKinds = [ 'registered',
'registered-multiselect'  ,
'registered-checkmatrix'  ,
'unused']  ,
IContextSource  $context = null 
)

Reset certain (or all) options to the site defaults

The optional parameter determines which kinds of preferences will be reset. Supported values are everything that can be reported by getOptionKinds() and 'all', which forces a reset of all preferences and overrides everything else.

Parameters
array | string$resetKindsWhich kinds of preferences to reset. Defaults to array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ) for backwards-compatibility.
IContextSource | null$contextContext source used when $resetKinds does not contain 'all', passed to getOptionKinds(). Defaults to RequestContext::getMain() when null.
User::resetTokenFromOption (   $oname)

Reset a token stored in the preferences (like the watchlist one). Does not save user's preferences (similarly to setOption()).

Parameters
string$onameThe option name to reset the token in
Returns
string|bool New token value, or false if this option is disabled.
See Also
getTokenFromOption()
setOption()
User::saveOptions ( )
protected

Saves the non-default options for this user, as previously set e.g. via setOption(), in the database's "user_properties" (preferences) table. Usually used via saveSettings().

User::saveSettings ( )

Save this user's settings into the database.

Todo:
Only rarely do all these fields need to be set!
static User::selectFields ( )
static

Return the list of user fields that should be selected to create a new user object.

Deprecated:
since 1.31, use self::getQueryInfo() instead.
Returns
array
User::sendConfirmationMail (   $type = 'created')

Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address.

Parameters
string$typeMessage to send, either "created", "changed" or "set"
Returns
Status
User::sendMail (   $subject,
  $body,
  $from = null,
  $replyto = null 
)

Send an e-mail to this user's account. Does not check for confirmed status or validity.

Parameters
string$subjectMessage subject
string$bodyMessage body
User | null$fromOptional sending user; if unspecified, default $wgPasswordSender will be used.
string$replytoReply-To address
Returns
Status
User::setCookies (   $request = null,
  $secure = null,
  $rememberMe = false 
)

Persist this user's session (e.g. set cookies)

Parameters
WebRequest | null$requestWebRequest object to use; $wgRequest will be used if null is passed.
bool$secureWhether to force secure/insecure cookies or use default
bool$rememberMeWhether to add a Token cookie for elongated sessions
User::setEmail (   $str)

Set the user's e-mail address

Parameters
string$strNew e-mail address
User::setEmailAuthenticationTimestamp (   $timestamp)

Set the e-mail authentication timestamp.

Parameters
string$timestampTS_MW timestamp
User::setEmailWithConfirmation (   $str)

Set the user's e-mail address and a confirmation mail if needed.

Since
1.20
Parameters
string$strNew e-mail address
Returns
Status
User::setId (   $v)

Set the user and reload all fields according to a given ID

Parameters
int$vUser ID to reload
User::setInternalPassword (   $str)

Set the password and reset the random token unconditionally.

Deprecated:
since 1.27, use AuthManager instead
Parameters
string | null$strNew password to set or null to set an invalid password hash meaning that the user will not be able to log in through the web interface.
User::setItemLoaded (   $item)
protected

Set that an item has been loaded

Parameters
string$item
User::setName (   $str)

Set the user name.

This does not reload fields from the database according to the given name. Rather, it is used to create a temporary "nonexistent user" for later addition to the database. It can also be used to set the IP address for an anonymous user to something other than the current remote IP.

Note
User::newFromName() has roughly the same function, when the named user does not exist.
Parameters
string$strNew user name to set
User::setNewpassword (   $str,
  $throttle = true 
)

Set the password for a password reminder or new account email

Deprecated:
Removed in 1.27. Use PasswordReset instead.
Parameters
string$strNew password to set or null to set an invalid password hash meaning that the user will not be able to use it
bool$throttleIf true, reset the throttle timestamp to the present
User::setNewtalk (   $val,
  $curRev = null 
)

Update the 'You have new messages!' status.

Parameters
bool$valWhether the user has new messages
Revision$curRevNew, as yet unseen revision of the user talk page. Ignored if null or !$val.
User::setOption (   $oname,
  $val 
)

Set the given option for a user.

You need to call saveSettings() to actually write to the database.

Parameters
string$onameThe option to set
mixed$valNew value to set
User::setPassword (   $str)

Set the password and reset the random token. Calls through to authentication plugin if necessary; will have no effect if the auth plugin refuses to pass the change through or if the legal password checks fail.

As a special case, setting the password to null wipes it, so the account cannot be logged in until a new password is set, for instance via e-mail.

Deprecated:
since 1.27, use AuthManager instead
Parameters
string$strNew password to set
Exceptions
PasswordErrorOn failure
Returns
bool
User::setRealName (   $str)

Set the user's real name

Parameters
string$strNew real name
User::setToken (   $token = false)

Set the random token (used for persistent authentication) Called from loadDefaults() among other places.

Parameters
string | bool$tokenIf specified, set the token to this value
User::spreadAnyEditBlock ( )

If this user is logged-in and blocked, block any IP address they've successfully logged in from.

Returns
bool A block was spread
User::spreadBlock ( )
protected

If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from.

Returns
bool A block was spread
User::touch ( )

Update the "touched" timestamp for the user

This is useful on various login/logout events when making sure that a browser or proxy that has multiple tenants does not suffer cache pollution where the new user sees the old users content. The value of getTouched() is checked when determining 304 vs 200 responses. Unlike invalidateCache(), this preserves the User object cache and avoids database writes.

Since
1.25
User::updateNewtalk (   $field,
  $id,
  $curRev = null 
)
protected

Add or update the new messages flag

Parameters
string$field'user_ip' for anonymous users, 'user_id' otherwise
string | int$idUser's IP address for anonymous users, User ID otherwise
Revision | null$curRevNew, as yet unseen revision of the user talk page. Ignored if null.
Returns
bool True if successful, false otherwise
User::useFilePatrol ( )

Check whether to enable new files patrol features for this user

Returns
bool True or false
User::useNPPatrol ( )

Check whether to enable new pages patrol features for this user

Returns
bool True or false
User::useRCPatrol ( )

Check whether to enable recent changes patrol features for this user

Returns
bool True or false
User::validateCache (   $timestamp)

Validate the cache for this account.

Parameters
string$timestampA timestamp in TS_MW format
Returns
bool
static User::whoIs (   $id)
static

Get the username corresponding to a given user ID

Parameters
int$idUser ID
Returns
string|bool The corresponding username
static User::whoIsReal (   $id)
static

Get the real name of a user given their user ID

Parameters
int$idUser ID
Returns
string|bool The corresponding user's real name

Member Data Documentation

User::$mAllRights = false
staticprotected

String Cached results of getAllRights()

User::$mCacheVars
staticprotected
Initial value:
= [
'mId',
'mName',
'mRealName',
'mEmail',
'mTouched',
'mToken',
'mEmailAuthenticated',
'mEmailToken',
'mEmailTokenExpires',
'mRegistration',
'mEditCount',
'mGroupMemberships',
'mOptionOverrides',
'mActorId',
]

Array of Strings List of member variables which are saved to the shared cache (memcached). Any operation which changes the corresponding database fields must call a cache-clearing function.

User::$mCoreRights
staticprotected
Initial value:
= [
'apihighlimits',
'applychangetags',
'autoconfirmed',
'autocreateaccount',
'autopatrol',
'bigdelete',
'block',
'blockemail',
'bot',
'browsearchive',
'changetags',
'createaccount',
'createpage',
'createtalk',
'delete',
'deletechangetags',
'deletedhistory',
'deletedtext',
'deletelogentry',
'deleterevision',
'edit',
'editcontentmodel',
'editinterface',
'editprotected',
'editmyoptions',
'editmyprivateinfo',
'editmyusercss',
'editmyuserjson',
'editmyuserjs',
'editmywatchlist',
'editsemiprotected',
'editusercss',
'edituserjson',
'edituserjs',
'hideuser',
'import',
'importupload',
'ipblock-exempt',
'managechangetags',
'markbotedits',
'mergehistory',
'minoredit',
'move',
'movefile',
'move-categorypages',
'move-rootuserpages',
'move-subpages',
'nominornewtalk',
'noratelimit',
'override-export-depth',
'pagelang',
'patrol',
'patrolmarks',
'protect',
'purge',
'read',
'reupload',
'reupload-own',
'reupload-shared',
'rollback',
'sendemail',
'siteadmin',
'suppressionlog',
'suppressredirect',
'suppressrevision',
'unblockself',
'undelete',
'unwatchedpages',
'upload',
'upload_by_url',
'userrights',
'userrights-interwiki',
'viewmyprivateinfo',
'viewmywatchlist',
'viewsuppressed',
'writeapi',
]

Array of Strings Core rights. Each of these should have a corresponding message of the form "right-$right".

User::$mFrom

String Initialization data source if mLoadedItems!==true. May be one of:

  • 'defaults' anonymous user initialised from class defaults
  • 'name' initialise from mName
  • 'id' initialise from mId
  • 'actor' initialise from mActorId
  • 'session' log in from session if possible

Use the User::newFrom*() family of functions to set this.

User::$mLoadedItems = []
protected

Array with already loaded items or true if all items have been loaded.

User::$mNewtalk
protected

Lazy-initialized variables, invalidated with clearInstanceCache

User::$mOptionsLoaded

Bool Whether the cache variables have been loaded.

const User::CHECK_USER_RIGHTS = true
Since
1.27
const User::EDIT_TOKEN_SUFFIX = Token::SUFFIX

Global constant made accessible as class constants so that autoloader magic can be used.

Deprecated:
since 1.27, use ::SUFFIX
const User::GETOPTIONS_EXCLUDE_DEFAULTS = 1

Exclude user options that are set to their default value.

Since
1.25
const User::IGNORE_USER_RIGHTS = false
Since
1.27
const User::INVALID_TOKEN = '*** INVALID ***'

string An invalid value for user_token

const User::TOKEN_LENGTH = 32

int Number of characters in user_token field.

const User::VERSION = 12

int Serialized record version.


The documentation for this class was generated from the following file: