Function __global->cns_ban_member

Definitions

sources/cns_members_action2.php

  • Ban a member.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id AUTO_LINK No No required parameter N/A N/A The ID of the member
$reasoned_ban ID_TEXT No No 1 N/A N/A The reasoned ban value ('1' is just a regular ban, the norm)
$automatic boolean No No False N/A N/A Whether it is an automatic ban

Preview

Code (PHP)

/**
 * Ban a member.
 *
 * @param  AUTO_LINK $member_id The ID of the member
 * @param  ID_TEXT $reasoned_ban The reasoned ban value ('1' is just a regular ban, the norm)
 * @param  boolean $automatic Whether it is an automatic ban
 */
function cns_ban_member(int $member_id, string $reasoned_ban = '1', bool $automatic = false)