Function __global->chat_room_prune

Definitions

sources/chat.php

  • Prune membership of chatroom.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$room_id ?AUTO_LINK No No required parameter N/A N/A Room ID (null: all rooms)

Preview

Code (PHP)

/**
 * Prune membership of chatroom.
 *
 * @param  ?AUTO_LINK $room_id Room ID (null: all rooms)
 */
function chat_room_prune(?int $room_id)