entity_metadata_form_user() builds incorrect form in some circumstances

Tested and working fine here.

Any maintainers got a few minutes to roll this patch in?

I created a manual test by calling drupal_get_form('user_register_form'); and entity_metadata_form_user($user); separately, and running a diff between the resulting form arrays.

The first big difference that I noticed is that when the profile2 module is enabled, it attaches it's own form api callbacks to the form's #validate and #submit parameters:

Example:
User Register form:

  '#user_category' => 'register',
 ...
  '#validate' => 
  array (
    0 => 'user_account_form_validate',
    1 => 'user_validate_picture',
    2 => 'user_register_validate',
    3 => 'profile2_form_validate_handler',
  ),
..
  '#submit' => 
  array (
    0 => 'metatag_metatags_form_submit',
    1 => 'user_register_submit',
    2 => 'profile2_form_submit_handler',
  ),

User Profile form:

  '#user_category' => 'account',
  '#validate' => 
  array (
    0 => 'user_account_form_validate',
    1 => 'user_validate_picture',
    2 => 'user_profile_form_validate',
  ),
...
  '#submit' => 
  array (
    0 => 'metatag_metatags_form_submit',
    1 => 'user_profile_form_submit',
  ),

The second big difference was that on the user register form, a profile2 entity got attached to the form under the profile_main key.

This means that integration with Entity API is broken for Profile2 users because they don't get profile entity fields attached to the anonymous user form - at least for this use case.

Example attached profile2 entity:

 'profile_main' => 
  array (
    '#tree' => true,
    '#parents' => 
    array (
      0 => 'profile_main',
    ),
    '#entity' => 
    Profile::__set_state(array(
       'pid' => NULL,
       'type' => 'main',
       'label' => 'Main profile',
       'uid' => NULL,
       'created' => NULL,
       'changed' => NULL,
       'entityType' => 'profile2',
       'entityInfo' => 
      array (
        'label' => 'Profile',
        'plural label' => 'Profiles',
        'description' => 'Profile2 user profiles.',
        'entity class' => 'Profile',
        'controller class' => 'EntityAPIController',
...

Other minor changes include:

- User profile form (user_profile_form) shows Time Zone options, registration form (user_register_form) does not.
- Form submit button on user_register_form reads: "Create new account".
- Form submit button on user_profile_form reads: "Save"

Based on this test, committing that patch would be at least beneficial for Profile2 users. But I can see how it's probably affecting any module that depends on the entity_metadata_form_user function.

I've attached a small file with an "informal" test case.

Re-rolled patch against a clean Entity API 7.x-1.x-dev. Lines changed from @@ -873,10 to 899, no conflicts.

Marking as RTBC.

+++ b/modules/callbacks.inc
@@ -896,10 +896,18 @@ function entity_metadata_form_comment($comment) {
+  }
+  ¶
   $form_state['build_info']['args'] = array($account);

Unnecessary whitespace.

Thanks, committed.