Security update for Core, with self-updated composer
[yaffs-website] / web / core / modules / content_moderation / content_moderation.api.php
diff --git a/web/core/modules/content_moderation/content_moderation.api.php b/web/core/modules/content_moderation/content_moderation.api.php
new file mode 100644 (file)
index 0000000..a56813e
--- /dev/null
@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @file
+ * API documentation for Content Moderation module.
+ */
+
+/**
+ * @defgroup content_moderation_plugin Content Moderation Workflow Type Plugin
+ * @{
+ * The Workflow Type plugin implemented by Content Moderation links revisionable
+ * entities to workflows.
+ *
+ * In the Content Moderation Workflow Type Plugin, one method requires the
+ * entity object to be passed in as a parameter, even though the interface
+ * defined by Workflows module doesn't require this:
+ * @code
+ * $workflow_type_plugin->getInitialState($entity);
+ * @endcode
+ * This is used to determine the initial moderation state based on the
+ * publishing status of the entity.
+ * @}
+ */