欢迎各位兄弟 发布技术文章

这里的技术是共享的

You are here

首页

drupal form api formapi d6 d7 drupal6 drupal7 有大用 有大大用 有大大大用

shiping1 的头像
星期五, 2013-09-27 12:54 — shiping1

https://api.drupal.org/api/drupal/developer%21topics%21forms_api_reference.html/6.x  
https://api.drupal.org/api/drupal/developer%21topics%21forms_api_reference.html/7.x  
drupal form api

  1. 7 developer/topics/forms_api_reference.html

  2. 4.7 developer/topics/forms_api_reference.html

  3. 5 developer/topics/forms_api_reference.html

  4. 6 developer/topics/forms_api_reference.html

  5. 8 developer/topics/forms_api_reference.html

This document provides a programmer's reference to the Drupal Forms API. If you're interested in step-by-step documentation to help you write forms, please see the Forms API QuickStart guide.

Skip to: Properties | Default Values | Elements

Form Controls

Legend:
X = attribute can be used with this type
- = this attribute is not applicable to this type

#typecheckboxcheckboxesdatefieldsetfilepasswordpassword_confirmradioradiosselecttextareatextfieldweight
#accessXXXXXXXXXXXXX
#after_buildXXXXXXXXXXXXX
#ahahX----X-X-XXX-
#attributesXXXXXX-XXXXXX
#autocomplete_path-----------X-
#collapsed---X---------
#collapsible---X---------
#cols----------X--
#default_valueXXX----XXXXXX
#delta------------X
#descriptionXXXXXXXXXXXXX
#disabledXXX-XXXXXXXXX
#element_validateXXXXXXXXXXXXX
#field_prefix-----------X-
#field_suffix-----------X-
#maxlength-----X-----X-
#multiple---------X---
#options-X------XX---
#parentsXXXXXXXXXXXXX
#post_renderXXXXXXXXXXXXX
#prefixXXXXXXXXXXXXX
#pre_renderXXXXXXXXXXXXX
#processXXXXXXXXXXXXX
#requiredXXX--XXXXXXXX
#resizable----------X--
#return_valueX------X-----
#rows----------X--
#size----XXX--X-X-
#suffixXXXXXXXXXXXXX
#themeXXXXXXXXXXXXX
#titleXXXXXXXXXXXXX
#treeXXXXXXXXXXXXX
#weightXXXXXXXXXXXXX

Special Elements

#typebuttonimage_buttonsubmitformhiddentokenmarkupitemvalue
#accessXXXXXXXX-
#action---X-----
#after_buildXXXXXXXX-
#ahahXXX-X----
#attributesXXXX-----
#button_typeXXX------
#default_value----XX---
#description-------X-
#disabledXXX------
#element_validateXXX-XXXX-
#executes_submit_callbackXXX------
#method---X-----
#nameX-X------
#parentsXXX-XXXX-
#post_renderXXXXXXXX-
#prefixXXXXXXXX-
#pre_renderXXXXXXXX-
#processXXXXXX---
#redirect---X-----
#return_value-X-------
#src-X-------
#submitXXXX-----
#suffixXXXXXXXX-
#themeXXXXXXXX-
#title-------X-
#treeXXXXXXXX-
#validateXXXX-----
#valueXXX-XXXXX
#weightXXX-XXXX-

Default Values

Every element automatically has these default values (see _element_info):

The following is a list of default values which do not need to be set (found in system_elements):

 

Elements

Note that property names in bold are those that will generally need to be defined when creating this form element. Default values are indicated in parentheses next to property names, if they exist.

button

Description: Format an action button. When the button is pressed, the form will be submitted to Drupal, where it is validated and rebuilt. The submit handler is not invoked.

Properties: #access, #after_build, #ahah, #attributes, #button_type (default: submit), #disabled, #element_validate, #executes_submit_callback (default: FALSE), #name (default: op), #parents, #post_render, #prefix, #pre_render, #process, #submit, #suffix, #theme, #tree, #type, #validate, #value, #weight

Usage example (node.module):

<?php
$form['preview'] = array(
  '#type' => 'button',
  '#value' => t('Preview'),
  '#weight' => 19,
);
?>

checkbox

Description: Format a checkbox.

Properties: #access, #after_build, #ahah, #attributes, #default_value, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #return_value (default: 1), #suffix, #theme, #title, #tree, #type, #weight

Usage example (contact.module):

<?php
$form['copy'] = array(
  '#type' => 'checkbox',
  '#title' => t('Send me a copy.'),
);
?>

checkboxes

Description: Format a set of checkboxes. #options is an associative array, where the key is the #return_value of the checkbox and the value is displayed. The #options array can not have a 0 key, as it would not be possible to discern checked and unchecked states.

Properties: #access, #after_build, #attributes, #default_value, #description, #disabled, #element_validate, #options, #parents, #post_render, #prefix, #pre_render, #process, #required, #suffix, #theme, #title, #tree (default: TRUE), #type, #weight

Usage example (node.module):

<?php
$form['node_options_'. $node->type] = array(
  '#type' => 'checkboxes',
  '#title' => t('Default options'),
  '#default_value' => variable_get('node_options_'. $node->type, array('status', 'promote')),
  '#options' => array(
    'status' => t('Published'),
    'moderate' => t('In moderation queue'),
    'promote' => t('Promoted to front page'),
    'sticky' => t('Sticky at top of lists'),
    'revision' => t('Create new revision'),
  ),
  '#description' => t('Users with the <em>administer nodes</em> permission will be able to override these options.'),
);
?>

date

Description: Format a date selection box. The #default_value will be today's date if no value is supplied. The format for the #default_value and the #return_value is an array with three elements with the keys: 'year', month', and 'day'. For example, array('year' => 2007, 'month' => 2, 'day' => 15)

Properties: #access, #after_build, #attributes, #default_value, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #suffix, #theme, #title, #tree, #type, #weight

Usage example (profile.module):

<?php
$fields[$category][$field->name] = array(
  '#type' => 'date',
  '#title' => check_plain($field->title),
  '#default_value' => $edit[$field->name],
  '#description' => _profile_form_explanation($field),
  '#required' => $field->required
);
?>

fieldset

Description: Format a group of form items.

