Allow custom form state to be passed to entity_get_form()

In general this change is great except a documentation.

+++ b/core/includes/entity.incundefined
@@ -484,12 +485,16 @@ function entity_form_submit(EntityInterface $entity, $operation = 'default', &$f
+ * @param array $form_state
+ *   (optional) An associative array containing the current state of the form.
  *
  * @return
  *   The processed form for the given entity and operation.
  */
-function entity_get_form(EntityInterface $entity, $operation = 'default', $langcode = NULL) {
-  $form_state = entity_form_state_defaults($entity, $operation, $langcode);
+function entity_get_form(EntityInterface $entity, $operation = 'default', array $form_state = array()) {
+  $form_state += entity_form_state_defaults($entity, $operation);
+  // Add in any other arguments, removing $entity, $operation, and $form_state.
+  $form_state['build_info']['args'] += array_slice(func_get_args(), 3, NULL, TRUE);

Suppose doc-block should be extended by mentioning about ability to get a set of additional parameters

Awesome, this might/will pave the way to get #1510544: Allow to preview content in an actual live environment forward - even if it doesn't land in core, I'd be tempted to create a contrib for it. And yes, I can imagine other contrib modules needing this, so +10 from me

Did a quick test with the patch mentioned in #3 and this works nice, so I'm all for it, so this a ok for me!

hm, I'm a bit worried on that as it's impossible to generally embed/use an entity form then, you'd have to know about the arguments.

I'd be curious about the use-case here? Is that really needed?

Damn this is good stuff!

Patch looks good, just one thing:

+++ b/core/includes/entity.inc
@@ -484,12 +483,14 @@ function entity_form_submit(EntityInterface $entity, $operation = 'default', &$f
+ * @param array $form_state
+ *   (optional) An associative array containing the current state of the form.
  *
  * @return
  *   The processed form for the given entity and operation.
  */
-function entity_get_form(EntityInterface $entity, $operation = 'default', $langcode = NULL) {
-  $form_state = entity_form_state_defaults($entity, $operation, $langcode);
+function entity_get_form(EntityInterface $entity, $operation = 'default', array $form_state = array()) {
+  $form_state += entity_form_state_defaults($entity, $operation);

Here is a regression: No (documented) way to pass in the desired language.
Also, when would I pass the form state and when not? This misses docs.

yes, it was not nice before either, but at least their was an obvious parameter. Docs improvements are good, back to RTBC.

Tidy. Committed/pushed to 8.x, could use a change notice.

Adding tag.

Working on a change notification

Here's my draft for the notice:

Summary

• Allows entity_get_form() to pass along additional information, to preserve compatibility with use cases covered by drupal_get_form().
• Cleans up the arguments to entity_get_form() and entity_form_state_defaults().
• The $langcode argument for entity_get_form() can now be passed as a value in the $form_state array.

Before

<?php
  function entity_form_state_defaults(EntityInterface $entity, $operation = 'default', $langcode = NULL) { }
  function entity_get_form(EntityInterface $entity, $operation = 'default', $langcode = NULL) { }
?>

After

<?php
  function entity_form_state_defaults(EntityInterface $entity, $operation = 'default', array $form_state = array()) { }
  function entity_get_form(EntityInterface $entity, $operation = 'default') { }
?>

impacts: Module Developers

Bumping to critical for the change notice - can we please get a review on the proposed change notice in #20?

@tim.plunkett - I thought so too (the change notice is from a local sprint I mentored) but see this revision note from https://drupal.org/contributor-tasks/draft-change-notification :

Change notifications are now tweeted and posted to RSS automatically, so we need to check that they are correct before they are submitted. Therefore, ask contributors to post the text in the issue for review.

Zombie tag.