MediaWiki\User\UserIdentity Interface Reference

Interface for objects representing user identity. More...

Inherits MediaWiki\DAO\WikiAwareEntity.

Inherited by MediaWiki\User\User, MediaWiki\User\UserIdentityValue, and MediaWiki\User\UserRightsProxy.

Collaboration diagram for MediaWiki\User\UserIdentity:

Public Member Functions
	equals (?UserIdentity $user)
	getId ( $wikiId=self::LOCAL)
	getName ()
	isRegistered ()
	This must be equivalent to getId() != 0 and is provided for code readability.
Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
	assertWiki ( $wikiId)
	Throws if $wikiId is different from the return value of getWikiId().
	getWikiId ()
	Get the ID of the wiki this page belongs to.

Detailed Description

Interface for objects representing user identity.

This represents the identity of a user in the context of page revisions and log entries.

Note

Starting MediaWiki 1.37, UserIdentity objects should no longer expose an actor ID. The actor ID is considered a storage layer optimization and should not be exposed to and used by application logic. Storage layer code should use ActorNormalization to get an actor ID for a UserIdentity.

Since

1.31

Definition at line 39 of file UserIdentity.php.

Member Function Documentation

equals()

MediaWiki\User\UserIdentity::equals

(

?UserIdentity

$user

)

Since

1.32

Parameters

UserIdentity | null

$user

Returns

bool

Implemented in MediaWiki\User\User, MediaWiki\User\UserIdentityValue, and MediaWiki\User\UserRightsProxy.

Referenced by MediaWiki\Block\BlockPermissionChecker\checkBlockPermissions().

getId()

MediaWiki\User\UserIdentity::getId

(

$wikiId = self::LOCAL

)

Since

1.31

Parameters

string | false

$wikiId

The wiki ID expected by the caller

Returns

int The user ID. May be 0 for anonymous users or for users with no local account.

Implemented in MediaWiki\User\User, MediaWiki\User\UserIdentityValue, and MediaWiki\User\UserRightsProxy.

Referenced by UserEditCountUpdate\__construct(), MediaWiki\User\ActorCache\add(), MediaWiki\Permissions\PermissionManager\addTemporaryUserRights(), MediaWiki\Block\BlockPermissionChecker\checkBlockPermissions(), MediaWiki\User\TalkPageNotificationManager\clearForPageView(), MediaWiki\User\UserEditTracker\clearUserEditCache(), WatchedItemStore\countUnreadNotifications(), WikiPage\doUpdateRestrictions(), ApiBlock\execute(), MediaWiki\User\ActorMigrationBase\getInsertValues(), MediaWiki\User\ActorMigrationBase\getInsertValuesWithTempTable(), MediaWiki\Watchlist\WatchlistManager\getTitleNotificationTimestamp(), MediaWiki\User\UserEditTracker\incrementUserEditCount(), MediaWiki\User\UserFactory\invalidateCache(), LogFormatter\makeUserLink(), RecentChange\newForCategorization(), ClearUserWatchlistJob\newForUser(), WatchedItemStore\resetAllNotificationTimestampsForUser(), and MediaWiki\User\UserEditTracker\setCachedUserEditCount().

getName()

MediaWiki\User\UserIdentity::getName

(

)

Since

1.31

Returns

string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.

Implemented in MediaWiki\User\User, MediaWiki\User\UserIdentityValue, and MediaWiki\User\UserRightsProxy.

Referenced by MediaWiki\Pager\ContribsPager\__construct(), MediaWiki\User\ActorCache\add(), MediaWiki\Storage\PageEditStash\checkCache(), PasswordPolicyChecks\checkPasswordCannotBeSubstringInUsername(), PasswordPolicyChecks\checkPasswordCannotMatchDefaults(), WikiPage\doEditUpdates(), ApiQueryUserInfo\getCentralUserInfo(), MediaWiki\User\ActorMigrationBase\getInsertValues(), MediaWiki\User\ActorMigrationBase\getInsertValuesWithTempTable(), MediaWiki\User\StaticUserOptionsLookup\getOptions(), MediaWiki\Specials\SpecialBlock\getTargetUserTitle(), Parser\getUserSig(), MediaWiki\User\UserIdentityUtils\isNamed(), MediaWiki\User\UserIdentityUtils\isTemp(), LogFormatter\makeUserLink(), RecentChange\newForCategorization(), MediaWiki\Block\DatabaseBlock\newLoad(), MediaWiki\Specials\SpecialBlock\preHtml(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), WikiPage\prepareContentForEdit(), and MediaWiki\Storage\PageUpdater\updateAuthor().

isRegistered()

MediaWiki\User\UserIdentity::isRegistered

(

)

This must be equivalent to getId() != 0 and is provided for code readability.

There is no equivalent utility for checking whether a user is temporary, since that would introduce a service dependency. Use UserIdentityUtils::isTemp (or UserNameUtils::isTemp) instead.

Since

1.34

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

Implemented in MediaWiki\User\User, MediaWiki\User\UserIdentityValue, and MediaWiki\User\UserRightsProxy.

Referenced by MediaWiki\Storage\PageEditStash\checkCache(), MediaWiki\Watchlist\WatchlistManager\getTitleNotificationTimestamp(), Parser\getUserSig(), WatchedItemStore\getWatchedItem(), WatchedItemQueryService\getWatchedItemsForUser(), MediaWiki\User\UserFactory\invalidateCache(), MediaWiki\User\UserIdentityUtils\isNamed(), WatchedItemStore\loadWatchedItemsBatch(), WatchedItemStore\resetAllNotificationTimestampsForUser(), and MediaWiki\Specials\SpecialUserRights\userCanChangeRights().

---

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

• includes/user/UserIdentity.php