function filter_formats in Drupal 7

Same name and namespace in other branches

1. 8 core/modules/filter/filter.module \filter_formats()
2. 4 modules/filter.module \filter_formats()
3. 5 modules/filter/filter.module \filter_formats()
4. 6 modules/filter/filter.module \filter_formats()
5. 9 core/modules/filter/filter.module \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. Defaults to NULL.

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()

FilterCRUDTestCase::testTextFormatCRUD in modules/filter/filter.test

Tests CRUD operations for text formats and filters.

FilterFormatAccessTestCase::testFormatPermissions in modules/filter/filter.test

Tests the Filter format access permissions functionality.

FilterFormatAccessTestCase::testFormatWidgetPermissions in modules/filter/filter.test

Tests editing a page using a disallowed text format.

filter_admin_overview in modules/filter/filter.admin.inc

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

filter_default_format in modules/filter/filter.module

Returns the ID of the default text format for a particular user.

... See full list

5 string references to 'filter_formats'

drupal-6.bare.database.php in modules/simpletest/tests/upgrade/drupal-6.bare.database.php

drupal-6.filled.database.php in modules/simpletest/tests/upgrade/drupal-6.filled.database.php

FilterAdminTestCase::testFilterAdmin in modules/filter/filter.test

Tests filter administration functionality.

filter_formats_reset in modules/filter/filter.module

Resets the text format caches.

filter_update_7000 in modules/filter/filter.install

Upgrade the {filter_formats} table and rename it to {filter_format}.

File

modules/filter/filter.module, line 419

Framework for handling the filtering of content.

Code

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

  // All available formats are cached for performance.
  if (!isset($formats['all'])) {
    if ($cache = cache_get("filter_formats:{$language->language}")) {
      $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->language}", $formats['all']);
    }
  }

  // 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'];
}