#Interface: ApiBlockInfo

Defined in: core/query/users.ts:15

Block details, as emitted for usprop=blockinfo (list=users) and uiprop=blockinfo (meta=userinfo). Only present when the user is blocked. The same shape is shared by ApiUser.blockcomponents entries.

#Extended by

• ApiUserCore

#Properties

#blockanononly?

optional blockanononly?: boolean

Defined in: core/query/users.ts:52

Whether the block only affects anonymous users (soft block). A real boolean.

---

#blockautoblocking?

optional blockautoblocking?: boolean

Defined in: core/query/users.ts:83

Whether the block also enables the autoblock feature. A real boolean.

#Since

MediaWiki 1.46

---

#blockcomponents?

optional blockcomponents?: ApiBlockInfo[]

Defined in: core/query/users.ts:76

The individual blocks composing this one; only for composite blocks.

#Since

MediaWiki 1.42

---

#blockedby?

optional blockedby?: string

Defined in: core/query/users.ts:20

User name of the blocker; '' when unknown (e.g. autoblocks).

---

#blockedbyid?

optional blockedbyid?: number

Defined in: core/query/users.ts:23

User id of the blocker; 0 when unknown.

---

#blockedtimestamp?

optional blockedtimestamp?: string

Defined in: core/query/users.ts:29

When the block was placed or last modified.

---

#blockedtimestampformatted?

optional blockedtimestampformatted?: string

Defined in: core/query/users.ts:34

blockedtimestamp localized for the requesting user.

---

#blockemail?

optional blockemail?: boolean

Defined in: core/query/users.ts:59

Whether the block prevents sending email. A real boolean.

#Since

MediaWiki 1.41

---

#blockexpiry?

optional blockexpiry?: string

Defined in: core/query/users.ts:37

Block expiry; the literal infinite when the block does not expire.

---

#blockexpiryformatted?

optional blockexpiryformatted?: string

Defined in: core/query/users.ts:40

blockexpiry localized for the requesting user; only when the block expires.

---

#blockexpiryrelative?

optional blockexpiryrelative?: string

Defined in: core/query/users.ts:43

Human-readable time to expiry (e.g. in 5 days); only when the block expires.

---

#blockhidden?

optional blockhidden?: true

Defined in: core/query/users.ts:91

The block itself is suppressed (hidden from users without the hideuser right). A Flag, present only when suppressed.

#Since

MediaWiki 1.47

---

#blockid?

optional blockid?: number

Defined in: core/query/users.ts:17

ID of the block.

---

#blocknocreate?

optional blocknocreate?: boolean

Defined in: core/query/users.ts:49

Whether the block prevents account creation. A real boolean.

---

#blockowntalk?

optional blockowntalk?: boolean

Defined in: core/query/users.ts:66

Whether editing one's own talk page is prevented. A real boolean.

#Since

MediaWiki 1.41

---

#blockpartial?

optional blockpartial?: boolean

Defined in: core/query/users.ts:46

Whether the block only applies to certain pages, namespaces and/or actions. A real boolean.

---

#blockreason?

optional blockreason?: string

Defined in: core/query/users.ts:26

Block reason, in plain text.

---

#systemblocktype?

optional systemblocktype?: string

Defined in: core/query/users.ts:69

Type of the automatically applied system block; only for system blocks.