How can we access the new form modes?

@giorgio79 : Right, form modes can only be leveraged via custom code in custom controllers - at least at the moment nothing in core makes use of custom-defined form modes.
(unlike custom view modes, that can be selected in Views, or in entity_reference formatters - but those features have no equivalent on the form side)

The feature you mention seems like something a contrib module could provide, as it might not be a desired behavior on all sites.

Yes. At the moment, this simply doesn't exist. https://www.drupal.org/project/issues/entityform_block is one thing that will eventually leverage it.

I need to create a form that has different fields present for different roles. I thought that using the new form modes would be more sensible than trying to hide fields via a form_alter as in d6/d7, and I think that I've almost worked it out. I have a node type 'custom_profile' and a new display mode 'administrator_profile_form' with all the fields visible, and on the 'default' display mode, most of the fields hidden. Then this code in a custom module to get the new display mode to show (conditional role stuff yet to be done):

function custom_form_alter(&$form, &$form_state, $form_id) {
  if ($form_id == 'node_custom_profile_form') {
    $entity= $form_state->getFormObject()->getEntity();
    $form_display = \Drupal\Core\Entity\Entity\EntityFormDisplay::collectRenderDisplay($entity, 'administrator_profile_form');
    $form_state->set('form_display', $form_display);
    $form_state->setRebuild();
  }
}

Using phpstorm+xdebug, I can see that the form_state is updated, and everything looks like it should display with the new display mode but I still get the 'default' form.

Any pointers as to where I'm going wrong?

Hi Singularo, I think you should approach this task with the mindset of asking for the form mode you want, rather than overriding/altering a form mode once the processing has started.

For instance if you are looking to change the form at node/add/page then look at the controller for that path.

http://cgit.drupalcode.org/drupal/tree/core/modules/node/src/Controller/...

The relevant chunk of code is

$form = $this->entityFormBuilder()->getForm($node);

I think you'd want to override that method/route and replace it with something like

if ($some_condition) {
   $form = $this->entityFormBuilder()->getForm($node, 'custom_profile');
}
else if ($some_other_condition) {
   $form = $this->entityFormBuilder()->getForm($node, 'administrator_profile_form');
}
 

Also look at #2511720: Allow form modes to use default operation if a form operation is not explicitly set to make sure the form mode does not throw an error when it is called.

Showing/Hiding fields but keep them otherwise the same is IMHO a perfect use case for hook_entity_field_access() not switching out the form display. I'd only try to do something like that when you want to show different widgets based on the user roles.

Good point Berdir. I agree. Field access is a better fit if per-field visibility by role is the only difference between the forms.

Field Permissions module module has handled that use case well. There is not yet a Drupal 8 version: #2196303: Port field permissions to drupal 8

Re #6 I do not believe that the second argument to the EntityFormBuilder getForm method is the form mode; this is the operation and, from what I can tell from the interface doc block, it concerns the crud operation rather than the form mode. When passing the my form mode key to getForm I get the following error:

Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException: The "node" entity type did not specify a "admin" form class. in Drupal\Core\Entity\EntityTypeManager->getFormObject() (line 182 of /var/www/drupal/web/core/lib/Drupal/Core/Entity/EntityTypeManager.php).

So I'm still looking for a way to render an entity form with a particular form mode...

Any pointers greatly appreciated.

i too was looking for something like:

add/page/?form=light
add/page/?form=$form_mode

imho this should be native to the functionality of the core module and should not depend on entityform_block

I agree with jacov. What I would want to do, is have a separate form configured to do a separate task.

Scenario: You have a node which two roles should have access to.

1: Content proposer: /node/add/content-> Add title and node field content only.
2: Content promoter: /node/X/promotion -> Edit the same node, have no access to fields above, but two other fields, "Promote" checkbox and "Promotions comments" field.

A scenario like this should "easily" be handled natively through UI.

