>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #1031010. --> Reported by: [fago](https://www.drupal.org/user/16747) >>> <p>Currently, the Field Collection module does not support revisions. To add this support, we need to create a separate revision of each Field Collection item for each revision of the entity host.</p> <h2>Dependencies</h2> <p>Adding full revision support for the Field Collection module requires the <a href="https://www.drupal.org/project/entity">Entity API</a> to support revisions:</p> <p><span class="drupalorg-gitlab-issue-link drupalorg-gitlab-link-wrapper"><a href="https://git.drupalcode.org/project/entity/-/work_items/996696" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/entity/-/work_items/996696</a></span></p> <p>It has been committed.</p> <h2>History</h2> <p>The initial approach to fixing this issue was to create a simple patch that creates a new Field Collection item when the host entity creates a revision. <a href="http://drupal.org/node/1031010#comment-5780940">This patch was discussed and it was decided</a> that the best long term approach is to have "proper" revisions for Field Collection items which requires the Entity API to support revisions. The issue was postponed for a time so that the Entity API module could be updated to support revisions. Once a patch for Entity API revisions became available, a patch was started to create Field Collection item revisions when the host entity creates a revision. This patch is being actively worked on.</p> <h2>Current Status</h2> <p>Per above, there are two patch methods available. Note: if you need a very quick stop-gap method to work with nested Field Collection items, check out comment <a href="https://www.drupal.org#comment-6157500">#90</a>.</p> <h3>Patch method 1</h3> <p>A simple patch that creates a new Field Collection item each time the host entity creates a revision: <a href="https://www.drupal.org#comment-5774500">#37</a>.</p> <p><strong>Pros:</strong></p> <ul> <li>Simple change</li> <li>Appears to work as designed</li> <li>Can be a stop-gap measure until full-revision patch is available</li> </ul> <p><strong>Cons:</strong></p> <ul> <li>Not scalable so not advised for content with lots of revisions</li> <li>Not the best-practice approach for supporting revisions</li> <li>Does not work with nested Field Collection items</li> </ul> <h3>Patch method 2</h3> <p>A complex patch that creates a new Field Collection item revision each time the host entity creates a revision. This patch is being actively worked on, so check the latest comments for the most recent version.</p> <p><strong>Pros:</strong></p> <ul> <li>Scalable</li> <li>Best-practice approach for supporting revisions</li> </ul> <p><strong>Cons:</strong></p> <ul> <li>Complex patch</li> <li>Will require a lot of review and testing</li> <li>Requires vetting from maintainers or others familiar with Field Collection, Entity API, and Field API codebase</li> </ul> <h2>How to test</h2> <ol> <li>IMPORTANT! Use a test database / site.</li> <li>Installation: <ul> <li>Install dev versions of <a href="https://www.drupal.org/project/entity">Entity API</a> and <a href="https://www.drupal.org/project/field_collection">Field Collection</a> modules</li> <li>Apply <a href="http://drupal.org/node/996696#comment-6043122">patch for Entity API revisions</a></li> <li>Apply patch for this issue (find latest version for testing)</li> <li>Run update.php</li> </ul> </li><li>Setup <ul> <li>Add an embedded Field Collection (FC) field to a content type (e.g. Test field for article content type)</li> <li>Add a text field to the FC (e.g. Test Text field)</li> <li>Create a node of the relevant type</li> <li>Fill in the node Title, Body, and Test Text field</li> <li>Save the node</li> </ul> </li> <li>No new revision <ul> <li>Edit the node and change the Test Text field text to "TEST ONE"</li> <li>Do not check "Create new revision" and save the node</li> <li>Published node should show "TEST ONE"</li> </ul> </li> <li>New revision <ul> <li>Edit the node and change the Test Text field text to "TEST TWO"</li> <li>Check "Create new revision" and save the node</li> <li>Published node should show "TEST TWO"</li> <li>View the previous revision - it should have the Test Text: "TEST ONE"</li> </ul> </li> <li>Changing revisions <ul> <li>Revert back to the previous revision</li> <li>Published node should show "TEST ONE"</li> <li>View the 2nd revision - it should have the Test Text: "TEST TWO"</li> </ul> </li> <li>Edit/Delete/Add links <ul> <li>TODO: Testing instructions need to be added for these links</li> </ul> </li> </ol> <h2>Testing with Workbench Moderation</h2> <ol> <li>Installation <ul> <li>Install <a href="https://www.drupal.org/project/workbench">Workbench</a> and <a href="https://www.drupal.orgworkbench_moderation">Workbench Moderation</a></li> </ul> </li> <li>Setup <ul> <li>Make sure that your user has permission to use Workbench and Workbench Moderation</li> <li>Default publishing workflow states are sufficient (e.g Draft, Needs Review, and Published)</li> <li>Configure content type to use moderation</li> <li>Create a node of the relevant type</li> <li>Fill in the node Title, Body, and Test Text field</li> <li>Save the node</li> </ul> </li> <li>Create Draft <ul> <li>Create a new Draft</li> <li>Change the Test Text field text to "WB TEST ONE"</li> <li>Draft node should show "WB TEST ONE"</li> <li>Published node should show original text</li> </ul> </li> <li>Publish Draft <ul> <li>Publish Draft</li> <li>Published node should show "WB TEST ONE"</li> <li>View the previous revision - it should have the original Test Text</li> </ul> </li> <li>Revert versions <ul> <li>Go to the moderation list</li> <li>Revert to original node</li> <li>Should create new draft</li> <li>Publish draft</li> <li>Published node should show original text</li> </ul> </li> </ol> > Related issue: [Issue #996696](https://www.drupal.org/node/996696) > Related issue: [Issue #1186552](https://www.drupal.org/node/1186552)