MediaWiki REL1_34
User Class Reference

The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time). More...

Inheritance diagram for User:
Collaboration diagram for User:

Public Member Functions

 __construct ()
 Lightweight constructor for an anonymous user.
 
__get ( $name)
 
 __set ( $name, $value)
 
 __toString ()
 
 getMutableCacheKeys (WANObjectCache $cache)
 
 isSafeToLoad ()
 Test if it's safe to load this User object.
 
 load ( $flags=self::READ_NORMAL)
 Load the user table data for this object from the source given by mFrom.
 
 loadFromId ( $flags=self::READ_NORMAL)
 Load user table data, given mId has already been set.
 
- Public Member Functions inherited from MediaWiki\User\UserIdentity
 getActorId ()
 

Static Public Member Functions

static purge ( $dbDomain, $userId)
 

Public Attributes

AbstractBlock $mBlock
 
string $mBlockedby
 
string $mEmail
 
string $mEmailAuthenticated
 
string $mFrom
 Initialization data source if mLoadedItems!==true.
 
bool $mHideName
 
int $mId
 Cache variables.
 
string $mName
 
array $mOptions
 
bool $mOptionsLoaded
 Whether the cache variables have been loaded.
 
string $mRealName
 
string $mTouched
 TS_MW timestamp from the DB.
 
const CHECK_USER_RIGHTS = true
 
const GETOPTIONS_EXCLUDE_DEFAULTS = 1
 Exclude user options that are set to their default value.
 
const IGNORE_USER_RIGHTS = false
 
const INVALID_TOKEN = '*** INVALID ***'
 An invalid string value for the user_token field.
 
const TOKEN_LENGTH = 32
 Number of characters required for the user_token field.
 
const VERSION = 14
 Version number to tag cached versions of serialized User objects.
 
- Public Attributes inherited from IDBAccessObject
const READ_LOCKING = self::READ_LATEST | 2
 Constants for object loading bitfield flags (higher => higher QoS)
 
const READ_NONE = -1
 

Static Public Attributes

static int[] $idCacheByName = []
 

Protected Member Functions

 getCacheKey (WANObjectCache $cache)
 
 loadFromCache ()
 Load user data from shared cache, given mId has already been set.
 

Protected Attributes

int null $mActorId
 
bool $mAllowUsertalk
 
string $mBlockreason
 
string $mDatePreference
 
int $mEditCount
 
array $mEffectiveGroups
 
string $mEmailToken
 
string $mEmailTokenExpires
 
array $mFormerGroups
 
AbstractBlock $mGlobalBlock
 
UserGroupMembership[] $mGroupMemberships
 Associative array of (group name => UserGroupMembership object)
 
string $mHash
 
array $mImplicitGroups
 
array bool $mLoadedItems = []
 Array with already loaded items or true if all items have been loaded.
 
bool $mLocked
 
int bool $mNewtalk
 Lazy-initialized variables, invalidated with clearInstanceCache.
 
array $mOptionOverrides
 
string $mQuickTouched
 TS_MW timestamp from cache.
 
string $mRegistration
 
string $mToken
 
int $queryFlagsUsed = self::READ_NORMAL
 User::READ_* constant bitfield used to load data.
 

Static Protected Attributes

static string[] $mCacheVars
 Array of Strings List of member variables which are saved to the shared cache (memcached).
 

Private Attributes

AbstractBlock bool $mBlockedFromCreateAccount = false
 
WebRequest $mRequest
 

Static Private Attributes

static string[] false $reservedUsernames = false
 Cache for self::isUsableName()
 

newFrom*() static factory methods

static array null $defOpt = null
 Is the user an IP range?
 
static string null $defOptLang = null
 Is the user an IP range?
 
 isIPRange ()
 Is the user an IP range?
 
 isValidPassword ( $password)
 Is the input a valid password for this user?
 
 checkPasswordValidity ( $password)
 Check if this is a valid password for this user.
 
 loadDefaults ( $name=false, $actorId=null)
 Set cached properties to default.
 
 isItemLoaded ( $item, $all='all')
 Return whether an item has been loaded.
 
 trackBlockWithCookie ()
 Set the 'BlockID' cookie depending on block type and user authentication status.
 
 loadFromDatabase ( $flags=self::READ_LATEST)
 Load user and user_group data from the database.
 
 addAutopromoteOnceGroups ( $event)
 Add the user to the group if he/she meets given criteria.
 
 clearInstanceCache ( $reloadFrom=false)
 Clear various cached data stored in this object.
 
 isDnsBlacklisted ( $ip, $checkWhitelist=false)
 Whether the given IP is in a DNS blacklist.
 
 inDnsBlacklist ( $ip, $bases)
 Whether the given IP is in a given DNS blacklist.
 
 isPingLimitable ()
 Is this user subject to rate limiting?
 
 pingLimiter ( $action='edit', $incrBy=1)
 Primitive rate limits: enforce maximum actions per time period to put a brake on flooding.
 
 isBlocked ( $fromReplica=true)
 Check if user is blocked.
 
 getBlock ( $fromReplica=true)
 Get the block affecting the user, or null if the user is not blocked.
 
 isBlockedFrom ( $title, $fromReplica=false)
 Check if user is blocked from editing a particular article.
 
 blockedBy ()
 If user is blocked, return the name of the user who placed the block.
 
 blockedFor ()
 If user is blocked, return the specified reason for the block.
 
 getBlockId ()
 If user is blocked, return the ID for the block.
 
 isBlockedGlobally ( $ip='')
 Check if user is blocked on all wikis.
 
 getGlobalBlock ( $ip='')
 Check if user is blocked on all wikis.
 
 isLocked ()
 Check if user account is locked.
 
 isHidden ()
 Check if user account is hidden.
 
 getId ()
 Get the user's ID.
 
 setId ( $v)
 Set the user and reload all fields according to a given ID.
 
 getName ()
 Get the user name, or the IP of an anonymous user.
 
 setName ( $str)
 Set the user name.
 
 getActorId (IDatabase $dbw=null)
 Get the user's actor ID.
 
 getTitleKey ()
 Get the user's name escaped by underscores.
 
 getNewtalk ()
 Check if the user has new messages.
 
 getNewMessageLinks ()
 Return the data needed to construct links for new talk page message alerts.
 
 getNewMessageRevisionId ()
 Get the revision ID for the last talk page revision viewed by the talk page owner.
 
 setNewtalk ( $val, $curRev=null)
 Update the 'You have new messages!' status.
 
 clearSharedCache ( $mode='refresh')
 Clear user data from memcached.
 
 invalidateCache ()
 Immediately touch the user data cache for this account.
 
 touch ()
 Update the "touched" timestamp for the user.
 
 validateCache ( $timestamp)
 Validate the cache for this account.
 
 getTouched ()
 Get the user touched timestamp.
 
 getDBTouched ()
 Get the user_touched timestamp field (time of last DB updates)
 
 setPassword ( $str)
 Set the password and reset the random token.
 
 setInternalPassword ( $str)
 Set the password and reset the random token unconditionally.
 
 changeAuthenticationData (array $data)
 Changes credentials of the user.
 
 getToken ( $forceCreation=true)
 Get the user's current token.
 
 setToken ( $token=false)
 Set the random token (used for persistent authentication) Called from loadDefaults() among other places.
 
 getEmail ()
 Get the user's e-mail address.
 
 getEmailAuthenticationTimestamp ()
 Get the timestamp of the user's e-mail authentication.
 
 setEmail ( $str)
 Set the user's e-mail address.
 
 setEmailWithConfirmation ( $str)
 Set the user's e-mail address and a confirmation mail if needed.
 
 getRealName ()
 Get the user's real name.
 
 setRealName ( $str)
 Set the user's real name.
 
 getOption ( $oname, $defaultOverride=null, $ignoreHidden=false)
 Get the user's current setting for a given option.
 
 getOptions ( $flags=0)
 Get all user's options.
 
 getBoolOption ( $oname)
 Get the user's current setting for a given option, as a boolean value.
 
 getIntOption ( $oname, $defaultOverride=0)
 Get the user's current setting for a given option, as an integer value.
 
 setOption ( $oname, $val)
 Set the given option for a user.
 
 getTokenFromOption ( $oname)
 Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes).
 
 resetTokenFromOption ( $oname)
 Reset a token stored in the preferences (like the watchlist one).
 
 getOptionKinds (IContextSource $context, $options=null)
 Return an associative array mapping preferences keys to the kind of a preference they're used for.
 
 resetOptions ( $resetKinds=[ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused'], IContextSource $context=null)
 Reset certain (or all) options to the site defaults.
 
 getDatePreference ()
 Get the user's preferred date format.
 
 requiresHTTPS ()
 Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what.
 
 getStubThreshold ()
 Get the user preferred stub threshold.
 
 getRights ()
 Get the permissions this user has.
 
 getGroups ()
 Get the list of explicit group memberships this user has.
 
 getGroupMemberships ()
 Get the list of explicit group memberships this user has, stored as UserGroupMembership objects.
 
 getEffectiveGroups ( $recache=false)
 Get the list of implicit group memberships this user has.
 
 getAutomaticGroups ( $recache=false)
 Get the list of implicit group memberships this user has.
 
 getFormerGroups ()
 Returns the groups the user has belonged to.
 
 getEditCount ()
 Get the user's edit count.
 
 addGroup ( $group, $expiry=null)
 Add the user to the given group.
 
 removeGroup ( $group)
 Remove the user from the given group.
 
 isRegistered ()
 Alias of isLoggedIn() with a name that describes its actual functionality.
 
 isLoggedIn ()
 Get whether the user is logged in.
 
 isAnon ()
 Get whether the user is anonymous.
 
 isBot ()
 
 isAllowedAny (... $permissions)
 Check if user is allowed to access a feature / make an action.
 
 isAllowedAll (... $permissions)
 
 isAllowed ( $action='')
 Internal mechanics of testing a permission.
 
 useRCPatrol ()
 Check whether to enable recent changes patrol features for this user.
 
 useNPPatrol ()
 Check whether to enable new pages patrol features for this user.
 
 useFilePatrol ()
 Check whether to enable new files patrol features for this user.
 
 getRequest ()
 Get the WebRequest object to use with this object.
 
 isWatched ( $title, $checkRights=self::CHECK_USER_RIGHTS)
 Check the watched status of an article.
 
 addWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS)
 Watch an article.
 
 removeWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS)
 Stop watching an article.
 
 clearNotification (&$title, $oldid=0)
 Clear the user's notification timestamp for the given title.
 
 clearAllNotifications ()
 Resets all of the given user's page-change notification timestamps.
 
 getExperienceLevel ()
 Compute experienced level based on edit count and registration date.
 
 setCookies ( $request=null, $secure=null, $rememberMe=false)
 Persist this user's session (e.g.
 
 logout ()
 Log this user out.
 
 doLogout ()
 Clear the user's session, and reset the instance cache.
 
 saveSettings ()
 Save this user's settings into the database.
 
 idForName ( $flags=0)
 If only this user's username is known, and it exists, return the user ID.
 
 addToDatabase ()
 Add this existing user object to the database.
 
 spreadAnyEditBlock ()
 If this user is logged-in and blocked, block any IP address they've successfully logged in from.
 
 isBlockedFromCreateAccount ()
 Get whether the user is explicitly blocked from account creation.
 
 isBlockedFromEmailuser ()
 Get whether the user is blocked from using Special:Emailuser.
 
 isBlockedFromUpload ()
 Get whether the user is blocked from using Special:Upload.
 
 isAllowedToCreateAccount ()
 Get whether the user is allowed to create an account.
 
 getUserPage ()
 Get this user's personal page title.
 
 getTalkPage ()
 Get this user's talk page title.
 
 isNewbie ()
 Determine whether the user is a newbie.
 
 checkPassword ( $password)
 Check to see if the given clear-text password is one of the accepted passwords.
 
 checkTemporaryPassword ( $plaintext)
 Check if the given clear-text password matches the temporary password sent by e-mail for password reset operations.
 
 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.
 
 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.
 
 matchEditToken ( $val, $salt='', $request=null, $maxage=null)
 Check given value against the token value stored in the session.
 
 matchEditTokenNoSuffix ( $val, $salt='', $request=null, $maxage=null)
 Check given value against the token value stored in the session, ignoring the suffix.
 
 sendConfirmationMail ( $type='created')
 Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address.
 
 sendMail ( $subject, $body, $from=null, $replyto=null)
 Send an e-mail to this user's account.
 
 confirmEmail ()
 Mark the e-mail address confirmed.
 
 invalidateEmail ()
 Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed.
 
 setEmailAuthenticationTimestamp ( $timestamp)
 Set the e-mail authentication timestamp.
 
 canSendEmail ()
 Is this user allowed to send e-mails within limits of current site configuration?
 
 canReceiveEmail ()
 Is this user allowed to receive e-mails within limits of current site configuration?
 
 isEmailConfirmed ()
 Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration?
 
 isEmailConfirmationPending ()
 Check whether there is an outstanding request for e-mail confirmation.
 
 getRegistration ()
 Get the timestamp of account creation.
 
 getFirstEditTimestamp ()
 Get the timestamp of the first edit.
 
 getLatestEditTimestamp ()
 Get the timestamp of the latest edit.
 
 changeableGroups ()
 Returns an array of groups that this user can add and remove.
 
 incEditCount ()
 Schedule a deferred update to update the user's edit count.
 
 setEditCountInternal ( $count)
 This method should not be called outside User/UserEditCountUpdate.
 
 initEditCountInternal (IDatabase $dbr)
 Initialize user_editcount from data out of the revision table.
 
 addNewUserLogEntry ( $action=false, $reason='')
 Add a newuser log entry for this user.
 
 addNewUserLogEntryAutoCreate ()
 Add an autocreate newuser log entry for this user Used by things like CentralAuth and perhaps other authplugins.
 
 getInstanceForUpdate ()
 Get a new instance of this user that was loaded from the master via a locking read.
 
 equals (UserIdentity $user)
 Checks if two user objects point to the same user.
 
 isAllowUsertalk ()
 Checks if usertalk is allowed.
 
