content_moderation.api.php 669 B

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