You are here

Home » API reference » Privatemsg 6.2 » privatemsg.module

function privatemsg_message_change_delete in Privatemsg 6.2

Same name and namespace in other branches
  1. 6 privatemsg.module \privatemsg_message_change_delete()
  2. 7.2 privatemsg.module \privatemsg_message_change_delete()
  3. 7 privatemsg.module \privatemsg_message_change_delete()

Delete or restore a message.

Parameters

$pmid: Message id, pm.mid field.

$delete: Either deletes or restores the thread (1 => delete, 0 => restore)

$account: User acccount for which the delete action should be carried out - Set to NULL to delete for all users.

Related topics

API functions
There are two different functions to send messages. Either by starting a new thread or reply to an existing thread.
2 calls to privatemsg_message_change_delete()
PrivatemsgTestCase::testPrivatemsgFlush in ./privatemsg.test
Tests for the flush feature
privatemsg_delete_submit in ./privatemsg.pages.inc

File

./privatemsg.module, line 1543
Allows users to send private messages to other users.

Code

function privatemsg_message_change_delete($pmid, $delete, $account = NULL) {
  $delete_value = 0;
  if ($delete == TRUE) {
    $delete_value = time();
  }
  if ($account) {
    db_query("UPDATE {pm_index} SET deleted = %d WHERE mid = %d AND recipient = %d AND type IN ('user', 'hidden')", $delete_value, $pmid, $account->uid);
  }
  else {

    // Mark deleted for all users.
    db_query('UPDATE {pm_index} SET deleted = %d WHERE mid = %d', $delete_value, $pmid);
  }

  // Allow modules to respond to the deleted changes.
  module_invoke_all('privatemsg_message_status_delete', $pmid, $delete, $account);
}