Function __global->cns_delete_forum

Definitions

sources/cns_forums_action2.php

  • Delete a forum.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$forum_id AUTO_LINK No No required parameter N/A N/A The ID of the forum we are deleting
$target_forum_id ?AUTO_LINK No No Null N/A N/A The ID of the forum that topics will be moved to (null: root forum)
$delete_topics BINARY No No 0 N/A N/A Whether to delete topics instead of moving them to the target forum
$reverse_point_transaction boolean No No False N/A N/A Whether to reverse the points of all the posts in this forum (ignored if not $delete_topics)

Preview

Code (PHP)

/**
 * Delete a forum.
 *
 * @param  AUTO_LINK $forum_id The ID of the forum we are deleting
 * @param  ?AUTO_LINK $target_forum_id The ID of the forum that topics will be moved to (null: root forum)
 * @param  BINARY $delete_topics Whether to delete topics instead of moving them to the target forum
 * @param  boolean $reverse_point_transaction Whether to reverse the points of all the posts in this forum (ignored if not $delete_topics)
 */
function cns_delete_forum(int $forum_id, ?int $target_forum_id = null, int $delete_topics = 0, bool $reverse_point_transaction = false)