Function __global->_deal_with_chatcode_private

Definitions

sources/chat.php

  • Parse private message chat code tag.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$pm_user string No No required parameter N/A N/A The member a private message should be sent to
$pm_message string No No required parameter N/A N/A The private message
$username SHORT_TEXT No No required parameter N/A N/A The username of who made this chatcode
$text string No No required parameter N/A N/A The text we are using
$room_id AUTO_LINK No No required parameter N/A N/A The room ID the message is in
$system_message BINARY No No required parameter N/A N/A Whether this is within a system message

Returns

  • A pair: whether the message was deleted, and the new text of the message
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Parse private message chat code tag.
 *
 * @param  string $pm_user The member a private message should be sent to
 * @param  string $pm_message The private message
 * @param  SHORT_TEXT $username The username of who made this chatcode
 * @param  string $text The text we are using
 * @param  AUTO_LINK $room_id The room ID the message is in
 * @param  BINARY $system_message Whether this is within a system message
 * @return array A pair: whether the message was deleted, and the new text of the message
 */
function _deal_with_chatcode_private(string $pm_user, string $pm_message, string $username, string $text, int $room_id, int $system_message) : array