Commit d3c83c02 authored by Dries's avatar Dries

- Patch #942718 by joachim: drupal_get_form() and hook_form_alter() should mention #parameters.

parent 0281833b
......@@ -163,7 +163,9 @@
* Any additional arguments are passed on to the functions called by
* drupal_get_form(), including the unique form constructor function. For
* example, the node_edit form requires that a node object is passed in here
* when it is called.
* when it is called. These are available to implementations of
* hook_form_alter() and hook_form_FORM_ID_alter() as the array
* $form_state['build_info']['args'].
*
* @return
* The form array.
......
......@@ -1404,7 +1404,9 @@ function hook_page_alter(&$page) {
* @param $form
* Nested array of form elements that comprise the form.
* @param $form_state
* A keyed array containing the current state of the form.
* A keyed array containing the current state of the form. The arguments
* that drupal_get_form() was originally called with are available in the
* array $form_state['build_info']['args'].
* @param $form_id
* String representing the name of the form itself. Typically this is the
* name of the function that generated the form.
......@@ -1432,7 +1434,9 @@ function hook_form_alter(&$form, &$form_state, $form_id) {
* @param $form
* Nested array of form elements that comprise the form.
* @param $form_state
* A keyed array containing the current state of the form.
* A keyed array containing the current state of the form. The arguments
* that drupal_get_form() was originally called with are available in the
* array $form_state['build_info']['args'].
* @param $form_id
* String representing the name of the form itself. Typically this is the
* name of the function that generated the form.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment