class UnpublishByKeywordNode

Same name in other branches
  1. 8.9.x core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php \Drupal\node\Plugin\Action\UnpublishByKeywordNode
  2. 10 core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php \Drupal\node\Plugin\Action\UnpublishByKeywordNode
  3. 11.x core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php \Drupal\node\Plugin\Action\UnpublishByKeywordNode
  4. 10 core/modules/action/src/Plugin/Action/UnpublishByKeywordNode.php \Drupal\action\Plugin\Action\UnpublishByKeywordNode

Unpublishes a node containing certain keywords.

Plugin annotation


@Action(
  id = "node_unpublish_by_keyword_action",
  label = @Translation("Unpublish content containing keyword(s)"),
  type = "node"
)

Hierarchy

Expanded class hierarchy of UnpublishByKeywordNode

File

core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php, line 19

Namespace

Drupal\node\Plugin\Action
View source
class UnpublishByKeywordNode extends ConfigurableActionBase {
    
    /**
     * {@inheritdoc}
     */
    public function execute($node = NULL) {
        $elements = \Drupal::entityTypeManager()->getViewBuilder('node')
            ->view(clone $node);
        $render = \Drupal::service('renderer')->render($elements);
        foreach ($this->configuration['keywords'] as $keyword) {
            if (strpos($render, $keyword) !== FALSE || strpos($node->label(), $keyword) !== FALSE) {
                $node->setUnpublished();
                $node->save();
                break;
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'keywords' => [],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['keywords'] = [
            '#title' => $this->t('Keywords'),
            '#type' => 'textarea',
            '#description' => $this->t('The content will be unpublished if it contains any of the phrases above. Use a case-sensitive, comma-separated list of phrases. Example: funny, bungee jumping, "Company, Inc."'),
            '#default_value' => Tags::implode($this->configuration['keywords']),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['keywords'] = Tags::explode($form_state->getValue('keywords'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
        
        /** @var \Drupal\node\NodeInterface $object */
        $access = $object->access('update', $account, TRUE)
            ->andIf($object->status
            ->access('edit', $account, TRUE));
        return $return_as_object ? $access : $access->isAllowed();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
ConfigurableActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
ConfigurableActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableActionBase::__construct public function 6
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
UnpublishByKeywordNode::access public function Checks object access. Overrides ActionInterface::access
UnpublishByKeywordNode::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
UnpublishByKeywordNode::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
UnpublishByKeywordNode::execute public function Executes the plugin. Overrides ExecutableInterface::execute
UnpublishByKeywordNode::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.