Function __global->get_chatroom_name
Definitions
sources/chat.php
- Get the textual name of the specified chatroom, from its room ID.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $room_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The room ID |
| $allow_null | boolean | No | No | False | N/A | N/A | Allow the chatroom to not be found (i.e. don't die if it can't be) |
Returns
- The room name (null: not found)
- Type: ?SHORT_TEXT
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the textual name of the specified chatroom, from its room ID.
*
* @param AUTO_LINK $room_id The room ID
* @param boolean $allow_null Allow the chatroom to not be found (i.e. don't die if it can't be)
* @return ?SHORT_TEXT The room name (null: not found)
*/
function get_chatroom_name(int $room_id, bool $allow_null = false) : ?string
* Get the textual name of the specified chatroom, from its room ID.
*
* @param AUTO_LINK $room_id The room ID
* @param boolean $allow_null Allow the chatroom to not be found (i.e. don't die if it can't be)
* @return ?SHORT_TEXT The room name (null: not found)
*/
function get_chatroom_name(int $room_id, bool $allow_null = false) : ?string