IMO a way to access alternate form modes via URL. Rather than GET params, I think they should be added as routes, admins should be able to enable a route in admin/structure/display-modes/form/manage/[display mode machine name] (disabled by default to reflect @yched concern in #2 ).

1. create needed form modes, for example I created for content custom form mode - "my_mode" (machine name node.my_mode )
2. implement hook:

function hook_entity_type_build(array &$entity_types) {
  $entity_types['node']->setFormClass('my_mode', 'Drupal\node\NodeForm');
}

3. build form ($node - is loaded node object):

$entity_form_builder = new entityFormBuilder($container->get('entity.manager'), $container->get('form_builder'))
$form = $entity_form_builder->getForm($node, 'my_mode');

@dench0 (#13)
I couldn't understand where to put the chunk of code defined in "3. build form"

Meanwhile you can try this modules.

https://www.drupal.org/project/form_mode_control
https://www.drupal.org/project/form_mode_manager

I prefer form_mode_control. Form_mode_manager create view form mode for all content types.

Hello Well after some time of messing with this i seem to have it working:
and here is how

1) create your form display and get id from url
at :admin/structure/display-modes/form/manage/

"Test This" gives m name ... node.test_this

in your modules
my_module.routing.yml

#admin/structure/display-modes/form/manage/node.test_this
#node.test_this is the name !
my_module.test_this:
 path: '/some-path/{node}/test_this'
 defaults:
   _entity_form: node.test_this
 requirements:
   _permission: 'some perm'

#Symfony\Component\Routing\Exception\RouteNotFoundException: Route "entity.node.test_this" fix
#when you go to www.site.com/node/NID  or save from your form mode
#yes you need this !!!!!! or you will have a bad time try with out lol!
entity.node.test_this:
 path: 'node/{node}'
 defaults:
  _controller: '\Drupal\node\Controller\NodeViewController::view'
 requirements:
   _permission: 'access content'

.... now in your module
my_module.module

/**
 * Implements hook_entity_type_alter().
 * inspiration from  form_mode_manager_entity_type_alter (THANK YOU !!!). 
 */
function my_module_entity_type_alter(array &$entity_types) {
  $form_modes = \Drupal::service('entity_display.repository')->getAllFormModes();
  foreach ($form_modes as $entity_type => $display_modes) {
    /* @var \Drupal\Core\Entity\EntityTypeInterface $entity */
    $entity = $entity_types[$entity_type];
    foreach ($display_modes as $machine_name => $form_display) {
      if ($machine_name != 'register') {
        // Get the correct canonical path to add operation.
        $path = $entity->getLinkTemplate('canonical') . "/$machine_name";
        $default_handler_class = $entity->getHandlerClasses()['form']['default'];
        $entity->setFormClass($machine_name, $default_handler_class)
          ->setLinkTemplate($machine_name, $path);
      }
    }
  }
}

function my_module_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  //dump($form_id);
}

now you can go to the path www.site.com/some-path/{nodeID}/test_this
and try to not have your chin hit the floor.

the cool thing as it gives a new form id to then alter

This was a PITA! For this feature to be operational for nodes.

$node = \Drupal::entityTypeManager()->getStorage('node')->create(array('type' => 'NODE-BUNDLE-HERE'));
$block_form = \Drupal::service('entity.form_builder')->getForm($node, 'FORM-MODE-HERE');

Add this to your module.

/**
 * Implements hook_entity_type_alter().
 */
function chriscalip_entity_type_alter(array &$entity_types) {
  $entity_type = 'node';
  $entity = $entity_types[$entity_type];
  /** @var \Drupal\Core\Entity\EntityDisplayRepository[] $display_modes_list for node */
  $form_modes = \Drupal::service('entity_display.repository')->getFormModes($entity_type);
  foreach ($form_modes as $machine_name => $form_display) {
    // Get the correct canonical path to add operation.
    $path = $entity->getLinkTemplate('canonical') . "/$machine_name";
    $default_handler_class = $entity->getHandlerClasses()['form']['default'];
    $entity->setFormClass($machine_name, $default_handler_class)->setLinkTemplate($machine_name, $path);
  }
}

This #19 has bugs and as well as #18. For custom forms use #13 instead.

#18 works perfectly

With some improvments like adding tasks tabs as on usual node form pages and adding some custom permissions, it's easy to create a per permission access to different form display.

Thanks a lot taggartj.

I'm working on a dynamic way to generate form modes routes and permissions (like "form mode manager" and "form display control" modules should do, but both are broken in Drupal 8.2.3 version)..

UPDATE : aftr testing the module "form mode manager" works perfectly.

@chriscalip: Thanks for posting a working solution - works fine in my case.

Just a proof of concept, and this has backwards compatibility issues, but this would allow custom code to use form modes correctly AFAICS

Re rolled the patch, please review.

Another way to solve this problem is as follows:

/**
 * Implements hook_entity_form_display_alter().
 */

function MYMODULE_entity_form_display_alter(&$form_display, $context) {

  switch ($form_display->id()) {
    case 'ENTITY_TYPE.BUNDLE.FORM_MODE':
      $storage = \Drupal::entityManager()->getStorage('entity_form_display');
      $form_display = $storage->load('ENTITY_TYPE.BUNDLE.FORM_MODE');
  }

}

Replace items in caps with own values.

You can use FormModeManager module too for use form-mode onto ALL entities compatibles + media/file entity (and your custom).

You can too inspirate you with our method to make you custom implement or with help of FormModeManager services.

Tried hook_entity_type_alter, hook_entity_type_build but no luck.
Ref: https://www.webomelette.com/render-custom-entity-form-modes-programatica... (Not worked)

But #26 is working fine after spending so much time.

Link to add form modes : admin/structure/display-modes/form

Thanks @New Zeal for your solution :)

