function filter_formats

Retrieves a list of text formats, ordered by weight.

Parameters

$account: (optional) If provided, only those formats that are allowed for this user account will be returned. All formats will be returned otherwise.

Return value

An array of text format objects, keyed by the format ID and ordered by weight.

See also

filter_formats_reset()

14 calls to filter_formats()
FilterCrudTest::testTextFormatCrud in drupal/core/modules/filter/lib/Drupal/filter/Tests/FilterCrudTest.php
Tests CRUD operations for text formats and filters.
FilterFormatAccessTest::testFormatPermissions in drupal/core/modules/filter/lib/Drupal/filter/Tests/FilterFormatAccessTest.php
FilterFormatAccessTest::testFormatWidgetPermissions in drupal/core/modules/filter/lib/Drupal/filter/Tests/FilterFormatAccessTest.php
Tests editing a page using a disallowed text format.
filter_admin_overview in drupal/core/modules/filter/filter.admin.inc
Form constructor for a form to list and reorder text formats.
filter_default_format in drupal/core/modules/filter/filter.module
Returns the ID of the default text format for a particular user.

... See full list

2 string references to 'filter_formats'
FilterAdminTest::testFilterAdmin in drupal/core/modules/filter/lib/Drupal/filter/Tests/FilterAdminTest.php
Tests filter administration functionality.
filter_formats_reset in drupal/core/modules/filter/filter.module
Resets the text format caches.

File

drupal/core/modules/filter/filter.module, line 449
Framework for handling the filtering of content.

Code

function filter_formats($account = NULL) {
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
  $formats =& drupal_static(__FUNCTION__, array());

  // All available formats are cached for performance.
  if (!isset($formats['all'])) {
    if ($cache = cache()
      ->get("filter_formats:{$language_interface->langcode}")) {
      $formats['all'] = $cache->data;
    }
    else {
      $formats['all'] = db_select('filter_format', 'ff')
        ->addTag('translatable')
        ->fields('ff')
        ->condition('status', 1)
        ->orderBy('weight')
        ->execute()
        ->fetchAllAssoc('format');
      cache()
        ->set("filter_formats:{$language_interface->langcode}", $formats['all'], CacheBackendInterface::CACHE_PERMANENT, array(
        'filter_formats' => TRUE,
      ));
    }
  }

  // Build a list of user-specific formats.
  if (isset($account) && !isset($formats['user'][$account->uid])) {
    $formats['user'][$account->uid] = array();
    foreach ($formats['all'] as $format) {
      if (filter_access($format, $account)) {
        $formats['user'][$account->uid][$format->format] = $format;
      }
    }
  }
  return isset($account) ? $formats['user'][$account->uid] : $formats['all'];
}