class UnpublishByKeywordNode in Drupal 10

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

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableInterface, DependentPluginInterface, PluginFormInterface
        • class \Drupal\node\Plugin\Action\UnpublishByKeywordNode

File

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

Namespace

Drupal\node\Plugin\Action

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' => t('Keywords'),
      '#type' => 'textarea',
      '#description' => 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();
  }

}