Form Tweaks

Form Tweaks module

The intent of this module is to provide a way to simplify forms by hiding certain form fields. There is no UI for this module. Form tweaks are configured through a variable setting.

The application of the form element hiding can be controlled by form and user roles. This can apply to all forms and/or user roles, individual ones. When rules apply to all forms or user roles, exceptions can also be defined.

The individual configurations are set by providing the form id to affect as well as the user roles to affect.

A set of predefined items are available for hiding common form elements. For form elements not in predefined list, arbitrary form fields can be specified directly within the configuration (see 'Defining Your Own Elements' below).

How to Use:

Define the different form fields to hide within your settings.php file. The structure is an associative array, of arrays. For example:

<?php
  // Define the container for the configuration items.
  $conf['form_tweaks_config'] = array();

  // On all forms, for all users, hide the 'Authoring Information' fieldset and
  // the Menu Link: Weight field. However, do NOT hide these when we're showing
  // the 'article_node_form' form.
  $conf['form_tweaks_config'][] = array(
    'roles' => array('all'),
    'forms' => array('all'),
    'excluded forms' => array('article_node_form'),
    'elements' => array(
      'node-author-fieldset',
      'node-menu-link-weight',
    ),
  );

  // On the 'news_node_form', only for users with the 'authenticated user' role,
  // hide the 'Promote to front page' field and the 'Make sticky' field.
  $conf['form_tweaks_config'][] = array(
    'roles' => array('authenticated user'),
    'forms' => array('news_node_form'),
    'elements' => array(
      'node-options-promote',
      'node-options-sticky',
    ),
  );

  // On the 'news_node_form', for all users except those with the 'editor' role,
  // hide the URL alias fieldset.
  $conf['form_tweaks_config'][] = array(
    'roles' => array('all'),
    'excluded roles' => array('editor'),
    'forms' => array('news_node_form'),
    'elements' => array(
      'node-path-fieldset',
    ),
  );
?>

You can add as many rules as needed.

Form Element Options

These are the predefined form elements you can reference in your Form Tweaks configuration.

The 'hide by css' options (*-csshide) are useful because they still allow
programmatic configuration of the form elements while (visually) hiding them
from the user. This is necessary in some cases. E.g., if you want to define a
menu setting programmatically but don't want the user to see the fieldset, you
need to use 'node-menu-fieldset-csshide' for the programmatic configuration to
take effect.

Defining Your Own Elements

If you need to hide a form element that isn't defined in the above list, you can do so by providing the form key(s) to hide directly within the Form Tweaks configuration.

So, if we had a form definition like this:

$form = array(
  'metatags' => array(
    'title' => 'some title',
    'advanced' => array(
      'type' => 'fieldset',
      'some-key' => array(
        etc.
      ),
    ),
  ),
);

... and we wanted to hide the 'advanced' fieldset, we could define the path to that form element like this:

$conf['form_tweaks_config'][] = array(
  'roles' => array('all'),
  'forms' => array('all'),
  'elements' => array(
    'DEFINED:hide-the-metatags=metatags,advanced',
  ),
);

The expected format is:
DEFINED:<a-unique-name-for-this-definition>=form_key1,form_key2,etc

e.g.,
DEFINED:hide-xmlsitemap-fieldset=xmlsitemap
DEFINED:hide-metatags-fieldset=metatags,advanced