Commit f2d90e99 authored by Dries's avatar Dries

- Patch #606796 by jhodgdon: fixed documentation inaccuracy with filter_form().

parent 08386dac
......@@ -615,17 +615,21 @@ function check_markup($text, $format_id = NULL, $langcode = '', $cache = FALSE)
}
/**
* Generate a selector for choosing a format in a form.
* Generates a selector for choosing a format in a form.
*
* @ingroup forms
* @param $selected_format
* The ID of the format that is currently selected.
* The ID of the format that is currently selected; uses the default format
* for the current user if not provided.
* @param $weight
* The weight of the text format.
* The weight of the form element within the form.
* @param $parents
* Required when defining multiple text formats on a single node or having a different parent than 'format'.
* The parents array of the element. Required when defining multiple text
* formats on a single form or having a different parent than 'format'.
*
* @return
* HTML for the form element.
* Form API array for the form element.
*
* @ingroup forms
*/
function filter_form($selected_format = NULL, $weight = NULL, $parents = array('format')) {
global $user;
......
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