class NodeUnpublish

Unpublishes a content item.

Plugin annotation

@RulesAction(
  id = "rules_node_unpublish",
  label = @Translation("Unpublish a content item"),
  category = @Translation("Content"),
  context_definitions = {
    "node" = @ContextDefinition("entity:node",
      label = @Translation("Node"),
      description = @Translation("Specifies the content item to unpublish."),
      assignment_restriction = "selector"
    ),
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
    • class \Drupal\rules\Core\RulesActionBase extends \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\rules\Plugin\RulesAction\NodeUnpublish implements \Drupal\rules\Core\RulesActionBase

Expanded class hierarchy of NodeUnpublish

File

src/Plugin/RulesAction/NodeUnpublish.php, line 24

Namespace

class NodeUnpublish extends RulesActionBase {
  
  /**
   * Unpublishes the Node.
   *
   * @param \Drupal\Core\Entity\NodeInterface $node
   *   The node to modify.
   */
  protected function doExecute(NodeInterface $node) {
    $node->setUnpublished();
  }
  
  /**
   * {@inheritdoc}
   */
  public function autoSaveContext() {
    // The node should be auto-saved after the execution.
    return [
      'node',
    ];
  }

}

Members