function filter_admin_overview

Page callback: Form constructor for a form to list and reorder text formats.

See also

filter_menu()

filter_admin_overview_submit()

Related topics

1 string reference to 'filter_admin_overview'
filter_menu in modules/filter/filter.module
Implements hook_menu().

File

modules/filter/filter.admin.inc, line 15

Code

function filter_admin_overview($form) {
    // Overview of all formats.
    $formats = filter_formats();
    $fallback_format = filter_fallback_format();
    $form['#tree'] = TRUE;
    foreach ($formats as $id => $format) {
        // Check whether this is the fallback text format. This format is available
        // to all roles and cannot be disabled via the admin interface.
        $form['formats'][$id]['#is_fallback'] = $id == $fallback_format;
        if ($form['formats'][$id]['#is_fallback']) {
            $form['formats'][$id]['name'] = array(
                '#markup' => drupal_placeholder($format->name),
            );
            $roles_markup = drupal_placeholder(t('All roles may use this format'));
        }
        else {
            $form['formats'][$id]['name'] = array(
                '#markup' => check_plain($format->name),
            );
            $roles = array_map('check_plain', filter_get_roles_by_format($format));
            $roles_markup = $roles ? implode(', ', $roles) : t('No roles may use this format');
        }
        $form['formats'][$id]['roles'] = array(
            '#markup' => $roles_markup,
        );
        $form['formats'][$id]['configure'] = array(
            '#type' => 'link',
            '#title' => t('configure'),
            '#href' => 'admin/config/content/formats/' . $id,
        );
        $form['formats'][$id]['disable'] = array(
            '#type' => 'link',
            '#title' => t('disable'),
            '#href' => 'admin/config/content/formats/' . $id . '/disable',
            '#access' => !$form['formats'][$id]['#is_fallback'],
        );
        $form['formats'][$id]['weight'] = array(
            '#type' => 'weight',
            '#title' => t('Weight for @title', array(
                '@title' => $format->name,
            )),
            '#title_display' => 'invisible',
            '#default_value' => $format->weight,
        );
    }
    $form['actions'] = array(
        '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Save changes'),
    );
    return $form;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.