function comment_unpublish_action

1.20.x comment.module comment_unpublish_action($comment, $context = array())

Unpublishes a comment.

Parameters

$comment: An optional comment object.

array $context: Array with components:

'cid': Comment ID. Required if $comment is not given.

Related topics

Actions Functions that perform an action on a certain system object.

1 call to comment_unpublish_action()

CommentActionsTestCase::testCommentPublishUnpublishActions in modules/comment/tests/comment.test: Tests comment publish and unpublish actions.

2 string references to 'comment_unpublish_action'

comment_action_info in modules/comment/comment.module: Implements hook_action_info().
hook_action_info in modules/system/system.api.php: Declares information about actions.

File

modules/comment/comment.module, line 2381: Enables users to comment on published content.

Code

function comment_unpublish_action($comment, $context = array()) {
  $comment->status = COMMENT_NOT_PUBLISHED;
  $comment->save();
}