function filter_formats

7.x filter.module filter_formats($account = NULL)
5.x filter.module filter_formats()
6.x filter.module filter_formats($index = NULL)
8.x filter.module filter_formats(AccountInterface $account = NULL)

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 drupal/modules/filter/filter.test
Tests CRUD operations for text formats and filters.
FilterFormatAccessTestCase::testFormatPermissions in drupal/modules/filter/filter.test
Tests the Filter format access permissions functionality.
FilterFormatAccessTestCase::testFormatWidgetPermissions in drupal/modules/filter/filter.test
Tests editing a page using a disallowed text format.
filter_admin_overview in drupal/modules/filter/filter.admin.inc
Page callback: Form constructor for a form to list and reorder text formats.
filter_default_format in drupal/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 drupal/modules/simpletest/tests/upgrade/drupal-6.bare.database.php
Bare installation of Drupal 6.17, for test purposes.
drupal-6.filled.database.php in drupal/modules/simpletest/tests/upgrade/drupal-6.filled.database.php
Filled installation of Drupal 6.17, for test purposes.
FilterAdminTestCase::testFilterAdmin in drupal/modules/filter/filter.test
Tests filter administration functionality.
filter_formats_reset in drupal/modules/filter/filter.module
Resets the text format caches.
filter_update_7000 in drupal/modules/filter/filter.install
Upgrade the {filter_formats} table and rename it to {filter_format}.

File

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