Properties: #access, #after_build, #attributes, #collapsed (default: FALSE), #collapsible (default: FALSE), #description, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #suffix, #theme, #title, #tree, #type, #weight

Usage example (contact.module):

<?php
$form['contact'] = array(
  '#type' => 'fieldset',
  '#title' => t('Contact settings'),
  '#weight' => 5,
  '#collapsible' => TRUE,
  '#collapsed' => FALSE,
);
?>

file

Description: Format a file upload field.

Note: you will need to include $form['#attributes'] = array('enctype' => "multipart/form-data"); in your form. See this handbook page for an example http://drupal.org/node/111782.

Note: the #required property is not supported (setting it to true will always cause a validation error). Instead, you may want to use your own validation function to do checks on the $_FILES array with #required set to false. You will also have to add your own required asterisk if you would like one.

Properties: #access, #after_build, #attributes, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #size (default: 60), #suffix, #theme, #title, #tree, #type, #weight

Usage example (upload.module):

<?php
$form['new']['upload'] = array(
  '#type' => 'file',
  '#title' => t('Attach new file'),
  '#size' => 40,
);
?>

form

Description: A form containing form elements

Properties: #access, #action (default: request_uri()), #after_build, #attributes, #method (default: 'post'), #post_render, #prefix, #pre_render, #redirect, #submit, #suffix, #theme, #tree, #validate

Usage example:

N/A

hidden

Description: Store data in a hidden form field.

Properties: #access, #after_build, #ahah, #default_value, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #suffix, #theme, #tree, #type, #value

Usage example (block.module):

<?php
$form['bid'] = array('#type' => 'hidden', '#value' => $bid);
?>

Note that if you plan to use JavaScript to change your hidden element's value, you will need to use the #default_value property rather than #value.

image_button

Description: Format a form submit button with an image. Note: using multiple image_buttons with #value set will make the submission think the last defined was the $form_state['clicked_button'].

Properties: #access, #after_build, #ahah, #attributes, #button_type (default: 'submit'), #disabled, #element_validate, #executes_submit_callback (default: TRUE), #parents, #post_render, #prefix, #pre_render, #process, #return_value (default: TRUE), #src, #submit, #suffix, #theme, #tree, #type, #validate, #value, #weight

item

Description: Generate a display-only form element allowing for an optional title and description.

Note: since this is a read-only field, setting the #required property will do nothing except theme the form element to look as if it were actually required (i.e. by placing a red star next to the #title).

Properties: #access, #after_build, #description, #element_validate, #parents, #post_render, #prefix, #pre_render, #required, #suffix, #theme, #title, #tree, #type, #value, #weight

Usage example (contact.module):

<?php
$form['from'] = array(
  '#type' => 'item',
  '#title' => t('From'),
  '#value' => $user->name .' &lt;'. $user->mail .'&gt;',
);
?>

markup

Description: Generate generic markup for display inside forms. Note that there is no need to declare a form element as #type = 'markup', as this is the default type.

Note: if you use markup, if your content is not wrapped in tags (generally <p> or <div>), your content will fall outside of collapsed fieldsets.

Properties: #access, #after_build, #element_validate, #parents, #post_render, #prefix, #pre_render, #suffix, #theme, #tree, #type, #value, #weight

Usage example (contact.module):

<?php
$form['contact_information'] = array(
  '#value' => variable_get('contact_form_information', t('You can leave us a message using the contact form below.')),
);
?>

password

Description: Format a single-line text field that does not display its contents visibly.

Properties: #access, #after_build, #ahah, #attributes, #description, #disabled, #element_validate, #maxlength (default: 128), #parents, #post_render, #prefix, #pre_render, #process, #required, #size (default: 60), #suffix, #theme, #title, #tree, #type, #weight

Usage example (user.module):

<?php
$form['pass'] = array(
  '#type' => 'password',
  '#title' => t('Password'),
  '#maxlength' => 64,
  '#size' => 15,
);
?>

password_confirm

Description: Format a pair of password fields, which do not validate unless the two entered passwords match.

Properties: #access, #after_build, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #size (default: 60), #suffix, #theme, #title, #tree, #type, #weight

Usage example (user.module):

<?php
$form['pass'] = array(
  '#type' => 'password_confirm',
  '#title' => t('Password'),
  '#size' => 25,
);
?>

radio

Description: Format a radio button.

Properties: #access, #after_build, #ahah, #attributes, #default_value, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #return_value, #suffix, #theme, #title, #tree, #type, #weight

Usage example:

N/A

radios

Description: Format a set of radio buttons.

Properties: #access, #after_build, #attributes, #default_value, #description, #disabled, #element_validate, #options, #parents, #post_render, #prefix, #pre_render, #process, #required, #suffix, #theme, #title, #tree, #type, #weight

Usage example (comment.module):

<?php
$form['posting_settings']['comment_preview'] = array(
  '#type' => 'radios',
  '#title' => t('Preview comment'),
  '#default_value' => variable_get('comment_preview', 1),
  '#options' => array(t('Optional'), t('Required')),
);
?>

select

Description: Format a drop-down menu or scrolling selection box.

Properties: #access, #after_build, #ahah, #attributes, #default_value, #description, #disabled, #element_validate, #multiple, #options, #parents, #post_render, #prefix, #pre_render, #process, #required, #size, #suffix, #theme, #title, #tree, #type, #weight

Usage example (system.module):

<?php
$form['feed']['feed_item_length'] = array(
  '#type' => 'select',
  '#title' => t('Display of XML feed items'),
  '#default_value' => variable_get('feed_item_length','teaser'),
  '#options' => array(
    'title' => t('Titles only'),
    'teaser' => t('Titles plus teaser'),
    'fulltext' => t('Full text'),
  ),
  '#description' => t('Global setting for the length of XML feed items that are output by default.'),
);
?>

submit

Description: Format a form submit button.

Properties: #access, #after_build, #ahah, #attributes, #button_type (default: 'submit'), #disabled, #element_validate, #executes_submit_callback (default: TRUE), #name (default: 'op'), #parents, #post_render, #prefix, #pre_render, #process, #submit, #suffix, #theme, #tree, #type, #validate, #value, #weight

Usage example (locale.module):

<?php
$form['submit'] = array('#type' => 'submit', '#value' => t('Import'));
?>

textarea

