class UnpublishComment

Unpublishes a comment.

Plugin annotation

@Action(
  id = "comment_unpublish_action",
  label = @Translation("Unpublish comment"),
  type = "comment"
)

Hierarchy

Expanded class hierarchy of UnpublishComment

File

drupal/core/modules/comment/lib/Drupal/comment/Plugin/Action/UnpublishComment.php, line 23

Contains \Drupal\comment\Plugin\Action\UnpublishComment.

Namespace

class UnpublishComment extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function execute($comment = NULL) {
    $comment->status->value = COMMENT_NOT_PUBLISHED;
    $comment
      ->save();
  }

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	2
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	17
UnpublishComment::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute