function filter_admin_format_page in Drupal 7
Same name and namespace in other branches
- 6 modules/filter/filter.admin.inc \filter_admin_format_page()
Page callback: Displays the text format add/edit form.
Parameters
object|null $format: (optional) An object representing a format, with the following properties:
- format: A machine-readable name representing the ID of the text format to save. If this corresponds to an existing text format, that format will be updated; otherwise, a new format will be created.
- name: The title of the text format.
- cache: (optional) An integer indicating whether the text format is cacheable (1) or not (0). Defaults to 1.
- status: (optional) An integer indicating whether the text format is enabled (1) or not (0). Defaults to 1.
- weight: (optional) The weight of the text format, which controls its placement in text format lists. If omitted, the weight is set to 0. Defaults to NULL.
Return value
A form array.
See also
1 string reference to 'filter_admin_format_page'
- filter_menu in modules/
filter/ filter.module - Implements hook_menu().
File
- modules/
filter/ filter.admin.inc, line 123 - Administrative page callbacks for the Filter module.
Code
function filter_admin_format_page($format = NULL) {
if (!isset($format->name)) {
drupal_set_title(t('Add text format'));
$format = (object) array(
'format' => NULL,
'name' => '',
);
}
return drupal_get_form('filter_admin_format_form', $format);
}