yaffs.net Git - yaffs-website/blob - web/core/modules/content_moderation/content_moderation.api.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * API documentation for Content Moderation module.
   6  */
   7
   8 /**
   9  * @defgroup content_moderation_plugin Content Moderation Workflow Type Plugin
  10  * @{
  11  * The Workflow Type plugin implemented by Content Moderation links revisionable
  12  * entities to workflows.
  13  *
  14  * In the Content Moderation Workflow Type Plugin, one method requires the
  15  * entity object to be passed in as a parameter, even though the interface
  16  * defined by Workflows module doesn't require this:
  17  * @code
  18  * $workflow_type_plugin->getInitialState($entity);
  19  * @endcode
  20  * This is used to determine the initial moderation state based on the
  21  * publishing status of the entity.
  22  * @}
  23  */