static newFromName ( $name, $validate='valid')
 Static factory method for creation from username.
 
static newFromId ( $id)
 Static factory method for creation from a given user ID.
 
static newFromActorId ( $id)
 Static factory method for creation from a given actor ID.
 
static newFromIdentity (UserIdentity $identity)
 Returns a User object corresponding to the given UserIdentity.
 
static newFromAnyId ( $userId, $userName, $actorId, $dbDomain=false)
 Static factory method for creation from an ID, name, and/or actor ID.
 
static newFromConfirmationCode ( $code, $flags=0)
 Factory method to fetch whichever user has a given email confirmation code.
 
static newFromSession (WebRequest $request=null)
 Create a new user object using data from session.
 
static newFromRow ( $row, $data=null)
 Create a new user object from a user row.
 
static newSystemUser ( $name, $options=[])
 Static factory method for creation of a "system" user from username.
 
static whoIs ( $id)
 Get the username corresponding to a given user ID.
 
static whoIsReal ( $id)
 Get the real name of a user given their user ID.
 
static idFromName ( $name, $flags=self::READ_NORMAL)
 Get database id given a user name.
 
static resetIdByNameCache ()
 Reset the cache used in idFromName().
 
static isIP ( $name)
 Does the string match an anonymous IP address?
 
static isValidUserName ( $name)
 Is the input a valid username?
 
static isUsableName ( $name)
 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.
 
static findUsersByGroup ( $groups, $limit=5000, $after=null)
 Return the users who are members of the given group(s).
 
static isCreatableName ( $name)
 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.
 
static getCanonicalName ( $name, $validate='valid')
 Given unvalidated user input, return a canonical username, or false if the username is invalid.
 
static resetGetDefaultOptionsForTestsOnly ()
 Reset the process cache of default user options.
 
static getDefaultOptions ()
 Combine the language default options with any site-specific options and add the default language variants.
 
static getDefaultOption ( $opt)
 Get a given default option value.
 
static isLocallyBlockedProxy ( $ip)
 Check if an IP address is in the local proxy list.
 
static listOptionKinds ()
 Return a list of the types of user options currently returned by User::getOptionKinds().
 
static createNew ( $name, $params=[])
 Add a user to the database, return the user object.
 
static getGroupPermissions ( $groups)
 Get the permissions associated with a given list of groups.
 
static getGroupsWithPermission ( $role)
 Get all the groups who have a given permission.
 
static groupHasPermission ( $group, $role)
 Check, if the given group has the given permission.
 
static isEveryoneAllowed ( $right)
 Check if all users may be assumed to have the given permission.
 
static getAllGroups ()
 Return the set of defined explicit groups.
 
static getAllRights ()
 Get a list of all available permissions.
 
static getImplicitGroups ()
 Get a list of implicit groups TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
 
static changeableByGroup ( $group)
 Returns an array of the groups that a particular group can add/remove.
 
static getRightDescription ( $right)
 Get the description of a given right.
 
static getGrantName ( $grant)
 Get the name of a given grant.
 
static selectFields ()
 Return the list of user fields that should be selected to create a new user object.
 
static getQueryInfo ()
 Return the tables, fields, and join conditions to be selected to create a new user object.
 
static newFatalPermissionDeniedStatus ( $permission)
 Factory function for fatal permission-denied errors.
 
 setItemLoaded ( $item)
 Set that an item has been loaded.
 
 loadFromRow ( $row, $data=null)
 Initialize this object from a row from the user table.
 
 loadFromUserObject ( $user)
 Load the data for this user object from another user object.
 
 makeUpdateConditions (IDatabase $db, array $conditions)
 Builds update conditions.
 
 checkAndSetTouched ()
 Bump user_touched if it didn't change since this object was loaded.
 
 checkNewtalk ( $field, $id)
 Internal uncached check for new messages.
 
 updateNewtalk ( $field, $id, $curRev=null)
 Add or update the new messages flag.
 
 deleteNewtalk ( $field, $id)
 Clear the new messages flag for the given user.
 
 spreadBlock ()
 If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from.
 
 confirmationToken (&$expiration)
 Generate, store, and return a new e-mail confirmation code.
 
 confirmationTokenUrl ( $token)
 Return a URL the user can use to confirm their email address.
 
 invalidationTokenUrl ( $token)
 Return a URL the user can use to invalidate their email address.
 
 getTokenUrl ( $page, $token)
 Internal function to format the e-mail validation/invalidation URLs.
 
 loadOptions ( $data=null)
 Load the user options either from cache, the database or an array.
 
 saveOptions ()
 Saves the non-default options for this user, as previously set e.g.
 
 loadFromSession ()
 Load user data from the session.
 
 loadGroups ()
 Load the groups from the database if they aren't already loaded.
 
 getBlockedStatus ( $fromReplica=true)
 Get blocking information.
 
 newTouchedTimestamp ()
 Generate a current or new-future timestamp to be stored in the user_touched field when we update things.
 
 setPasswordInternal ( $str)
 Actually set the password and such.
 
 updateActorId (IDatabase $dbw)
 Update the actor ID after an insert.
 
 getEditTimestamp ( $first)
 Get the timestamp of the first or latest edit.
 

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.

Definition at line 51 of file User.php.

Constructor & Destructor Documentation

◆ __construct()

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()

Definition at line 232 of file User.php.

References clearInstanceCache().

Member Function Documentation

◆ __get()

& User::__get (   $name)

Definition at line 243 of file User.php.

References getRights(), and wfLogWarning().

◆ __set()

User::__set (   $name,
  $value 
)

Definition at line 260 of file User.php.

References wfLogWarning().

◆ __toString()

User::__toString ( )
Returns
string

Definition at line 239 of file User.php.

References getName().

◆ addAutopromoteOnceGroups()

User::addAutopromoteOnceGroups (   $event)

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

Contrary to autopromotion by \ref $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

Definition at line 1535 of file User.php.

References $wgAutopromoteOnceLogInRC, addGroup(), checkAndSetTouched(), Autopromote\getAutopromoteOnceGroups(), getGroupMemberships(), getGroups(), getId(), getUserPage(), and wfReadOnly().

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ addGroup()

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 | null$expiryOptional expiry timestamp in any format acceptable to wfTimestamp(), or null if the group assignment should not expire
Returns
bool

Definition at line 3553 of file User.php.

References getEffectiveGroups(), invalidateCache(), load(), loadGroups(), and wfTimestamp().

Referenced by addAutopromoteOnceGroups().

◆ addNewUserLogEntry()

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

Definition at line 5165 of file User.php.

Referenced by addNewUserLogEntryAutoCreate().

◆ addNewUserLogEntryAutoCreate()

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

Definition at line 5177 of file User.php.

References addNewUserLogEntry(), and wfDeprecated().

◆ addToDatabase()

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

Definition at line 4212 of file User.php.

