interface EntityPublishedInterface

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 extends \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface \Drupal\Core\Cache\CacheableDependencyInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface
    • interface \Drupal\Core\Entity\EntityPublishedInterface extends \Drupal\Core\Entity\EntityInterface

Expanded class hierarchy of EntityPublishedInterface

All classes that implement EntityPublishedInterface

Related topics

File

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

Namespace

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();

}

Members