Description: Format a multiple-line text field.

Properties: #access, #after_build, #ahah, #attributes, #cols (default: 60), #default_value, #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #resizable (default: TRUE), #rows (default: 5), #suffix, #theme, #title, #tree, #type, #weight

Usage example (forum.module):

<?php
$form['body'] = array(
  '#type' => 'textarea',
  '#title' => t('Body'),
  '#default_value' => $node->body,
  '#required' => TRUE
);
?>

textfield

Description: Format a single-line text field.

Properties: #access, #after_build, #ahah, #attributes, #autocomplete_path (default: FALSE), #default_value, #description, #disabled, #element_validate, #field_prefix, #field_suffix, #maxlength (default: 128), #parents, #post_render, #prefix, #pre_render, #process, #required, #size (default: 60), #suffix, #theme, #title, #tree, #type, #weight

Usage example (forum.module):

<?php
$form['title'] = array(
  '#type' => 'textfield',
  '#title' => t('Subject'),
  '#default_value' => $node->title,
  '#size' => 60,
  '#maxlength' => 128,
  '#required' => TRUE,
);
?>

token

Description: Store token data in a hidden form field (generally used to protect against cross-site forgeries). A token element is automatically added to each Drupal form by drupal_prepare_form(), so you don't generally have to add one yourself.

Properties: #access, #after_build, #default_value, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #suffix, #theme, #tree, #type, #value, #weight

value

Description: A form value that is internal to the form and never displayed to the screen.

Properties: #type, #value

Usage example (node.module):

<?php
$form['vid'] = array('#type' => 'value', '#value' => $node->vid);
?>

Note that as of Drupal 6, you can also simply store arbitrary variables in $form['#foo'] instead, as long as '#foo' does not conflict with any other internal property of the Form API.

weight

Description: Format a weight selection menu.

Properties: #access, #after_build, #attributes, #default_value, #delta (default: 10), #description, #disabled, #element_validate, #parents, #post_render, #prefix, #pre_render, #process, #required, #suffix, #theme, #title, #tree, #type, #weight

Usage example (menu.module):

<?php
$form['weight'] = array(
  '#type' => 'weight',
  '#title' => t('Weight'),
  '#default_value' => $edit['weight'],
  '#delta' => 10,
  '#description' => t('Optional. In the menu, the heavier items will sink and the lighter items will be positioned nearer the top.'),
);
?>

Properties

#access

Used by: All elements and forms

Description: Whether the element is accessible or not; when FALSE, the element is not rendered and the user submitted value is not taken into consideration.

Values: TRUE or FALSE.

#action

Used by: form

Description: The path to which the form will be submitted.

Values: An internal path

Usage example (comment.module):

<?php
$form['#action'] = url('comment/reply/'. $edit['nid']);
?>

#after_build

Used by: All elements and forms

Description: An array of function names which will be called after the form or element is built.