References $mId, $mName, Wikimedia\Rdbms\IDatabase\affectedRows(), clearInstanceCache(), DB_MASTER, Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\IDatabase\insertId(), load(), loadFromDatabase(), newTouchedTimestamp(), saveOptions(), Wikimedia\Rdbms\IDatabase\selectField(), setToken(), Wikimedia\Rdbms\IDatabase\timestamp(), Wikimedia\Rdbms\IDatabase\timestampOrNull(), updateActorId(), and wfGetDB().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().

◆ addWatch()

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.

Definition at line 3768 of file User.php.

References $title, invalidateCache(), and isAllowed().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), WatchAction\doWatch(), and LocalFile\recordUpload().

◆ blockedBy()

User::blockedBy ( )

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

Returns
string Name of blocker

Definition at line 2225 of file User.php.

References $mBlockedby, and getBlockedStatus().

Referenced by SpecialBlock\checkUnblockSelf().

◆ blockedFor()

User::blockedFor ( )

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

Returns
string Blocking reason

Definition at line 2234 of file User.php.

References $mBlockreason, and getBlockedStatus().

◆ canReceiveEmail()

User::canReceiveEmail ( )

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

Returns
bool

Definition at line 4726 of file User.php.

References getOption(), and isEmailConfirmed().

◆ canSendEmail()

User::canSendEmail ( )

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

Returns
bool

Definition at line 4709 of file User.php.

References $wgEnableEmail, $wgEnableUserEmail, isAllowed(), and isEmailConfirmed().

◆ changeableByGroup()

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 [ 'add' => [ addablegroups ], 'remove' => [ removablegroups ], 'add-self' => [ addablegroups to self ], 'remove-self' => [ removable groups from self ] ]

Definition at line 4953 of file User.php.

References $wgAddGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf, $wgRemoveGroups, and getAllGroups().

Referenced by changeableGroups().

◆ changeableGroups()

User::changeableGroups ( )

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

Returns
array [ 'add' => [ addablegroups ], 'remove' => [ removablegroups ], 'add-self' => [ addablegroups to self ], 'remove-self' => [ removable groups from self ] ]

Definition at line 5026 of file User.php.

References changeableByGroup(), getEffectiveGroups(), and isAllowed().

◆ changeAuthenticationData()

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

Definition at line 2819 of file User.php.

Referenced by setPasswordInternal().

◆ checkAndSetTouched()

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

Definition at line 1604 of file User.php.

References $success, clearSharedCache(), DB_MASTER, load(), newTouchedTimestamp(), and wfGetDB().

Referenced by addAutopromoteOnceGroups().

◆ checkNewtalk()

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

Definition at line 2529 of file User.php.

References $dbr, DB_REPLICA, and wfGetDB().

Referenced by getNewtalk().

◆ checkPassword()

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

Definition at line 4410 of file User.php.

References $res, and wfDeprecated().

Referenced by checkTemporaryPassword().

◆ checkPasswordValidity()

User::checkPasswordValidity (   $password)

Check if this is a valid password for this user.

Returns a Status object with a set of messages describing problems with the password. If the return status is fatal, the action should be refused and the password should not be checked at all (this is mainly meant for DoS mitigation). If the return value is OK but not good, the password can be checked, but the user should not be able to set their password to this. The value of the returned Status object will be an array which can have the following fields:

  • forceChange (bool): if set to true, the user should not be allowed to log with this password unless they change it during the login process (see ResetPasswordSecondaryAuthenticationProvider).
  • suggestChangeOnLogin (bool): if set to true, the user should be prompted for a password change on login.
Parameters
string$passwordDesired password
Returns
Status
Since
1.23

Definition at line 1138 of file User.php.

References $wgPasswordPolicy.

Referenced by isValidPassword().

◆ checkTemporaryPassword()

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

Definition at line 4445 of file User.php.

References checkPassword(), and wfDeprecated().

◆ clearAllNotifications()

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.

Definition at line 3876 of file User.php.

References $wgShowUpdatedMarker, $wgUseEnotif, getId(), isAllowed(), setNewtalk(), and wfReadOnly().

◆ clearInstanceCache()

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.

Definition at line 1642 of file User.php.

References $wgFullyInitialised.

Referenced by __construct(), addToDatabase(), doLogout(), and setId().

◆ clearNotification()

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.

Definition at line 3802 of file User.php.

References $title, $wgShowUpdatedMarker, $wgUseEnotif, getName(), getNewtalk(), isAllowed(), isAnon(), NS_USER_TALK, setNewtalk(), and wfReadOnly().

Referenced by WikiPage\doViewUpdates().

◆ clearSharedCache()

User::clearSharedCache (   $mode = 'refresh')

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 or 'changed' to clear before DB commit

Definition at line 2641 of file User.php.

References $cache, DB_MASTER, getCacheKey(), and getId().

Referenced by checkAndSetTouched(), invalidateCache(), and saveSettings().

◆ confirmationToken()

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

Definition at line 4609 of file User.php.

References $wgUserEmailConfirmationTokenExpiry, MWCryptRand\generateHex(), load(), and wfTimestamp().

Referenced by sendConfirmationMail().

◆ confirmationTokenUrl()

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

Definition at line 4627 of file User.php.

References getTokenUrl().

Referenced by sendConfirmationMail().

◆ confirmEmail()

User::confirmEmail ( )

Mark the e-mail address confirmed.

Note
Call saveSettings() after calling this function to commit the change.
Returns
bool

Definition at line 4667 of file User.php.

References isEmailConfirmed(), setEmailAuthenticationTimestamp(), and wfTimestampNow().

◆ createNew()

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.

Definition at line 4136 of file User.php.

References Wikimedia\Rdbms\IDatabase\affectedRows(), DB_MASTER, Wikimedia\Rdbms\IDatabase\insert(), load(), wfDeprecated(), and wfGetDB().

Referenced by newSystemUser().

◆ deleteNewtalk()

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

Definition at line 2569 of file User.php.

References DB_MASTER, wfDebug(), and wfGetDB().

Referenced by setNewtalk().

◆ doLogout()

User::doLogout ( )

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

See also
logout()

Definition at line 3991 of file User.php.

References clearInstanceCache(), and getRequest().

Referenced by logout().

◆ equals()

User::equals ( UserIdentity  $user)

Checks if two user objects point to the same user.

Since
1.25 ; takes a UserIdentity instead of a User since 1.32
Parameters
UserIdentity$user
Returns
bool

Implements MediaWiki\User\UserIdentity.

Definition at line 5436 of file User.php.

References getName(), and MediaWiki\User\UserIdentity\getName().

◆ findUsersByGroup()

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 | null$afterID the user to start after
Returns
UserArrayFromResult

Definition at line 1042 of file User.php.

References $dbr, DB_REPLICA, UserArray\newFromIDs(), and wfGetDB().

Referenced by EmptyUserGroup\execute().

◆ getActorId()

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

Definition at line 2403 of file User.php.

References $mActorId, invalidateCache(), isItemLoaded(), load(), and setItemLoaded().

Referenced by LocalFile\recordUpload2().

◆ getAllGroups()

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

Definition at line 4914 of file User.php.

References $wgGroupPermissions, and $wgRevokePermissions.

Referenced by UsersPager\__construct(), ApiQuerySiteinfo\appendUserGroups(), SpecialActiveUsers\buildForm(), changeableByGroup(), CreateAndPromote\execute(), SpecialListGroupRights\formatPermissions(), ApiUserrights\getAllGroups(), UsersPager\getAllGroups(), UserrightsPage\getAllGroups(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), and SpecialListUsers\getSubpagesForPrefixSearch().

◆ getAllRights()

static User::getAllRights ( )
static

Get a list of all available permissions.

Deprecated:
since 1.34, use PermissionManager::getAllPermissions() instead
Returns
string[] Array of permission names

Definition at line 4929 of file User.php.

◆ getAutomaticGroups()

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

Definition at line 3465 of file User.php.

References $mImplicitGroups, Autopromote\getAutopromoteGroups(), and getId().

Referenced by getEffectiveGroups().

◆ getBlock()

User::getBlock (   $fromReplica = true)

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

Parameters
bool$fromReplicaWhether to check the replica DB instead of the master
Returns
AbstractBlock|null

Definition at line 2200 of file User.php.

References getBlockedStatus().

Referenced by Action\checkCanExecute(), Autopromote\checkCondition(), FormSpecialPage\checkExecutePermissions(), SpecialBlock\checkUnblockSelf(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), isBlocked(), PasswordReset\isBlocked(), MediaWiki\Permissions\PermissionManager\isBlockedFrom(), spreadAnyEditBlock(), and MediaWiki\Block\BlockManager\trackBlockWithCookie().

◆ getBlockedStatus()

User::getBlockedStatus (   $fromReplica = true)
private

Get blocking information.

TODO: Move this into the BlockManager, along with block-related properties.

Parameters
bool$fromReplicaWhether to check the replica DB first. To improve performance, non-critical checks are done against replica DBs. Check when actually saving should be done against master.

Definition at line 1748 of file User.php.

References getName(), getRequest(), load(), and wfDebug().

Referenced by blockedBy(), blockedFor(), getBlock(), getBlockId(), isBlockedFromCreateAccount(), isBlockedFromEmailuser(), isBlockedFromUpload(), and isHidden().

◆ getBlockId()

User::getBlockId ( )

If user is blocked, return the ID for the block.

Returns
int Block ID

Definition at line 2243 of file User.php.

References getBlockedStatus().

◆ getBoolOption()

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()

Definition at line 3081 of file User.php.

References getOption().

Referenced by requiresHTTPS().

◆ getCacheKey()

User::getCacheKey ( WANObjectCache  $cache)
protected
Since
1.27
Parameters
WANObjectCache$cache
Returns
string

Definition at line 432 of file User.php.

References $cache.

Referenced by clearSharedCache(), getMutableCacheKeys(), and loadFromCache().

◆ getCanonicalName()

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

Definition at line 1180 of file User.php.

