interface EntityPublishedInterface in Drupal 10

Provides an interface for access to an entity's published state.

Hierarchy

• interface \Drupal\Core\Access\AccessibleInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface; interface \Drupal\Core\Cache\RefinableCacheableDependencyInterface
  • interface \Drupal\Core\Entity\EntityInterface
    • interface \Drupal\Core\Entity\EntityPublishedInterface

23 files declare their use of EntityPublishedInterface

BlockContentInterface.php in core/modules/block_content/src/BlockContentInterface.php

CommentInterface.php in core/modules/comment/src/CommentInterface.php

CommonCollectionFilterAccessTestPatternsTrait.php in core/modules/jsonapi/tests/src/Traits/CommonCollectionFilterAccessTestPatternsTrait.php

ContentModeration.php in core/modules/content_moderation/src/Plugin/WorkflowType/ContentModeration.php

content_moderation.module in core/modules/content_moderation/content_moderation.module

Contains content_moderation.module.

... See full list

File

core/lib/Drupal/Core/Entity/EntityPublishedInterface.php, line 8

Namespace

Drupal\Core\Entity

interface EntityPublishedInterface extends EntityInterface {

  /**
   * Returns whether or not the entity is published.
   *
   * @return bool
   *   TRUE if the entity is published, FALSE otherwise.
   */
  public function isPublished();

  /**
   * Sets the entity as published.
   *
   * @return $this
   *
   * @see \Drupal\Core\Entity\EntityPublishedInterface::setUnpublished()
   */
  public function setPublished();

  /**
   * Sets the entity as unpublished.
   *
   * @return $this
   */
  public function setUnpublished();

}