Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

- Patch #727126 by jhodgdon: fixed drupal_execute()/drupal_form_submit() documentation.

merge-requests/26/head
Dries Buytaert 2010-03-04 09:07:27 +00:00
parent e5e3d279e2
commit 0f4ec342a1
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
includes/form.inc
View File

@ -415,9 +415,14 @@ function form_state_keys_no_cache() {
} }
/** /**
* Retrieves a form using a form_id, populates it with $form_state['values'], * Retrieves, populates, and processes a form.
* processes it, and returns any validation errors encountered. This *
* function is the programmatic counterpart to drupal_get_form(). * This function allows you to supply values for form elements and submit a
* form for processing. Compare to drupal_get_form(), which also builds and
* processes a form, but does not allow you to supply values.
*
* There is no return value, but you can check to see if there are errors
* by calling form_get_errors().
* *
* @param $form_id * @param $form_id
* The unique string identifying the desired form. If a function * The unique string identifying the desired form. If a function
@ -440,7 +445,6 @@ function form_state_keys_no_cache() {
* For example, the node_edit form requires that a node object be passed * For example, the node_edit form requires that a node object be passed
* in here when it is called. * in here when it is called.
* For example: * For example:
*
* @code * @code
* // register a new user * // register a new user
* $form_state = array(); * $form_state = array();
@ -450,7 +454,6 @@ function form_state_keys_no_cache() {
* $form_state['values']['pass']['pass2'] = 'password'; * $form_state['values']['pass']['pass2'] = 'password';
* $form_state['values']['op'] = t('Create new account'); * $form_state['values']['op'] = t('Create new account');
* drupal_form_submit('user_register_form', $form_state); * drupal_form_submit('user_register_form', $form_state);
*
* // Create a new node * // Create a new node
* $form_state = array(); * $form_state = array();
* module_load_include('inc', 'node', 'node.pages'); * module_load_include('inc', 'node', 'node.pages');