References $t, and NS_USER.

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), SpecialDeletedContributions\execute(), UserrightsPage\execute(), ApiQueryUserContribs\execute(), ApiQueryUsers\execute(), RollbackEdits\execute(), PasswordReset\execute(), UserrightsPage\fetchUser(), FindMissingActors\getNewActorId(), ApiRollback\getRbUser(), DeleteLocalPasswords\initialize(), newFromName(), newSystemUser(), ApiQueryBlocks\prepareUsername(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), MediaWiki\Auth\AbstractPrimaryAuthenticationProvider\providerNormalizeUsername(), WebInstallerName\submit(), MediaWiki\Session\CookieSessionProvider\suggestLoginUsername(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserCanAuthenticate(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserCanAuthenticate(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserExists(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserExists(), and ApiBase\validateUser().

◆ getDatePreference()

User::getDatePreference ( )

Get the user's preferred date format.

Returns
string User's preferred date format

Definition at line 3345 of file User.php.

References $mDatePreference, $wgLang, and getOption().

Referenced by Language\getHumanTimestampInternal(), and Language\internalUserTimeAndDate().

◆ getDBTouched()

User::getDBTouched ( )

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

Returns
string TS_MW Timestamp
Since
1.26

Definition at line 2733 of file User.php.

References $mTouched, and load().

◆ getDefaultOption()

static User::getDefaultOption (   $opt)
static

Get a given default option value.

Parameters
string$optName of option to retrieve
Returns
string Default option value

Definition at line 1734 of file User.php.

References getDefaultOptions().

Referenced by ConvertUserOptions\convertOptionBatch(), Language\dateFormat(), CoreParserFunctions\gender(), GenderCache\getDefault(), ParserOptions\getDefaults(), ImagePage\getImageLimitsFromOption(), getOption(), getOptions(), Linker\makeImageLink(), saveOptions(), and setOption().

◆ getDefaultOptions()

static User::getDefaultOptions ( )
static

◆ getEditCount()

◆ getEditTimestamp()

User::getEditTimestamp (   $first)
private

Get the timestamp of the first or latest edit.

Parameters
bool$firstTrue for the first edit, false for the latest one
Returns
string|bool Timestamp of first or latest edit, or false for non-existent/anonymous user accounts.

Definition at line 4817 of file User.php.

References $dbr, DB_REPLICA, getId(), wfGetDB(), and wfTimestamp().

Referenced by getFirstEditTimestamp(), and getLatestEditTimestamp().

◆ getEditToken()

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

Definition at line 4486 of file User.php.

References getEditTokenObject().

Referenced by WatchAction\getWatchToken().

◆ getEditTokenObject()

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\Session\Token The new edit token

Definition at line 4462 of file User.php.

References getRequest(), and isAnon().

Referenced by getEditToken(), ApiQueryTokens\getToken(), and matchEditToken().

◆ getEffectiveGroups()

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

Definition at line 3442 of file User.php.

References $mEffectiveGroups, getAutomaticGroups(), and getGroups().

Referenced by addGroup(), changeableGroups(), UserPasswordPolicy\getPoliciesForUser(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and removeGroup().

◆ getEmail()

User::getEmail ( )

Get the user's e-mail address.

Returns
string User's email address

Definition at line 2905 of file User.php.

References $mEmail, and load().

Referenced by SpecialChangeEmail\attemptChange(), Autopromote\checkCondition(), MailAddress\newFromUser(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and setEmailWithConfirmation().

◆ getEmailAuthenticationTimestamp()

User::getEmailAuthenticationTimestamp ( )

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

Returns
string TS_MW timestamp

Definition at line 2915 of file User.php.

References $mEmailAuthenticated, and load().

Referenced by Autopromote\checkCondition(), isEmailConfirmed(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ getExperienceLevel()

User::getExperienceLevel ( )

Compute experienced level based on edit count and registration date.

Returns
string 'newcomer', 'learner', or 'experienced'

Definition at line 3905 of file User.php.

References $wgExperiencedUserEdits, $wgExperiencedUserMemberSince, $wgLearnerEdits, $wgLearnerMemberSince, getEditCount(), getRegistration(), isAnon(), and wfTimestamp().

◆ getFirstEditTimestamp()

User::getFirstEditTimestamp ( )

Get the timestamp of the first edit.

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

Definition at line 4795 of file User.php.

References getEditTimestamp().

Referenced by Autopromote\checkCondition().

◆ getFormerGroups()

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.

Definition at line 3494 of file User.php.

References $mFormerGroups, $res, DB_MASTER, DB_REPLICA, load(), and wfGetDB().

Referenced by Autopromote\getAutopromoteOnceGroups().

◆ getGlobalBlock()

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
AbstractBlock|null Block object if blocked, null otherwise
Exceptions
FatalError
MWException

Definition at line 2270 of file User.php.

References getName(), and getRequest().

Referenced by PasswordReset\isBlocked(), and isBlockedGlobally().

◆ getGrantName()

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

Definition at line 5139 of file User.php.

References wfMessage().

Referenced by SpecialListGrants\execute().

◆ getGroupMemberships()

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

Definition at line 3429 of file User.php.

References $mGroupMemberships, load(), and loadGroups().

Referenced by addAutopromoteOnceGroups(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ getGroupPermissions()

static User::getGroupPermissions (   $groups)
static

Get the permissions associated with a given list of groups.

Deprecated:
since 1.34, use MediaWikiServices::getInstance()->getPermissionManager() ->getGroupPermissions() instead
Parameters
array$groupsArray of Strings List of internal group names
Returns
array Array of Strings List of permission key names for given groups combined

Definition at line 4849 of file User.php.

◆ getGroups()

User::getGroups ( )

Get the list of explicit group memberships this user has.

The implicit * and user groups are not included.

Returns
string[] Array of internal group names (sorted since 1.33)

Definition at line 3416 of file User.php.

References load(), and loadGroups().

Referenced by addAutopromoteOnceGroups(), Autopromote\checkCondition(), Autopromote\getAutopromoteOnceGroups(), getEffectiveGroups(), isBot(), and pingLimiter().

◆ getGroupsWithPermission()

static User::getGroupsWithPermission (   $role)
static

Get all the groups who have a given permission.

Deprecated:
since 1.34, use MediaWikiServices::getInstance()->getPermissionManager() ->getGroupsWithPermission() instead
Parameters
string$roleRole to check
Returns
array Array of Strings List of internal group names with the given permission

Definition at line 4862 of file User.php.

Referenced by newFatalPermissionDeniedStatus().

◆ getId()

◆ getImplicitGroups()

static User::getImplicitGroups ( )
static

Get a list of implicit groups TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.

Returns
array Array of Strings Array of internal group names

Definition at line 4939 of file User.php.

References $wgImplicitGroups.

◆ getInstanceForUpdate()

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

Definition at line 5416 of file User.php.

References getId(), and newFromId().

◆ getIntOption()

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()

Definition at line 3093 of file User.php.

References getOption().

Referenced by getStubThreshold().

◆ getLatestEditTimestamp()

User::getLatestEditTimestamp ( )

Get the timestamp of the latest edit.

Since
1.33
Returns
string|bool Timestamp of first edit, or false for non-existent/anonymous user accounts.

Definition at line 4806 of file User.php.

References getEditTimestamp().

◆ getMutableCacheKeys()

User::getMutableCacheKeys ( WANObjectCache  $cache)
Parameters
WANObjectCache$cache
Returns
string[]
Since
1.28

Definition at line 443 of file User.php.

References getCacheKey(), and getId().

◆ getName()

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.

Definition at line 2364 of file User.php.

References $mName, getRequest(), isItemLoaded(), and load().

Referenced by MediaWiki\Session\UserInfo\__construct(), __toString(), EmailNotification\actuallyNotifyOnPageChange(), SpecialChangeEmail\attemptChange(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountCreation(), MediaWiki\Auth\AuthManager\beginAccountLink(), CentralIdLookup\centralIdFromLocalUser(), MediaWiki\Storage\PageEditStash\checkCache(), PasswordPolicyChecks\checkPasswordCannotMatchBlacklist(), PasswordPolicyChecks\checkPasswordCannotMatchUsername(), SpecialBlock\checkUnblockSelf(), clearNotification(), WikiPage\doEditUpdates(), RecentChange\doMarkPatrolled(), equals(), ApiUnblock\execute(), PasswordReset\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate(), getBlockedStatus(), ApiQueryUserInfo\getCentralUserInfo(), getGlobalBlock(), getNewMessageLinks(), getNewtalk(), MediaWiki\Storage\PageEditStash\getStashKey(), getTitleKey(), UploadBase\getUploadSessionKey(), ArchivedFile\getUser(), LocalFile\getUser(), getUserPage(), idForName(), MediaWiki\Revision\RevisionStore\insertIpChangesRow(), PasswordReset\isAllowed(), CreditsAction\link(), loadFromSession(), LogFormatter\makeUserLink(), MovePage\moveToInternal(), MailAddress\newFromUser(), EmailNotification\notifyOnPageChange(), MediaWiki\Block\AbstractBlock\parseTarget(), pingLimiter(), SpecialBlock\preText(), SpecialBlock\processForm(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Storage\PageEditStash\pruneExcessStashedEntries(), MediaWiki\Storage\PageEditStash\recentStashEntryCount(), LocalFile\recordUpload2(), sendConfirmationMail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), setEmailWithConfirmation(), setNewtalk(), setPasswordInternal(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), spreadBlock(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset(), CreditsAction\userLink(), and SpecialBlock\validateTarget().

◆ getNewMessageLinks()

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

Definition at line 2469 of file User.php.

References $dbr, DB_REPLICA, getId(), getName(), getNewtalk(), getTalkPage(), isAnon(), Revision\loadFromTimestamp(), and wfGetDB().

Referenced by getNewMessageRevisionId().

◆ getNewMessageRevisionId()

User::getNewMessageRevisionId ( )

Get the revision ID for the last talk page revision viewed by the talk page owner.

Returns
int|null Revision ID or null

Definition at line 2502 of file User.php.

References getNewMessageLinks().

◆ getNewtalk()

User::getNewtalk ( )

Check if the user has new messages.

Returns
bool True if the user has new messages

Definition at line 2431 of file User.php.

References $mNewtalk, $wgDisableAnonTalk, checkNewtalk(), getName(), and load().

Referenced by clearNotification(), and getNewMessageLinks().

◆ getOption()

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 | null$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()

Reimplemented in PPFuzzUser.

Definition at line 3022 of file User.php.

References $wgHiddenPrefs, getDefaultOption(), and loadOptions().

Referenced by MediaWiki\EditPage\TextboxBuilder\buildTextboxAttribs(), canReceiveEmail(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), getBoolOption(), getDatePreference(), getIntOption(), RequestContext\getLanguage(), getTokenFromOption(), Language\internalUserTimeAndDate(), MWTimestamp\offsetForUser(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail().

◆ getOptionKinds()

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 | null$optionsAssoc. array with options keys to check as keys. Defaults to $this->mOptions.
Returns
array The key => kind mapping data

Definition at line 3215 of file User.php.

References $context, $mOptions, and loadOptions().

Referenced by resetOptions().

◆ getOptions()

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

Definition at line 3050 of file User.php.

References $mOptions, $wgHiddenPrefs, getDefaultOption(), and loadOptions().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\loadPreferenceValues().

◆ getQueryInfo()

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()

Definition at line 5358 of file User.php.

Referenced by ApiQueryUsers\execute(), PasswordReset\getUsersByEmail(), loadFromDatabase(), UserArray\newFromIDs(), UserArray\newFromNames(), newSystemUser(), and RebuildRecentchanges\rebuildRecentChangesTablePass4().

◆ getRealName()

User::getRealName ( )

Get the user's real name.

Returns
string User's real name

Definition at line 2995 of file User.php.

References $mRealName, isItemLoaded(), and load().

Referenced by CreditsAction\link(), MailAddress\newFromUser(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and CreditsAction\userLink().

◆ getRegistration()

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.

Definition at line 4781 of file User.php.

References $mRegistration, isAnon(), and load().

Referenced by Autopromote\checkCondition(), getExperienceLevel(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ getRequest()

◆ getRightDescription()

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

Definition at line 5126 of file User.php.

References wfMessage().

Referenced by SpecialListGrants\execute(), SpecialListGroupRights\formatPermissions(), and SpecialListGroupRights\outputNamespaceProtectionInfo().

◆ getRights()

User::getRights ( )

Get the permissions this user has.

Returns
string[] permission names
Deprecated:
since 1.34, use MediaWikiServices::getInstance()->getPermissionManager() ->getUserPermissions(..) instead

Definition at line 3406 of file User.php.

Referenced by __get().

◆ getStubThreshold()

User::getStubThreshold ( )

Get the user preferred stub threshold.

Returns
int

Definition at line 3387 of file User.php.

References $wgMaxArticleSize, and getIntOption().

Referenced by MediaWiki\Linker\LinkRendererFactory\createForUser().

◆ getTalkPage()

User::getTalkPage ( )

Get this user's talk page title.

Returns
Title User's talk page title

Definition at line 4390 of file User.php.

References $title, and getUserPage().

Referenced by getNewMessageLinks(), and MediaWiki\Permissions\PermissionManager\isBlockedFrom().

◆ getTitleKey()

User::getTitleKey ( )

Get the user's name escaped by underscores.

Returns
string Username escaped by underscores.

Definition at line 2423 of file User.php.

References getName().

◆ getToken()

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

Definition at line 2846 of file User.php.

References $mToken, $wgAuthenticationTokenVersion, MWCryptRand\generateHex(), load(), and setToken().

Referenced by getTokenFromOption(), and loadFromSession().

◆ getTokenFromOption()

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

Definition at line 3130 of file User.php.

References $wgHiddenPrefs, getId(), getOption(), and getToken().

◆ getTokenUrl()

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

Definition at line 4654 of file User.php.

References $title, and NS_MAIN.

Referenced by confirmationTokenUrl(), and invalidationTokenUrl().

◆ getTouched()

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

Definition at line 2711 of file User.php.

References $cache, $mTouched, load(), and wfTimestamp().

Referenced by validateCache().

◆ getUserPage()

User::getUserPage ( )

◆ groupHasPermission()

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.

Deprecated:
since 1.34, use MediaWikiServices::getInstance()->getPermissionManager() ->groupHasPermission(..) instead
Since
1.21
Parameters
string$groupGroup to check
string$roleRole to check
Returns
bool

Definition at line 4881 of file User.php.

◆ idForName()

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

Definition at line 4101 of file User.php.

References $s, DB_MASTER, DB_REPLICA, getName(), IDBAccessObject\READ_LOCKING, and wfGetDB().

◆ idFromName()

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

Definition at line 871 of file User.php.

References $s, NS_USER, and wfGetDB().

Referenced by ExternalUserNames\applyPrefix(), MediaWiki\Auth\AuthManager\autoCreateUser(), CleanupUsersWithNoId\cleanup(), and UsersPager\getQueryInfo().

◆ incEditCount()

User::incEditCount ( )

Schedule a deferred update to update the user's edit count.

Definition at line 5065 of file User.php.

References isAnon().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), and MovePage\moveToInternal().

◆ inDnsBlacklist()

User::inDnsBlacklist (   $ip,
  $bases 
)

Whether the given IP is in a given DNS blacklist.

Deprecated:
since 1.34 Check via BlockManager::isDnsBlacklisted instead.
Parameters
string$ipIP to check
string | array$basesArray of Strings: URL of the DNS blacklist
Returns
bool True if blacklisted.

Definition at line 1831 of file User.php.

References $base, wfDebugLog(), and wfDeprecated().

◆ initEditCountInternal()

User::initEditCountInternal ( IDatabase  $dbr)

Initialize user_editcount from data out of the revision table.

Definition at line 5092 of file User.php.

References $dbr, DB_MASTER, getId(), and wfGetDB().

Referenced by getEditCount().

◆ invalidateCache()

User::invalidateCache ( )

Immediately touch the user data cache for this account.

Calls touch() and removes account data from memcached

Definition at line 2667 of file User.php.

References clearSharedCache(), and touch().

Referenced by addGroup(), addWatch(), getActorId(), removeGroup(), removeWatch(), and setNewtalk().

◆ invalidateEmail()

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

Definition at line 4684 of file User.php.

References load(), and setEmailAuthenticationTimestamp().

Referenced by setEmail().

◆ invalidationTokenUrl()

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

Definition at line 4636 of file User.php.

References getTokenUrl().

Referenced by sendConfirmationMail().

◆ isAllowed()

User::isAllowed (   $action = '')

Internal mechanics of testing a permission.

Deprecated:
since 1.34, use MediaWikiServices::getInstance() ->getPermissionManager()->userHasRight(...) instead
Parameters
string$action
Returns
bool

Definition at line 3694 of file User.php.

Referenced by addWatch(), canSendEmail(), changeableGroups(), clearAllNotifications(), clearNotification(), isAllowedToCreateAccount(), isBlockedFromCreateAccount(), isBot(), isNewbie(), isPingLimitable(), and removeWatch().

◆ isAllowedAll()

User::isAllowedAll (   $permissions)
Deprecated:
since 1.34, use MediaWikiServices::getInstance() ->getPermissionManager()->userHasAllRights(...) instead
Parameters
string...$permissions Permissions to test
Returns
bool True if the user is allowed to perform all of the given actions

Definition at line 3678 of file User.php.

◆ isAllowedAny()

User::isAllowedAny (   $permissions)

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

Deprecated:
since 1.34, use MediaWikiServices::getInstance() ->getPermissionManager()->userHasAnyRights(...) instead
Parameters
string...$permissions Permissions to test
Returns
bool True if user is allowed to perform any of the given actions

Definition at line 3666 of file User.php.

Referenced by useFilePatrol(), useNPPatrol(), and useRCPatrol().

◆ isAllowedToCreateAccount()

User::isAllowedToCreateAccount ( )

Get whether the user is allowed to create an account.

Returns
bool

Definition at line 4372 of file User.php.

References isAllowed(), and isBlockedFromCreateAccount().

◆ isAllowUsertalk()

User::isAllowUsertalk ( )

Checks if usertalk is allowed.

Returns
bool

Definition at line 5446 of file User.php.

References $mAllowUsertalk.

Referenced by MediaWiki\Permissions\PermissionManager\isBlockedFrom().

◆ isAnon()

◆ isBlocked()

User::isBlocked (   $fromReplica = true)

Check if user is blocked.

Deprecated:
since 1.34, use User::getBlock() or PermissionManager::isBlockedFrom() or PermissionManager::userCan() instead.
Parameters
bool$fromReplicaWhether 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

Definition at line 2189 of file User.php.

References MediaWiki\Block\AbstractBlock\appliesToRight(), and getBlock().

◆ isBlockedFrom()

User::isBlockedFrom (   $title,
  $fromReplica = false 
)

Check if user is blocked from editing a particular article.

Parameters
Title$titleTitle to check
bool$fromReplicaWhether to check the replica DB instead of the master
Returns
bool
Deprecated:
since 1.33, use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)

Definition at line 2216 of file User.php.

References $title.

Referenced by Action\checkCanExecute().

◆ isBlockedFromCreateAccount()

User::isBlockedFromCreateAccount ( )

Get whether the user is explicitly blocked from account creation.

Returns
bool|AbstractBlock

Definition at line 4328 of file User.php.

References $mBlock, MediaWiki\Block\AbstractBlock\appliesToRight(), getBlockedStatus(), getRequest(), and isAllowed().

Referenced by MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), and isAllowedToCreateAccount().

◆ isBlockedFromEmailuser()

User::isBlockedFromEmailuser ( )

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

Returns
bool

Definition at line 4352 of file User.php.

References getBlockedStatus().

◆ isBlockedFromUpload()

User::isBlockedFromUpload ( )

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

Since
1.33
Returns
bool

Definition at line 4363 of file User.php.

References getBlockedStatus().

◆ isBlockedGlobally()

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

Definition at line 2256 of file User.php.

References getGlobalBlock().

◆ isBot()

User::isBot ( )
Returns
bool Whether this user is flagged as being a bot role account
Since
1.28

Definition at line 3646 of file User.php.

References getGroups(), and isAllowed().

Referenced by MediaWiki\Storage\PageEditStash\checkCache().

◆ isCreatableName()

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

Definition at line 1082 of file User.php.

References $wgInvalidUsernameCharacters, isUsableName(), and wfDebugLog().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().

◆ isDnsBlacklisted()

User::isDnsBlacklisted (   $ip,
  $checkWhitelist = false 
)

Whether the given IP is in a DNS blacklist.

Deprecated:
since 1.34 Use BlockManager::isDnsBlacklisted.
Parameters
string$ipIP to check
bool$checkWhitelistWhether to check the whitelist first
Returns
bool True if blacklisted.

Definition at line 1818 of file User.php.

◆ isEmailConfirmationPending()

User::isEmailConfirmationPending ( )

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

Returns
bool

Definition at line 4766 of file User.php.

References $wgEmailAuthentication, isEmailConfirmed(), and wfTimestamp().

◆ isEmailConfirmed()

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

Definition at line 4740 of file User.php.

References $wgEmailAuthentication, getEmailAuthenticationTimestamp(), isAnon(), and load().

Referenced by canReceiveEmail(), canSendEmail(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), confirmEmail(), and isEmailConfirmationPending().

◆ isEveryoneAllowed()

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.

Deprecated:
since 1.34, use MediaWikiServices::getInstance()->getPermissionManager() ->isEveryoneAllowed() instead
Parameters
string$rightRight to check
Returns
bool
Since
1.22

Definition at line 4904 of file User.php.

Referenced by RawAction\onView(), and ApiMain\setCacheMode().

◆ isHidden()

User::isHidden ( )

Check if user account is hidden.

Returns
bool True if hidden, false otherwise

Definition at line 2318 of file User.php.

References $mHideName, and getBlockedStatus().

Referenced by UserrightsPage\fetchUser(), and MediaWiki\Permissions\PermissionManager\isBlockedFrom().

◆ isIP()

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

Definition at line 933 of file User.php.

Referenced by ImageListPager\__construct(), SpecialContributions\contributionsSub(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), ApiQueryUserContribs\execute(), RollbackEdits\execute(), SearchNearMatcher\getNearMatchInternal(), ApiRollback\getRbUser(), Skin\getRelevantUser(), ReassignEdits\initialiseUser(), ApiQueryBlocks\prepareUsername(), EditPage\showIntro(), and Article\showMissingArticle().

◆ isIPRange()

User::isIPRange ( )

Is the user an IP range?

Since
1.30
Returns
bool

Definition at line 944 of file User.php.

◆ isItemLoaded()

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

Definition at line 1275 of file User.php.

References true.

Referenced by getActorId(), getId(), getName(), and getRealName().

◆ isLocallyBlockedProxy()

static User::isLocallyBlockedProxy (   $ip)
static

Check if an IP address is in the local proxy list.

Deprecated:
since 1.34 Use BlockManager::getUserBlock instead.
Parameters
string$ip
Returns
bool

Definition at line 1879 of file User.php.

References $wgProxyList, and wfDeprecated().

◆ isLocked()

User::isLocked ( )

Check if user account is locked.

Returns
bool True if locked, false otherwise

Definition at line 2303 of file User.php.

References $mLocked.

◆ isLoggedIn()

User::isLoggedIn ( )

Get whether the user is logged in.

Returns
bool

Definition at line 3630 of file User.php.

References isRegistered().

Referenced by WatchAction\doWatchOrUnwatch(), UppercaseTitlesForUnicodeTransition\execute(), and spreadAnyEditBlock().

◆ isNewbie()

User::isNewbie ( )

Determine whether the user is a newbie.

Newbies are either anonymous IPs, or the most recently created accounts.

Returns
bool

Definition at line 4400 of file User.php.

References isAllowed().

Referenced by pingLimiter(), and SpecialEmailUser\validateTarget().

◆ isPingLimitable()

User::isPingLimitable ( )

Is this user subject to rate limiting?

Returns
bool True if rate limited

Definition at line 1927 of file User.php.

References $wgRateLimitsExcludedIPs, getRequest(), and isAllowed().

Referenced by pingLimiter().

◆ isRegistered()

User::isRegistered ( )

Alias of isLoggedIn() with a name that describes its actual functionality.

UserIdentity has only this new name and not the old isLoggedIn() variant.

Returns
bool True if user is registered on this wiki, i.e., has a user ID. False if user is anonymous or has no local account (which can happen when importing). This is equivalent to getId() != 0 and is provided for code readability.
Since
1.34

Implements MediaWiki\User\UserIdentity.

Definition at line 3622 of file User.php.

References getId().

Referenced by MediaWiki\Block\BlockManager\getUserBlock(), isAnon(), and isLoggedIn().

◆ isSafeToLoad()

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: \code $user = $wgUser->isSafeToLoad() ? $wgUser : new User; \endcode

Since
1.27
Returns
bool

Definition at line 289 of file User.php.

References $wgFullyInitialised.

◆ isUsableName()

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

Definition at line 1008 of file User.php.

References $wgReservedUsernames, and wfMessage().

Referenced by MediaWiki\Session\UserInfo\__construct(), MigrateActors\addActorsForRows(), ExternalUserNames\applyPrefix(), MediaWiki\Auth\AuthManager\beginAccountLink(), CleanupUsersWithNoId\cleanup(), ApiBlock\execute(), FindMissingActors\getNewActorId(), ActorMigration\getNewActorId(), isCreatableName(), and MediaWiki\Block\AbstractBlock\setBlocker().

◆ isValidPassword()

User::isValidPassword (   $password)

Is the input a valid password for this user?

Parameters
string$passwordDesired password
Returns
bool

Definition at line 1112 of file User.php.

References checkPasswordValidity().

◆ isValidUserName()

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

Definition at line 959 of file User.php.

References $wgMaxNameChars.

Referenced by GenderCache\doQuery(), CheckUsernames\execute(), FindMissingActors\getNewActorId(), and MediaWiki\Session\SessionBackend\save().

◆ isWatched()

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

Definition at line 3754 of file User.php.

References $title.

Referenced by WatchAction\doWatchOrUnwatch().

◆ listOptionKinds()

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

Definition at line 3192 of file User.php.

Referenced by ApiOptions\getAllowedParams().

◆ load()

◆ loadDefaults()

User::loadDefaults (   $name = false,
  $actorId = null 
)

Set cached properties to default.

Note
This no longer clears uncached lazy-initialised properties; the constructor does that instead.
Parameters
string | bool$name
int | null$actorId

Definition at line 1236 of file User.php.

References wfTimestamp().

Referenced by PPFuzzUser\load(), load(), loadFromDatabase(), and loadFromId().

◆ loadFromCache()

User::loadFromCache ( )
protected

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

Returns
bool True
Since
1.25

Definition at line 455 of file User.php.

References $cache, DB_REPLICA, getCacheKey(), loadFromDatabase(), loadGroups(), loadOptions(), VERSION, wfDebug(), wfGetDB(), and wfTimestamp().

Referenced by loadFromId().

◆ loadFromDatabase()

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

Definition at line 1336 of file User.php.

References $s, getEditCount(), getQueryInfo(), loadDefaults(), loadFromRow(), and wfGetDB().

Referenced by addToDatabase(), loadFromCache(), and loadFromId().

◆ loadFromId()

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

Definition at line 391 of file User.php.

References loadDefaults(), loadFromCache(), and loadFromDatabase().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), and load().

◆ loadFromRow()

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 | null$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

Definition at line 1389 of file User.php.

References loadOptions(), setItemLoaded(), wfTimestamp(), and wfTimestampOrNull().

Referenced by loadFromDatabase(), and newFromRow().

◆ loadFromSession()

User::loadFromSession ( )
private

Load user data from the session.

Returns
bool True if the user is logged in, false otherwise.

Definition at line 1296 of file User.php.

References getId(), getName(), getRequest(), getToken(), and loadFromUserObject().

Referenced by load().

◆ loadFromUserObject()

User::loadFromUserObject (   $user)
protected

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

Parameters
User$user

Definition at line 1501 of file User.php.

Referenced by loadFromSession().

◆ loadGroups()

User::loadGroups ( )
private

Load the groups from the database if they aren't already loaded.

Definition at line 1511 of file User.php.

References DB_MASTER, DB_REPLICA, and wfGetDB().

Referenced by addGroup(), getGroupMemberships(), getGroups(), loadFromCache(), and removeGroup().

◆ loadOptions()

User::loadOptions (   $data = null)
protected

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

Parameters
array | null$dataRows for the current user out of the user_properties table

Definition at line 5189 of file User.php.

References $dbr, $res, DB_MASTER, DB_REPLICA, getDefaultOptions(), getId(), load(), wfDebug(), and wfGetDB().

Referenced by getOption(), getOptionKinds(), getOptions(), loadFromCache(), loadFromRow(), saveOptions(), and setOption().

◆ logout()

User::logout ( )

Log this user out.

Definition at line 3979 of file User.php.

References doLogout().

◆ makeUpdateConditions()

User::makeUpdateConditions ( IDatabase  $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
IDatabase$db
array$conditionsWHERE conditions for use with Database::update
Returns
array WHERE conditions for use with Database::update

Definition at line 1586 of file User.php.

References Wikimedia\Rdbms\IDatabase\timestamp().

◆ matchEditToken()

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 | null$maxageFail tokens older than this, in seconds
Returns
bool Whether the token matches

Definition at line 4502 of file User.php.

References getEditTokenObject().

Referenced by WikiPage\doRollback(), and matchEditTokenNoSuffix().

◆ matchEditTokenNoSuffix()

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 | null$maxageFail tokens older than this, in seconds
Returns
bool Whether the token matches

Definition at line 4516 of file User.php.

References matchEditToken().

◆ newFatalPermissionDeniedStatus()

static User::newFatalPermissionDeniedStatus (   $permission)
static

Factory function for fatal permission-denied errors.

Since
1.22
Parameters
string$permissionUser right required
Returns
Status

Definition at line 5390 of file User.php.

References $wgLang, getGroupsWithPermission(), and getPermissionManager().

Referenced by ApiUpload\checkPermissions(), WatchAction\doUnwatch(), WatchAction\doWatch(), and MediaWiki\Permissions\PermissionManager\missingPermissionError().

◆ newFromActorId()

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

Definition at line 557 of file User.php.

References setItemLoaded().

Referenced by RecentChange\getPerformer(), DatabaseLogEntry\getPerformer(), and RCDatabaseLogEntry\getPerformer().

◆ newFromAnyId()

static User::newFromAnyId (   $userId,
  $userName,
  $actorId,
  $dbDomain = false 
)
static

◆ newFromConfirmationCode()

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

Definition at line 653 of file User.php.

References DB_MASTER, DB_REPLICA, newFromId(), and wfGetDB().

Referenced by SpecialConfirmEmail\attemptConfirm(), and SpecialEmailInvalidate\attemptInvalidate().

◆ newFromId()

◆ newFromIdentity()

◆ newFromName()

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.

Definition at line 518 of file User.php.

References getCanonicalName(), and setItemLoaded().

Referenced by ImageListPager\__construct(), EmailNotification\actuallyNotifyOnPageChange(), MediaWiki\Auth\AuthManager\beginAccountCreation(), MediaWiki\Auth\AuthManager\beginAuthentication(), Parser\braceSubstitution(), ImageListPager\buildQueryConds(), MediaWiki\Auth\AuthManager\canCreateAccount(), EmailNotification\canSendUserTalkEmail(), ApiMain\checkAsserts(), SpecialBlock\checkUnblockSelf(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), MediaWiki\Auth\AuthManager\continueAuthentication(), Installer\createSysop(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), SpecialContributions\execute(), SpecialDeletedContributions\execute(), SpecialLog\execute(), LoginSignupSpecialPage\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiValidatePassword\execute(), ChangePassword\execute(), TableCleanup\execute(), CreateAndPromote\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), EditCLI\execute(), ImportImages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), InvalidateUserSesssions\execute(), MakeTestEdits\execute(), MoveBatch\execute(), Protect\execute(), ResetUserEmail\execute(), Undelete\execute(), UppercaseTitlesForUnicodeTransition\execute(), UserrightsPage\fetchUser(), LogFormatter\formatParameterValue(), LogFormatter\formatParameterValueForApi(), CoreParserFunctions\gender(), CreditsAction\getAuthor(), WikiPage\getContributors(), WikiPage\getCreator(), RefreshLinksJob\getDataUpdateOptions(), WANCacheReapUpdate\getEventAffectedKeys(), BlockLogFormatter\getMessageParameters(), NewUsersLogFormatter\getMessageParameters(), FindMissingActors\getNewActorId(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getNewPasswordExpiry(), RecentChange\getPerformer(), DatabaseLogEntry\getPerformer(), RCDatabaseLogEntry\getPerformer(), ContribsPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), NewFilesPager\getQueryInfo(), NewPagesPager\getQueryInfo(), Skin\getRelevantUser(), RollbackEdits\getRollbackTitles(), SpecialEmailUser\getTarget(), ContribsPager\getTargetTable(), LocalFile\getUser(), CategoryMembershipChange\getUser(), DoubleRedirectJob\getUser(), ResourceLoaderContext\getUserObj(), WatchedItemQueryService\getUserRelatedConds(), ApiBase\getWatchlistUser(), ImportableOldRevisionImporter\import(), ImportableUploadRevisionImporter\import(), WikiRevision\importLogItem(), RequestContext\importScopedSession(), ReassignEdits\initialiseUser(), LogPager\limitPerformer(), SpecialMute\loadTarget(), CentralIdLookup\localUserFromCentralId(), BotPassword\login(), PasswordReset\lookupUser(), RequestContext\newExtraneousContext(), MediaWiki\Session\UserInfo\newFromName(), WikiPage\onArticleDelete(), RawAction\onView(), InfoAction\pageInfo(), MediaWiki\Block\AbstractBlock\parseTarget(), SpecialBlock\prefixSearchSubpages(), SpecialContributions\prefixSearchSubpages(), SpecialEmailUser\prefixSearchSubpages(), SpecialListFiles\prefixSearchSubpages(), UserrightsPage\prefixSearchSubpages(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), ApiQueryAllImages\run(), ApiQueryRecentChanges\run(), EnotifNotifyJob\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), UserNamePrefixSearch\search(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), MediaWiki\Block\AbstractBlock\setBlocker(), SpecialLog\show(), EditPage\showIntro(), Article\showMissingArticle(), WebInstallerName\submit(), PageArchive\undeleteRevisions(), HTMLUserTextField\validate(), and ApiBase\validateUser().

◆ newFromRow()

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 | null$dataFurther data to load into the object (see User::loadFromRow for valid keys)
Returns
User

Definition at line 699 of file User.php.

References loadFromRow().

Referenced by ApiQueryUserContribs\execute(), ApiQueryUsers\execute(), DatabaseLogEntry\getPerformer(), PasswordReset\getUsersByEmail(), newSystemUser(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), and UserArrayFromResult\setCurrent().

◆ newFromSession()

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

Definition at line 677 of file User.php.

Referenced by RequestContext\getUser().

◆ newSystemUser()

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

Definition at line 740 of file User.php.

References $dbr, createNew(), DB_MASTER, DB_REPLICA, Wikimedia\Rdbms\IDatabase\delete(), getCanonicalName(), getQueryInfo(), INVALID_TOKEN, newFromRow(), Wikimedia\Rdbms\IDatabase\selectRow(), Wikimedia\Rdbms\IDatabase\update(), and wfGetDB().

Referenced by Installer\createMainpage(), AddChangeTag\execute(), CleanupCaps\execute(), CleanupSpam\execute(), TableCleanup\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), EditCLI\execute(), ImportImages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), MoveBatch\execute(), Protect\execute(), RollbackEdits\execute(), Undelete\execute(), UppercaseTitlesForUnicodeTransition\execute(), and PopulateArchiveRevId\makeDummyRevisionRow().

◆ newTouchedTimestamp()

User::newTouchedTimestamp ( )
private

Generate a current or new-future timestamp to be stored in the user_touched field when we update things.

Returns
string Timestamp in TS_MW format

Definition at line 2622 of file User.php.

References wfTimestamp().

Referenced by addToDatabase(), checkAndSetTouched(), and saveSettings().

◆ pingLimiter()

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
Exceptions
MWException

Definition at line 1954 of file User.php.

References $cache, $keys, $wgRateLimits, getGroups(), getId(), getName(), getRequest(), isNewbie(), and isPingLimitable().

Referenced by SpecialChangeEmail\attemptChange(), WikiPage\doRollback(), PasswordReset\execute(), and ChangeTags\updateTagsWithChecks().

◆ purge()

static User::purge (   $dbDomain,
  $userId 
)
static
Since
1.27
Parameters
string$dbDomain
int$userId

Definition at line 421 of file User.php.

References $cache.

Referenced by UserRightsProxy\invalidateCache().

◆ removeGroup()

User::removeGroup (   $group)

Remove the user from the given group.

This takes immediate effect.

Parameters
string$groupName of the group to remove
Returns
bool

Definition at line 3588 of file User.php.

References getEffectiveGroups(), invalidateCache(), load(), and loadGroups().

◆ removeWatch()

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.

Definition at line 3785 of file User.php.

References $title, invalidateCache(), and isAllowed().

Referenced by WatchAction\doUnwatch().

◆ requiresHTTPS()

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

Definition at line 3365 of file User.php.

References $wgForceHTTPS, $wgSecureLogin, getBoolOption(), getRequest(), and wfCanIPUseHTTPS().

◆ resetGetDefaultOptionsForTestsOnly()

static User::resetGetDefaultOptionsForTestsOnly ( )
static

Reset the process cache of default user options.

This is only necessary if the wiki configuration has changed since defaults were calculated, and as such should only be performed inside the testing suite that regularly changes wiki configuration.

Definition at line 1680 of file User.php.

◆ resetIdByNameCache()

static User::resetIdByNameCache ( )
static

Reset the cache used in idFromName().

For use in tests.

Definition at line 913 of file User.php.

◆ resetOptions()

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 [ '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.

Definition at line 3300 of file User.php.

References $context, getDefaultOptions(), getOptionKinds(), and load().

◆ resetTokenFromOption()

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()

Definition at line 3158 of file User.php.

References $wgHiddenPrefs, MWCryptRand\generateHex(), and setOption().

◆ saveOptions()

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().

Definition at line 5266 of file User.php.

References $mOptions, $res, DB_MASTER, getDefaultOption(), getId(), loadOptions(), and wfGetDB().

Referenced by addToDatabase(), and saveSettings().

◆ saveSettings()

◆ selectFields()

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

Definition at line 5332 of file User.php.

References wfDeprecated().

◆ sendConfirmationMail()

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

Definition at line 4528 of file User.php.

References $type, $wgLang, confirmationToken(), confirmationTokenUrl(), getName(), getRequest(), invalidationTokenUrl(), saveSettings(), sendMail(), and wfMessage().

Referenced by setEmailWithConfirmation().

◆ sendMail()

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.
MailAddress | null$replytoReply-To address
Returns
Status

Definition at line 4583 of file User.php.

References $wgPasswordSender, MailAddress\newFromUser(), UserMailer\send(), and wfMessage().

Referenced by sendConfirmationMail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), and setEmailWithConfirmation().

◆ setCookies()

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 | null$secureWhether to force secure/insecure cookies or use default
bool$rememberMeWhether to add a Token cookie for elongated sessions

Definition at line 3943 of file User.php.

References getRequest(), and load().

◆ setEditCountInternal()

User::setEditCountInternal (   $count)

This method should not be called outside User/UserEditCountUpdate.

Parameters
int$count

Definition at line 5081 of file User.php.

◆ setEmail()

User::setEmail (   $str)

Set the user's e-mail address.

Parameters
string$strNew e-mail address

Definition at line 2925 of file User.php.

References invalidateEmail(), and load().

Referenced by setEmailWithConfirmation().

◆ setEmailAuthenticationTimestamp()

User::setEmailAuthenticationTimestamp (   $timestamp)

Set the e-mail authentication timestamp.

Parameters
string$timestampTS_MW timestamp

Definition at line 4698 of file User.php.

References load().

Referenced by confirmEmail(), and invalidateEmail().

◆ setEmailWithConfirmation()

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

Definition at line 2942 of file User.php.

References $type, $wgEmailAuthentication, $wgEnableEmail, getEmail(), getName(), getRequest(), sendConfirmationMail(), sendMail(), setEmail(), and wfMessage().

Referenced by SpecialChangeEmail\attemptChange().

◆ setId()

User::setId (   $v)

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

Parameters
int$vUser ID to reload

Definition at line 2355 of file User.php.

References clearInstanceCache().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().

◆ setInternalPassword()

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.

Definition at line 2768 of file User.php.

References setPasswordInternal(), and wfDeprecated().

◆ setItemLoaded()

User::setItemLoaded (   $item)
protected

Set that an item has been loaded.

Parameters
string$item

Definition at line 1285 of file User.php.

Referenced by getActorId(), loadFromRow(), newFromActorId(), newFromAnyId(), newFromId(), and newFromName().

◆ setName()

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

Definition at line 2392 of file User.php.

References load().

Referenced by MediaWiki\Auth\AuthManager\continueAccountCreation().

◆ setNewtalk()

User::setNewtalk (   $val,
  $curRev = null 
)

Update the 'You have new messages!' status.

Parameters
bool$valWhether the user has new messages
Revision | null$curRevNew, as yet unseen revision of the user talk page. Ignored if null or !$val.

Definition at line 2589 of file User.php.

References deleteNewtalk(), getId(), getName(), invalidateCache(), isAnon(), load(), updateNewtalk(), and wfReadOnly().

Referenced by clearAllNotifications(), and clearNotification().

◆ setOption()

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

Definition at line 3109 of file User.php.

References getDefaultOption(), and loadOptions().

Referenced by resetTokenFromOption(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), and setPasswordInternal().

◆ setPassword()

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

Definition at line 2755 of file User.php.

References setPasswordInternal(), and wfDeprecated().

◆ setPasswordInternal()

User::setPasswordInternal (   $str)
private

Actually set the password and such.

Since
1.27 cannot set a password for a user not in the database
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.
Returns
bool Success

Definition at line 2781 of file User.php.

References changeAuthenticationData(), getName(), and setOption().

Referenced by setInternalPassword(), and setPassword().

◆ setRealName()

User::setRealName (   $str)

Set the user's real name.

Parameters
string$strNew real name

Definition at line 3007 of file User.php.

References load().

◆ setToken()

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

Definition at line 2889 of file User.php.

References MWCryptRand\generateHex(), and load().

Referenced by addToDatabase(), getToken(), MediaWiki\Session\SessionManager\invalidateSessionsForUser(), and MediaWiki\Auth\AuthManager\setDefaultUserOptions().

◆ spreadAnyEditBlock()

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

Definition at line 4296 of file User.php.

References getBlock(), isLoggedIn(), and spreadBlock().

Referenced by MovePage\moveIfAllowed().

◆ spreadBlock()

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

Definition at line 4309 of file User.php.

References getName(), getRequest(), load(), and wfDebug().

Referenced by spreadAnyEditBlock().

◆ touch()

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

Definition at line 2684 of file User.php.

References $cache, and getId().

Referenced by invalidateCache().

◆ trackBlockWithCookie()

User::trackBlockWithCookie ( )

Set the 'BlockID' cookie depending on block type and user authentication status.

Deprecated:
since 1.34 Use BlockManager::trackBlockWithCookie instead

Definition at line 1325 of file User.php.

◆ updateActorId()

User::updateActorId ( IDatabase  $dbw)
private

Update the actor ID after an insert.

Parameters
IDatabase$dbwWritable database handle

Definition at line 4282 of file User.php.

References Wikimedia\Rdbms\IDatabase\insert(), and Wikimedia\Rdbms\IDatabase\insertId().

Referenced by addToDatabase().

◆ updateNewtalk()

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

Definition at line 2544 of file User.php.

References DB_MASTER, wfDebug(), and wfGetDB().

Referenced by setNewtalk().

◆ useFilePatrol()

User::useFilePatrol ( )

Check whether to enable new files patrol features for this user.

Returns
bool True or false

Definition at line 3724 of file User.php.

References $wgUseFilePatrol, $wgUseRCPatrol, and isAllowedAny().

Referenced by ChangesList\isUnpatrolled().

◆ useNPPatrol()

User::useNPPatrol ( )

Check whether to enable new pages patrol features for this user.

Returns
bool True or false

Definition at line 3712 of file User.php.

References $wgUseNPPatrol, $wgUseRCPatrol, and isAllowedAny().

Referenced by WatchedItemQueryService\getWatchedItemsWithRCInfoQueryFilterConds(), ChangesList\isUnpatrolled(), and MediaWiki\Preferences\DefaultPreferencesFactory\rcPreferences().

◆ useRCPatrol()

User::useRCPatrol ( )

◆ validateCache()

User::validateCache (   $timestamp)

Validate the cache for this account.

Parameters
string$timestampA timestamp in TS_MW format
Returns
bool

Definition at line 2699 of file User.php.

References getTouched().

◆ whoIs()

static User::whoIs (   $id)
static

Get the username corresponding to a given user ID.

Parameters
int$idUser ID
Returns
string|bool The corresponding username

Definition at line 851 of file User.php.

References UserCache\singleton().

Referenced by MediaWiki\Permissions\PermissionManager\checkActionPermissions(), ApiBlock\execute(), ApiUnblock\execute(), UserrightsPage\fetchUser(), and ImageListPager\formatValue().

◆ whoIsReal()

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

Definition at line 861 of file User.php.

References UserCache\singleton().

Member Data Documentation

◆ $defOpt

array null User::$defOpt = null
staticprivate

Is the user an IP range?

Since
1.30
Returns
bool

Definition at line 1670 of file User.php.

Referenced by getDefaultOptions().

◆ $defOptLang

string null User::$defOptLang = null
staticprivate

Is the user an IP range?

Since
1.30
Returns
bool

Definition at line 1672 of file User.php.

Referenced by getDefaultOptions().

◆ $idCacheByName

int [] User::$idCacheByName = []
static

Definition at line 219 of file User.php.

◆ $mActorId

int null User::$mActorId
protected

Definition at line 123 of file User.php.

Referenced by getActorId(), and load().

◆ $mAllowUsertalk

bool User::$mAllowUsertalk
protected

Definition at line 210 of file User.php.

Referenced by isAllowUsertalk().

◆ $mBlock

AbstractBlock User::$mBlock

Definition at line 207 of file User.php.

Referenced by isBlockedFromCreateAccount().

◆ $mBlockedby

string User::$mBlockedby

Definition at line 183 of file User.php.

Referenced by blockedBy().

◆ $mBlockedFromCreateAccount

AbstractBlock bool User::$mBlockedFromCreateAccount = false
private

Definition at line 213 of file User.php.

◆ $mBlockreason

string User::$mBlockreason
protected

Definition at line 187 of file User.php.

Referenced by blockedFor().

◆ $mCacheVars

string [] 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.

Definition at line 92 of file User.php.

◆ $mDatePreference

string User::$mDatePreference
protected

Definition at line 181 of file User.php.

Referenced by getDatePreference().

◆ $mEditCount

int User::$mEditCount
protected

Definition at line 144 of file User.php.

Referenced by getEditCount().

◆ $mEffectiveGroups

array User::$mEffectiveGroups
protected

Definition at line 189 of file User.php.

Referenced by getEffectiveGroups().

◆ $mEmail

string User::$mEmail

Definition at line 128 of file User.php.

Referenced by getEmail().

◆ $mEmailAuthenticated

string User::$mEmailAuthenticated

Definition at line 136 of file User.php.

Referenced by getEmailAuthenticationTimestamp().

◆ $mEmailToken

string User::$mEmailToken
protected

Definition at line 138 of file User.php.

◆ $mEmailTokenExpires

string User::$mEmailTokenExpires
protected

Definition at line 140 of file User.php.

◆ $mFormerGroups

array User::$mFormerGroups
protected

Definition at line 193 of file User.php.

Referenced by getFormerGroups().

◆ $mFrom

string User::$mFrom

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.

Definition at line 173 of file User.php.

◆ $mGlobalBlock

AbstractBlock User::$mGlobalBlock
protected

Definition at line 195 of file User.php.

◆ $mGroupMemberships

UserGroupMembership [] User::$mGroupMemberships
protected

Associative array of (group name => UserGroupMembership object)

Definition at line 146 of file User.php.

Referenced by getGroupMemberships().

◆ $mHash

string User::$mHash
protected

Definition at line 185 of file User.php.

◆ $mHideName

bool User::$mHideName

Definition at line 199 of file User.php.

Referenced by isHidden().

◆ $mId

int User::$mId

Cache variables.

Definition at line 119 of file User.php.

Referenced by addToDatabase(), and getId().

◆ $mImplicitGroups

array User::$mImplicitGroups
protected

Definition at line 191 of file User.php.

Referenced by getAutomaticGroups().

◆ $mLoadedItems

array bool User::$mLoadedItems = []
protected

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

Definition at line 160 of file User.php.

Referenced by load().

◆ $mLocked

bool User::$mLocked
protected

Definition at line 197 of file User.php.

Referenced by isLocked().

◆ $mName

string User::$mName

Definition at line 121 of file User.php.

Referenced by addToDatabase(), and getName().

◆ $mNewtalk

int bool User::$mNewtalk
protected

Lazy-initialized variables, invalidated with clearInstanceCache.

Definition at line 179 of file User.php.

Referenced by getNewtalk().

◆ $mOptionOverrides

array User::$mOptionOverrides
protected

Definition at line 148 of file User.php.

◆ $mOptions

array User::$mOptions

Definition at line 201 of file User.php.

Referenced by getOptionKinds(), getOptions(), and saveOptions().

◆ $mOptionsLoaded

bool User::$mOptionsLoaded

Whether the cache variables have been loaded.

Definition at line 155 of file User.php.

◆ $mQuickTouched

string User::$mQuickTouched
protected

TS_MW timestamp from cache.

Definition at line 132 of file User.php.

◆ $mRealName

string User::$mRealName

Definition at line 125 of file User.php.

Referenced by getRealName().

◆ $mRegistration

string User::$mRegistration
protected

Definition at line 142 of file User.php.

Referenced by getRegistration().

◆ $mRequest

WebRequest User::$mRequest
private

Definition at line 204 of file User.php.

Referenced by getRequest().

◆ $mToken

string User::$mToken
protected

Definition at line 134 of file User.php.

Referenced by getToken().

◆ $mTouched

string User::$mTouched

TS_MW timestamp from the DB.

Definition at line 130 of file User.php.

Referenced by getDBTouched(), and getTouched().

◆ $queryFlagsUsed

int User::$queryFlagsUsed = self::READ_NORMAL
protected

User::READ_* constant bitfield used to load data.

Definition at line 216 of file User.php.

◆ $reservedUsernames

string [] false User::$reservedUsernames = false
staticprivate

Cache for self::isUsableName()

Definition at line 114 of file User.php.

◆ CHECK_USER_RIGHTS

const User::CHECK_USER_RIGHTS = true
Since
1.27

Definition at line 78 of file User.php.

◆ GETOPTIONS_EXCLUDE_DEFAULTS

const User::GETOPTIONS_EXCLUDE_DEFAULTS = 1

Exclude user options that are set to their default value.

Since
1.25

Definition at line 73 of file User.php.

Referenced by ResourceLoaderUserOptionsModule\getScript(), and ResourceLoaderUserOptionsModule\isKnownEmpty().

◆ IGNORE_USER_RIGHTS

◆ INVALID_TOKEN

const User::INVALID_TOKEN = '*** INVALID ***'

An invalid string value for the user_token field.

Definition at line 61 of file User.php.

Referenced by newSystemUser().

◆ TOKEN_LENGTH

const User::TOKEN_LENGTH = 32

Number of characters required for the user_token field.

Definition at line 56 of file User.php.

Referenced by BotPassword\save().

◆ VERSION

const User::VERSION = 14

Version number to tag cached versions of serialized User objects.

Should be increased when $mCacheVars or one of it's members changes.

Definition at line 67 of file User.php.

Referenced by loadFromCache().


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