+++ b/core/lib/Drupal/Core/Entity/EntityFormBuilder.php
@@ -40,8 +40,8 @@ public function __construct(EntityManagerInterface $entity_manager, FormBuilderI
+  public function getForm(EntityInterface $entity, $operation = 'default', array $form_state_additions = array(), $form_class = NULL) {
+    $form_object = $this->entityManager->getFormObject($entity->getEntityTypeId(), $operation, $form_class);

Rather than adding a parameter, what about having the mode in $form_state_additions, so this works:

$form = \Drupal::service('entity.form_builder')->getForm($entity, 'edit', ['form_display' => 'my_mode']);

At the moment, it gets clobbered by ContentEntityForm::init()'s call to setFormDisplay()

So I IMHO we need to planned a port of form mode manager features/usages in core (in display reposittory). If core team is interested I purpose prépare that and see with field/core team and make an experimental module instead of continue to maintain form mode manager.

@woprr This definitely makes sense! It is strange that you have to write a module just to link to a form mode,

I tried form_mode_manager as suggested by many over here but didn't work for profiles. In Readme.txt they written specifically that

Profile : Not compatible with Profile ATM please follow #2834749 issue to have more precision.

I also tried

hook_entity_type_alter, hook_entity_type_build

, but they also didn't work. Lastly I tried #26 solutions and it worked for me.

Thanks ton New Zeal for providing this solutions.

Hi sukh with 2.x branch and issue listed you can use fmm with profiles.

https://www.drupal.org/project/form_mode_routing
can be a quick solution as well

Business Rules module now allows changing the form view mode based on any condition.

Let me know how it works for you.

I have used Business Rules to switch form modes with conditions and it works. I also like the proposed direction that the Form_mode_routing module is going too. But to see a working solution based on routing and permissions in core would be good.

@kenton.r you will love form mode manager then ;) lot of old user of br and form mode routing have migrated here.

Actually we need a standard in routing, form mode manager try to purpose that and work hard to provide a solution that match whit all usages. Actually we can be compatible with every entities and provide also lot of feature like br.

Patch rerolled

Not sure if mentioned already but this is what Commerce uses (thanks @facine for the tip)

$form_display = EntityFormDisplay::collectRenderDisplay($entity, 'form_mode');
$form_display->buildForm($entity, $form, $form_state);

Btw seems core uses collectRenderDisplay with both form mode and operation because there's a fallback, it could be standardized a little bit?

Hello. In the end, is there the option that the control of the modes works? functional example? Thanks.

This could use an issue summary update about the proposed solution.

Should of moved it to NW 2 months ago sorry.

Fixed failed commands on #43
Attached patch against Drupal 10.1.x
Attached reroll patch

Fixed The Custom CMD Failed Patch Of #57

+++ b/core/lib/Drupal/Core/Entity/EntityTypeManager.php
@@ -202,9 +202,12 @@ public function getListBuilder($entity_type_id) {
+  public function getFormObject($entity_type, $operation, $form_class = NULL) {

New parameters on both functions need to be documented!!!!!!!

Also, why change the name of $entity_type_id?

Reroll the Patch as per Suggestion of #60.

@Prem Suthar please read the comments and tags.

This was tagged for IS update and a change record and question in #60

Also upload an interdiff with patches please

i just want to add some confirmation, for the benefit of those who have found this page while trying to use form modes from custom code (rather than anything to do with actual code changes to Core)

those modules form_mode_control and form_mode_manager may be very handy, but if you are just trying to generate a node form from php, with an alternate (but already defined) form mode for that node type, then ALL you need is what is mentioned in #13 ! thanks, @dench0 that was very helpful!

i tried this in Drupal 9.4.15 and it still works just fine :-)

@earthangelconsulting

Can you show an real example?

Where did did you implement the code.

Thanks

Gracias

foo_posting is the machine name of a node type
foo_specialform is the machine name of a custom form mode, for nodes of type foo_posting
foomodule is the module that handles this

this is in the src/FooController.php script, within foomodule: (note that this use case is for a path that calls a node/add form, using form mode foo_posting ... if you need to edit existing nodes, it would be a bit different)

namespace Drupal\foomodule\Controller;

use Drupal\Core\Controller\ControllerBase;
use Drupal\node\Entity\Node;

class FooController extends ControllerBase {

  /**
   * Function to call the Foo Posting form
   *
   * @return array
   *   A renderable array
   */
  public function postFoo() {
  
    $node = Node::create(array(
    'type' => 'foo_posting',
    ));
	
    $form = \Drupal::service('entity.form_builder')->getForm($node, 'foo_specialform');  
    
    return [
      'form' => $form
    ];
  }

}

this is in foomodule.routing.yml (nothing out of the ordinary here! )

foomodule.fooposting:
  path: '/foo-posting'
  defaults:
    _controller: 'Drupal\foomodule\Controller\FooController::postFoo'
    _title: 'Post an instance of Foo'
  requirements:
    _access: 'TRUE'

and this is part of foomodule.module

function foomodule_entity_type_build(array &$entity_types) {
  $entity_types['node']->setFormClass('foo_specialform', 'Drupal\node\NodeForm');
}

there are definitely other ways to do this, eg: https://www.webomelette.com/how-switch-out-entity-form-mode-dynamically-... https://www.drupal.org/docs/drupal-apis/entity-api/how-to-create-an-enti... this is just one of them.

@earthangelconsulting

Thank you so much.

Gracias