Usage example (system.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
$form['files']['file_directory_path'] = array(
  '#type' => 'textfield',
  '#title' => t('File system path'),
  '#default_value' => file_directory_path(),
  '#maxlength' => 255,
  '#description' => t('A file system path where the files will be stored. This directory has to exist and be writable by Drupal. If the download method is set to public this directory has to be relative to Drupal installation directory, and be accessible over the web. When download method is set to private this directory should not be accessible over the web. Changing this location after the site has been in use will cause problems so only change this setting on an existing site if you know what you are doing.'),
);
$form['#after_build'] = array('system_check_directory');

...

function system_check_directory($form_element, &$form_state) {
  file_check_directory($form_element['#value'], FILE_CREATE_DIRECTORY, $form_element['#parents'][0]);
  return $form_element;
}
?>

#ahah

Used by: button, checkbox, hidden, image button, password, radio, select, submit, textarea, textfield

An array of elements whose values control the behavior of the element with respect to the Drupal AHAH javascript methods.

The #ahah name refers to AHAH javascript replacement (Asychronous HTML and HTTP), a relative of AJAX. AHAH is a form of javascript page replacement that is both easy and straight forward. In a nutshell an AHAH request follows these steps:

  1. Drupal builds a form element with a set of #ahah properties. The misc/ahah.js file is included on the page automatically.

  2. ahah.js finds all the form elements on the page that have an #ahah['path'] set and adds an event handler for the #ahah['event'] set on that form element.

  3. When the #ahah['event'] occurs on the element (such as 'click'), the AHAH request is made to the Drupal path of the element's #ahah['path'].

  4. Drupal generates HTML in a second request in the background. While the user waits for the callback to execute a throbber or progress bar is shown as determined by #ahah['progress']. The result is returned to the original page containing the form element.

  5. ahah.js gets the result and inserts the returned HTML into the #ahah['wrapper']. Depending on the #ahah['method'], the result may affect the wrapper in different ways.

#ahah['effect']

Description: Specifies the effect used when adding the content from an AHAH request.

Values: String. Possible values: 'none' (default), 'fade', 'slide'. If the interface elements library is installed, any effect with the name effectToggle may also be used.

Usage example (poll.module):

  $form['choice_wrapper']['poll_more'] = array(
    '#type' => 'submit',
    '#value' => t('More choices'),
    '#description' => t("If the amount of boxes above isn't enough, click here to add more choices."),
    '#weight' => 1,
    '#submit' => array('poll_more_choices_submit'), // If no javascript action.
    '#ahah' => array(
      'path' => 'poll/js',
      'wrapper' => 'poll-choices',
      'method' => 'replace',
      'effect' => 'fade',
    ),

#ahah['event']

Description: When this event occurs to this element, Drupal will perform an HTTP request in the background via Javascript.

Values: String. Possible values: Any valid jQuery event, including 'mousedown', 'blur', and 'change'. Note that #ahah['event'] does not need to be explicitly specified. Although it can be manually set, usually the default value will be sufficient.

#ahah['keypress']

Description: If set to TRUE, then the element's #ahah['event'] will be triggered if the ENTER key is pressed while the element has focus.

#ahah['method']

Description: Modify the behavior of the returned HTML from an AHAH request when inserting into the #ahah_wrapper. If not set, the returned HTML will replace the contents of the wrapper element, but it's also possible to use any of the available jQuery operations for DOM manipulation.

Values: String. Possible values: 'replace' (default), 'after', 'append', 'before', 'prepend'.

#ahah['path']

Description: If set, this property triggers AHAH behaviors on a form element. This is the Drupal menu path to a callback function which will generate HTML and return the string of HTML to Drupal. The result will be placed in the div specified in #ahah['wrapper'].

Values: String containing a Drupal menu path.

Usage example (upload.module):

<?php
/**
* Implementation of hook_menu().
*/
function upload_menu() {
  $items['upload/js'] = array(
    'page callback' => 'upload_js',
    'access arguments' => array('upload files'),
    'type' => MENU_CALLBACK,
  );
  ...
  return $items;
}

...

function _upload_form($node) {
  ...
    $form['new']['attach'] = array(
      '#type' => 'submit',
      '#value' => t('Attach'),
      '#name' => 'attach',
      '#ahah' => array(
        'path' => 'upload/js',
        'wrapper' => 'attach-wrapper',
        'progress' => array('type' => 'bar', 'message' => t('Please wait...')),
      ),
      '#submit' => array('node_form_submit_build_node'),
    );
  ...
return $form;
?>

#ahah['path'] is set to 'upload/js', which has a menu item defined in the same module. Then the menu hook will call the 'upload_js' function which generates HTML and returns it to original page.

#ahah['progress']

Description: Choose either a throbber or progress bar that is displayed while awaiting a response from the callback, and add an optional message.

Values: Array.

Possible keys: 'type', 'message', 'url', 'interval'

Possible values:

  • #ahah['progress']['type'] String. Possible values: 'throbber' (default), 'bar'.

  • #ahah['progress']['message'] String. An optional message to the user; should be wrapped with t().

  • #ahah['progress']['url'] String. The optional callback path to use to determine how full the progress bar is (as defined in progress.js). Only useable when 'type' is 'bar'.

  • #ahah['progress']['interval'] String. The interval to be used in updating the progress bar (as defined in progress.js). Ony used if 'url' is defined and 'type' is 'bar'.

Usage example: see above usage in upload.module

#ahah['wrapper']

Description: This property defines the HTML id attribute of an element on the page will server as the destination for HTML returned by an AHAH request. Usually, a div element is used as the wrapper, as it provides the most flexibility for placement of elements before, after, or inside of it's HTML tags. This property is required for using AHAH requests in on a form element.

Values: String containg a valid id attribute of an HTML element on the same page.

Usage example (upload.module):

    $form['new']['attach'] = array(
      '#type' => 'submit',
      '#value' => t('Attach'),
      '#name' => 'attach',
      '#ahah' => array(
        'path' => 'upload/js',
        'wrapper' => 'attach-wrapper',
        'progress' => array('type' => 'bar', 'message' => t('Please wait...')),
      ),
      '#submit' => array('node_form_submit_build_node'),
    );

#attributes

Used by: button, checkbox, checkboxes, date, fieldset, file, form, image_button, password, radio, radios, select, submit, textarea, textfield, weight

Description: Additional HTML attributes, such as 'class' can be set using this mechanism.

Values: Any HTML attribute not covered by other properties, e.g. class (for control types), enctype (for forms).

Usage example (search.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
$form['#attributes'] = array('class' => 'search-form');
?>

#autocomplete_path

Used by: textfield

Description: The path the AJAX autocomplete script uses as the source for autocompletion.

Usage example (node.module):

<?php
$form['author']['name'] = array(
  '#type' => 'textfield',
  '#title' => t('Authored by'),
  '#maxlength' => 60,
  '#autocomplete_path' => 'user/autocomplete',
  '#default_value' => $node->name,
  '#weight' => -1,
);
?>

#built

Used by: form

Description: Used to ascertain whether or not a form element has been built yet.

Values: TRUE or FALSE

Usage example: INTERNAL. See the _form_builder function in form.inc.

#button_type

Used by: button, image_button, submit

Description: Adds a CSS class to the button, in the form form-[button_type_value]. Note that this does NOT set the HTML attribute type of the button.

Values: String

Usage example: (system.module):

<?php
$type['submit'] = array(
  '#input' => TRUE,
  '#name' => 'op',
  '#button_type' => 'submit',
  '#submit' => TRUE,
);
?>

#collapsed

Used by: fieldset

Description: Indicates whether or not the fieldset is collapsed by default. See #collapsible property.

Values: TRUE or FALSE

Usage example (block.module) :

<?php
$form['block'] = array(
  '#type' => 'fieldset',
  '#title' => t('Block configuration'),
  '#weight' => 3,
  '#collapsible' => TRUE,
  '#collapsed' => FALSE,
  '#tree' => TRUE,
);
?>

#collapsible

Used by: fieldset

Description: Indicates whether or not the fieldset can be collapsed with JavaScript. See #collapsed property.

Values: TRUE or FALSE

Usage example (block.module):

<?php
$form['block'] = array(
  '#type' => 'fieldset',
  '#title' => t('Block configuration'),
  '#weight' => 3,
  '#collapsible' => TRUE,
  '#collapsed' => FALSE,
  '#tree' => TRUE,
);
?>

#cols

Used by: textarea

Description: How many columns wide the textarea should be (see also #rows)

Values: A positive number

Usage example (aggregator.module):

<?php
$form['description'] = array(
  '#type' => 'textarea',
  '#title' => t('Description'),
  '#default_value' => $edit['description'],
  '#cols' => 60,
  '#rows' => 5,
);
?>

#default_value

Used by: checkbox, checkboxes, date, hidden, radio, radios, select, textarea, textfield, token, weight

Description: The value of the form element that will be displayed or selected initially if the form has not been submitted yet. Should NOT be confused with #value, which is a hard-coded value the user cannot change!

Values: Mixed

Usage example (forum.module):

<?php
$form['body'] = array(
  '#type' => 'textarea',
  '#title' => t('Body'),
  '#default_value' => $node->body,
  '#required' => TRUE,
);
?>

#delta

Used by: weight

Description: Number of weights to have selectable. For example, with $delta => 10, the weight selection box would display numbers from -10 to 10.

Values: A positive number

Usage example (menu.module):

<?php
$form['weight'] = array(
  '#type' => 'weight',
  '#title' => t('Weight'),
  '#default_value' => $edit['weight'],
  '#delta' => 10,
  '#description' => t('Optional. In the menu, the heavier items will sink and the lighter items will be positioned nearer the top.'),
);
?>

#description

Used by: checkbox, checkboxes, date, fieldset, file, item, password, password_confirm, radio, radios, select, textarea, textfield, weight

Description: The description of the form element. Make sure to enclose inside the t() function so this property can be translated.

Values: Mixed

Usage example (menu.module):

<?php
$form['weight'] = array(
  '#type' => 'weight',
  '#title' => t('Weight'),
  '#default_value' => $edit['weight'],
  '#delta' => 10,
  '#description' => t('Optional. In the menu, the heavier items will sink and the lighter items will be positioned nearer the top.'),
);
?>

#disabled

Used by: button, checkbox, checkboxes, date, file, image_button, password, password_confirm, radio, radios, select, submit, textarea, textfield, weight

Description: Disables (greys out) a form input element. Note that disabling a form field doesn't necessarily prevent someone from submitting a value through DOM manipulation. It just tells the browser not to accept input.

Values: TRUE or FALSE

Usage example (system.module):

<?php
      if (isset($disabled[$name])) {
        $form['theme_settings'][$name]['#disabled'] = TRUE;
      }
?>

#element_validate

Used by: any element

Description: A list of custom validation functions that need to be passed. The functions must use form_error() or form_set_error() to set an error if the validation fails.

Values: an array of function names to be called to validate this element (and/or its children).

A validation function for an element takes the element and the form state as parameters, and has the form:

function myelement_validate($element, &$form_state) {
   if (empty($element['#value'])) {
     form_error($element, t('This field is required.'));
   }
}

Usage example (filter.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
  if (count($formats) > 1) {
    $form = array(
      '#type' => 'fieldset',
      '#title' => t('Input format'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#weight' => $weight,
      '#element_validate' => array('filter_form_validate'),
    );
   ...
?>

#error

INTERNAL. Indicates whether or not a form element has been flagged as having an error.

#executes_submit_callback

Used by: button, image_button, submit

Description: Indicates whether or not button should submit the form.

Values: TRUE or FALSE

#id

INTERNAL. Used to populate form elements' id property. In rare cases, you can set this value yourself on a form element, to override the default setting.

#input

INTERNAL. Indicates whether or not input is possible for this form element.

#field_prefix

Used by: textfield

Description: Text or code that is placed directly in front of the textfield. This can be used to prefix a textfield with a constant string.

Values: Mixed

Usage example (system.module):

<?php
$form['site_403'] = array(
  '#type' => 'textfield',
  '#title' => t('Default 403 (access denied) page'),
  '#default_value' => variable_get('site_403', ''),
  '#size' => 40,
  '#description' => t('This page is displayed when the requested document is denied to the current user. If unsure, specify nothing.'),
  '#field_prefix' => url(NULL, NULL, NULL, TRUE) . (variable_get('clean_url', 0) ? '' : '?q=')
);
?>

#field_suffix

Used by: textfield

Description: Text or code that is placed directly after a textfield. This can be used to add a unit to a textfield.

Values: Mixed

Usage example (system.module):

<?php
$form['settings_general']['upload_usersize_default'] = array(
  '#type' => 'textfield',
  '#title' => t('Default total file size per user'),
  '#default_value' => $upload_usersize_default,
  '#size' => 5,
  '#maxlength' => 5,
  '#description' => t('The default maximum size of all files a user can have on the site.'),
  '#field_suffix' => t('MB')
);

#maxlength

Used by: password, textfield

Description: The maximum amount of characters to accept as input.

Values: A positive number.

Usage example (forum.module):

<?php
$form['title'] = array(
  '#type' => 'textfield',
  '#title' => t('Subject'),
  '#default_value' => $node->title,
  '#size' => 60,
  '#maxlength' => 128,
  '#required' => TRUE,
);
?>

#method

Used by: form

Description: The HTTP method with which the form will be submitted.

Values: GET or POST. Default is POST.

Usage example (node.module):

<?php
$form['#method'] = 'post';
?>

#multiple

Used by: select

Description: Indicates whether the user may select more than one item.

Values: TRUE or FALSE

Usage example (taxonomy.module):

<?php
return array(
  '#type' => 'select',
  '#title' => $title,
  '#default_value' => $value,
  '#options' => $options,
  '#description' => $description,
  '#multiple' => $multiple,
  '#size' => $multiple ? min(12, count($options)) : 0,
  '#weight' => -15,
);
?>

#name

Used by: button, submit

Description: INTERNAL, except for buttons. All button and submit elements on a form should have the same name, which is set to 'op' by default in Drupal. This does not apply to image buttons. For non-button elements, Drupal sets the name by using 'foo' in $form['foo'] as well as any parents of the element.

Values: String.

#options

Used by: checkboxes, radios, select

Description: Selectable options for a form element that allows multiple choices.

Values: An array in the form of array(t('Display value 1'), t('Display value 2')) or array('return_value1' => t('Display Value 1'), 'return_value2' => t('Display Value 2')) if specific return values are required.

Usage example (comment.module):

<?php
$form['posting_settings']['comment_preview'] = array(
  '#type' => 'radios',
  '#title' => t('Preview comment'),
  '#default_value' => variable_get('comment_preview', 1),
  '#options' => array(t('Optional'), t('Required')),
);
?>

#parents

Used by: All

Description: Identifies parent form elements. See #tree and #parents in the handbook.

Values: An array of element names.

Usage example (comment.module):

<?php
$form['admin']['status'] = array(
  '#type' => 'radios',
  '#parents' => array('status'),
  '#title' => t('Status'),
  '#default_value' => $status,
  '#options' => array(t('Published'), t('Not published')),
  '#weight' => -1,
);
?>

#post_render

Used by: All elements and forms

Description: Function(s) to call after rendering in drupal_render() has occured. The named function is called with two arguments, the rendered element and its children. It returns the (potentially) altered) element content.

Values: An array of function names to call.

Usage example:

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
$form['admin']['#post_render'] = array('admin_form_html_cleanup');
?>

This example would call admin_form_html_cleanup($content, $element) after $element has been rendered to $content via drupal_render(). $content may then be modified and must be returned.

#prefix

Used by: All elements and forms.

Description: Text or markup to include before the form element. Also see #suffix.

Values: Mixed

Usage example (poll.module):

<?php
$form['choice'] = array(
  '#type' => 'fieldset',
  '#title' => t('Choices'),
  '#prefix' => '<div class="poll-form">',
  '#suffix' => '</div>',
  '#tree' => TRUE,
);
?>

#pre_render

Used by: All elements and forms.

Description: Function(s) to call before rendering in drupal_render() has occured. The function(s) provided in #pre_render receive the element as an argument and must return the altered element.

Values: An array of function names to call.

Usage example (filter.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! As demonstrated here, you will probably want to add to the existing array rather than writing over it.

// Prepend #pre_render callback to replace field value with user notice
// prior to rendering.
if (!isset($element['value']['#pre_render'])) {
  $element['value']['#pre_render'] = array();
}
array_unshift($element['value']['#pre_render'], 'filter_form_access_denied');

...
function filter_form_access_denied($element) {
  $element['#value'] = t('This field has been disabled because you do not have sufficient permissions to edit it.');
  return $element;
}

This example would call filter_form_access_denied($element) before the $element has been rendered via drupal_render(). $element may then be modified and is returned for rendering.

#printed

INTERNAL. Used to determine whether or not a form element has been printed yet.

#process

Description: An array of functions that are called when an element is processed. Using this callback, modules can "register" further actions. For example the "radios" form type is expanded to multiple radio buttons using a processing function.

Values: Array of function names (strings)

Usage example (system.module) in system_elements():

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

$type['radios'] = array('#input' => TRUE, '#process' => array('expand_radios'));

In this example, the function expand_radios is called; the entire radios element is passed in as the argument. This function adds new elements of type radio to the existing radios element array, with keys and values corresponding to the processed element's #options.

#processed

INTERNAL. Used to ascertain whether or not a form element has been processed (ie: expanded to multiple elements).

#redirect

Used by: form

Description: The default goto value after form is submitted. This value should be returned by a form's submit callback function, but altering another form's #redirect value by using hook_form_alter() can be useful to change where that form redirects after it is submitted. Also see #action.

Values: An internal path or an array of arguments to pass to drupal_goto() (check that function's documentation for information on the arguments). The value may also be set to FALSE to prevent redirection after form submission.

Usage example (locale.inc):

<?php
$form['#redirect'] = 'node';
?>

<?php
$form['#redirect'] = array('user/login', 'destination=node&foo=bar');
?>

<?php
$form['#redirect'] = FALSE;
?>

#required

Used by: checkbox, checkboxes, date, file, password, password_confirm, radio, radios, select, textarea, textfield, weight

Description: Indicates whether or not the element is required. This automatically validates for empty fields, and flags inputs as required. File fields are NOT allowed to be required.

Values: TRUE or FALSE

Usage example (forum.module):

<?php
$form['title'] = array(
  '#type' => 'textfield',
  '#title' => t('Subject'),
  '#default_value' => $node->title,
  '#size' => 60,
  '#maxlength' => 128,
  '#required' => TRUE,
);
?>

#resizable

Used by: textarea

Description: Whether users should be allowed to resize the text area

Values: TRUE or FALSE

#return_value

Used by: checkbox, image_button, radio

Description: Value element should return when selected

Values: Mixed

Usage example (poll.module):

<?php
$form['morechoices'] = array(
  '#type' => 'checkbox',
  '#title' => t('Need more choices'),
  '#return_value' => 1,
  '#default_value' => 0,
  '#description' => t("If the amount of boxes above isn't enough, check this box and click the Preview button below to add some more."),
);
?>

#rows

Used by: textarea

Description: How many rows high the textarea should be (see also #cols)

Values: A positive number

Usage example (aggregator.module):

<?php
$form['description'] = array(
  '#type' => 'textarea',
  '#title' => t('Description'),
  '#default_value' => $edit['description'],
  '#cols' => 60,
  '#rows' => 5,
);
?>

#size

Used by: file, password, password_confirm, select, textfield

Description: Width of the textfield (in characters) or size of multiselect box (in lines).

Values: A positive number.

Usage example (comment.module):

<?php
        $form['admin']['homepage'] = array(
          '#type' => 'textfield',
          '#title' => t('Homepage'),
          '#maxlength' => 255,
          '#size' => 30,
          '#default_value' => $edit['homepage'],
        );
?>

#src

Used by: image_button

Description: The URL of the image of the button.

Values: An URL.

#submit

Used by: button, form, image_button, submit

Description: Contains a list of submit callbacks to be excuted on the form or only when a specific button is clicked.

Values: An array of function names.

Usage example (menu.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
function menu_form_alter(&$form, $form_state, $form_id) {
   ... 
    $form['menu']['parent'] = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $default,
      '#options' => $options,
      '#attributes' => array('class' => 'menu-title-select'),
    );
    $form['#submit'][] = 'menu_node_form_submit';
}
?>

Usage example (menu.module):

<?php
    $form['menu_name'] = array('#type' => 'value', '#value' => $menu['menu_name']);
    $form['#insert'] = FALSE;
    $form['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
      '#access' => !in_array($menu['menu_name'], menu_list_system_menus()),
      '#submit' => array('menu_custom_delete_submit'),
      '#weight' => 10,
    );
?>

#suffix

Used by: All elements and forms

Description: Text or markup to include after the form element. Also see #prefix.

Values: Mixed

Usage example (poll.module):

<?php
$form['choice'] = array(
  '#type' => 'fieldset',
  '#title' => t('Choices'),
  '#prefix' => '<div class="poll-form">',
  '#suffix' => '</div>',
  '#tree' => TRUE,
);
?>

#theme

Used by: All elements and forms.

Description: Theme function to call for element.

Values: The name of a theme function, without the initial theme_.

Usage example (upload.module):

<?php
$form['#theme'] = 'upload_form_new';
?>

#title

Used by: checkbox, checkboxes, date, fieldset, file, item, password, password_confirm, radio, radios, select, textarea, textfield, weight

Description: The title of the form element. Make sure to enclose inside the t() function so this property can be translated.

Values: Mixed

Usage example (aggregator.module):

<?php
$form['description'] = array(
  '#type' => 'textarea',
  '#title' => t('Description'),
  '#default_value' => $edit['description'],
  '#cols' => 60,
  '#rows' => 5,
);
?>

#tree

Used by: All

Description: Used to allow collections of form elements. Normally applied to the "parent" element, as the #tree property cascades to sub-elements. Use where you previously used ][ in form_ calls. For more information, see #tree and #parents in the handbook.

Values: TRUE or FALSE

Usage example (system.module):

<?php
$form['status'] = array(
  '#type' => 'checkboxes',
  '#default_value' => $status,
  '#options' => $options,
  '#tree' => TRUE,
);
$required = array('block', 'filter', 'system', 'user', 'watchdog');
foreach ($required as $require) {
  $form['status'][$require] = array(
    '#type' => 'hidden',
    '#value' => 1,
    '#suffix' => t('required'),
  );
}
?>

#type

Used by: All

Description: Used to determine the type of form element.

Values: button, checkbox, checkboxes, date, fieldset, file, form, hidden, image_button, item, markup, password, password_confirm, radio, radios, select, submit, textarea, textfield, token, value, weight

Usage example (locale.module):

<?php
$form['submit'] = array('#type' => 'submit', '#value' => t('Import'));
?>

#validate

Used by: button, image_button, form, submit

Description: A list of custom validation functions that need to be passed.This is usually used to add additional validation functions to a form, or to use an alternate function rather than the default form validation function which is the form ID with _validate appended to it.

Values: An array of function names. Each such function will take $form and $form_state as parameters and should use form_set_error() if the form values do not pass validation. For example:

function test_form_validate($form, &$form_state) {
  if ($form_state['values']['name'] == '') {
    form_set_error('name', t('You must select a name for this group of settings.'));
  }
}

Usage example (node.module):

Note: If you are altering an existing form via hook_form_alter() or a similar means, be careful with this property! You will probably want to add to the existing array rather than writing over it, so don't follow this usage example exactly.

<?php
    // Node types:
    $types = array_map('check_plain', node_get_types('names'));
    $form['advanced']['type'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Only of the type(s)'),
      '#prefix' => '<div class="criterion">',
      '#suffix' => '</div>',
      '#options' => $types,
    );
    $form['advanced']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Advanced search'),
      '#prefix' => '<div class="action">',
      '#suffix' => '</div>',
    );

    $form['#validate'][] = 'node_search_validate';
?>

#validation_arguments

INTERNAL

#value

Used by: button, hidden, image_button, item, markup, submit, token, value

Description: Used to set values that cannot be edited by the user. Should NOT be confused with #default_value, which is for form inputs where users can override the default value.

Values: Mixed (text or numbers)

Usage example (locale.module):

<?php
$form['submit'] = array('#type' => 'submit', '#value' => t('Import'));
?>

#weight

Used by: All elements

Description: Used to sort the list of form elements before being output; lower numbers appear before higher numbers.

Values: A positive or negative number (integer or decimal)

Usage example (book.module):

<?php
$form['parent'] = array(
  '#type' => 'select',
  '#title' => t('Parent'),
  '#default_value' => ($node->parent ? $node->parent : arg(4)),
  '#options' => book_toc($node->nid),
  '#weight' => -15,
  '#description' => t('The parent that this page belongs in. Note that pages whose parent is &lt;top-level&gt; are regarded as independent, top-level books.'),
);
?>

File

developer/topics/forms_api_reference.html
View source

Comments

Posted by EugenMayer on

Please watch out using #disabled, as the user can use DOM manipulation and the still submit values you did not suggest. So its not readonly, as the FAPI does not secures its value is kept

Posted by Andy Udvare on

To protect against this, for example if the user is editing a previously completed form, the old data should be stored in $form_state['storage'] to retrieve later in the validation or submission function if you are trying to protect overwriting old values.

Posted by juankvillegas on

Using #value instead of #default_value must solve the problem

Posted by girishmuraly on

Just re-posting what user aaron posted here - http://drupal.org/node/406802#comment-1494314

The default event for AHAH submit buttons is 'mousedown'. Due to this, even right-clicking on an AHAH button submitted it for me, causing much pain for some time.

Posted by dotpex on

Date is parent of three child select element, to change it you need to add #process function on date element in hook_form_alter.
This is override fapi #process function 'expand_date', from file form.inc
Example birth date on register form, changing years range from 1900-2050 to "only older than 14 can register".

<?php
$form['Your info']['profile_birth_date']['#process'] = array('my_override_func');

function

my_override_func($element) {
  // Default to current date
  if (empty($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

 

$element['#tree'] = TRUE;

 

// Determine the order of day, month, year in the site's chosen date format.
  $format = variable_get('date_format_short', 'm/d/Y - H:i');
  $sort = array();
  $sort['day'] = max(strpos($format, 'd'), strpos($format, 'j'));
  $sort['month'] = max(strpos($format, 'm'), strpos($format, 'M'));
  $sort['year'] = strpos($format, 'Y');
  asort($sort);
  $order = array_keys($sort);

 

// Output multi-selector for date.
  foreach ($order as $type) {
    switch ($type) {
      case 'day':
        $options = drupal_map_assoc(range(1, 31));
        break;
      case 'month':
        $options = drupal_map_assoc(range(1, 12), 'map_month');
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, (date('Y') - 14)));
        break;
    }
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
  }

  return

$element;
}
?>

sorry about my english.

Posted by texas-bronius on

Having to implement a simple date (an array) or datetime field on a system_settings_form for checking by $node->created (a timestamp), I stopped pulling out my hair when I switched to date_api.

Download date, enable date_api alone, and implement '#type' => 'date_select' and you get easy, date or datetime values and a nifty UI.

Posted by jefkin on

Beware, sometimes default value fails -- there should be a note about this in this documentation:

<?php
$type = array ( '#type'         =>'radios'
             ,  '#title'        =>t('Post type')
             ,  '#default_value'=>$internal
             ,  '#options'      =>array ( 0 =>t('Medical'), 1 =>t('Internal') )
             , );
?>

if your $internal is 1 "Internal" will be selected, as expected, but if it is 0, Nothing will be selected, I repeat; "Medical" will not be selected!

You can, of course, work around this by using non-zero, or named options. I believe core should be patched to test and allow '#default_value' === 0
... as this can have meaning. But pending that, you need to write extra code to swap out names for numbers or some other trick.

Posted by oknate on

I couldn't find a tutorial that explained how to change the rows of a cck textarea in the node form (Drupal 6). Here's the basics:

My client wanted to change the number of rows on the node input form.

<?php
function mycustommodule_form_alter(&$form, $form_state, $form_id) {

   

    if(

$form_id == 'mycustomnodetype_node_form') {

       

$form['#field_info']['field_mycustom_cck_field']['widget']['rows'] = 5;
        $form['body_field']['body']['#rows'] = 5;
       }

}
       

?>

Posted by Andy Udvare on

Most of the time, modifications to CCK fields should be done in an #after_build callback to ensure you get the entire form and all modules have done their modifications before yours (this is of course based on weights in the DB).

<?php
function some_module_form_alter(&$form, $form_state, $form_id) {
  $form['#after_build'][] = 'some_form_after_build';
}

function

some_form_after_build($form, &$form_state) {
  $form['field']['#type'] = 'hidden';
  return $form;
}
?>

Posted by doublejosh on

Still getting errors when using #after_build rather than direct altering.

warning: htmlspecialchars() expects parameter 1 to be string, array given in /MYSITE/includes/bootstrap.inc on line 863.

Posted by mtsanford on

If you use #after_build, don't forget to return the $form, or $form_element (first argument to your callback). You are not expected to receive it by reference like with hook_form_alter for some reason, and you will likely get a WSOD.

Posted by tmsimont on

I copied and pasted that example because i wanted to acheive the same affect for my field prefix-- but that is outdated use of the url() function

wrong:
url(NULL, NULL, NULL, TRUE)

see here:
http://api.drupal.org/api/drupal/includes--common.inc/function/url/6

-trevor

Posted by Tecktron on

NOTE: If using associated arrays to populate the options of a multiple select box input type, the '#default_values' needs to come before '#options' in order to have the input type repopulated correctly. See post: http://drupal.org/node/967366

Posted by SangersDrupalDude on

don't forget the $form=array(), that was my issue...

function mytheme_form($form){
  $form=array();

Posted by Jztinfinity on

The way the #image_button type functions in Drupal is slightly insane, partially because of how browsers handle image_buttons and cross-browser compatibility. Here are some guidelines for image buttons to prevent the madness, courtesy of Sid M and this issue:

1) Do give each image_button a unique #name (unlike regular buttons, you can't have several image_buttons all named op).
2) Don't give an image_button a #default_value.
3) Don't give an image_button a #value
4) Do give each image_button a #return_value. This is the same as what you would assign to #value if IE6 problems hadn't forced Drupal to implement some unusual element handling. If you don't assign this, it will default to true.
5) Do use $form_state['clicked_button']['#value'] to find the #value of, well, the clicked image_button. This field will contain the value of #return_value for the clicked image_button.

Posted by mattconnolly on

The element_validate example should read:

<?php
      function myelement_validate($element, &$form_state) {
         if (empty($element['#value'])) {
           form_error($element['#name'], t('This field is required.'));
         }
      }
?>

Posted by tmsimont on

the example provided is fine, do not use $element['#name'] as the first argument of form_error, it throws an error (improper arguments passed to implode(). The proper way to use form_error() is how the example in the above documentation uses it:

<?php
function myelement_validate($element, &$form_state) {
   if (empty($element['#value'])) {
     form_error($element, t('This field is required.'));
   }
}
?>

Posted by Tokoh on

I display row numbers of a table from a form using the type item.
It worked in Drupal 6 but in Drupal 7.7 the '#value' doesn't seem to display.
I've moved the code elsewhere, changed it to a fixed value, but I can't get it to show.
What am I doing wrong?

<?php
$form['dimensionset']['row'] = array(
        '#type' => 'item',
        '#title' => t('Row'),
        '#value' => ($form_state['storage']['step'] - 3),
        '#prefix' => '<div><div style="float:left;">',
        '#suffix' => '</div>',
    );
?>

Posted by isaac.niebeling on

You've probably long-since discovered this or given up, but item and markup fields use #markup, not #value in D7.

Posted by fuerst on

Drupal 6: Be aware that currently the #id attribute get removed from the types radios and checkboxes. If you want them in the form-item wrapper DIV you need to put theme_radios() and theme_checkboxes() into your template.php. Remove the line unset($element['#id']); in both function. See http://drupal.org/node/453400 for a discussion about this.

Posted by dotpex on

Not mentioned in this page: #maxlength can be used with textarea.

Posted by bartl on

To ensure a better compatibility with the built in error messages for required fields, the example code under "#element_validate" should look more like this:

<?php
function myelement_validate($element, &$form_state) {
   if (empty($element['#value'])) {
     form_error($element,  t('!name field is required.', array('!name' => $element['#title'])));
   }
}
?>

Posted by calvintennant on

Note that you need to register the theme function in hook_theme before you can use it as a #theme form element. #doh

function my_module_theme($existing, $type, $theme, $path) {
  return array(
    'my_module_my_custom_form' => array(
    'arguments' => array('form' => null),
  ),
}

Posted by Tom.Camp on

Is there any plan to allow HTML5 form elements such as email, tel, search, url, email, etc.? I realize that they not all supported by all browsers yet, but they will be anon.

Posted by Ayesh on

If you are altering an existing form using hook_form_alter(), make sure that you don't replace #attributes array completely.
e.x:

<?php
$form['my_field']['#attributes']['rel'] = 'lightbox'; // do this.
$form['my_field']['#attributes'] = array('rel' => 'lightbox'); // do NOT do this.
?>

Posted by texas-bronius on

Not documented above, set form element attribute '#wysiwyg' => FALSE to disable any rich text editor like FckEditor, TinyMCE, forcing plain text textarea.

For example:

<?php
    $form['body'] = array(
      '#type' => 'textarea',
      '#title' => $title,
      '#wysiwyg' => FALSE,
    );
?>

Thanks to @jeff00seattle's comment on May 12, 2009 at 9:21pm merely transcribed here.

来自 https://api.drupal.org/api/drupal/developer!topics!forms_api_reference.html/6

普通分类: 
drupal
Powered by Drupal

友情链接

校园好文网

 www.shipingzhong.cn  个人技术网_前端_后台    备案号:苏ICP备18010659号-2