function User::block

Blocks the user.

Return value

$this The called user entity.

Overrides UserInterface::block

File

core/modules/user/src/Entity/User.php, line 330

Class

User
Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function block() {
  $this->get('status')->value = 0;
  return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.