Same name and namespace in other branches
  1. 6.x modules/filter/filter.module \filter_format_load()

Loads a text format object from the database.

Parameters

$format_id: The format ID.

Return value

A fully-populated text format object, if the requested format exists and is enabled. If the format does not exist, or exists in the database but has been marked as disabled, FALSE is returned.

See also

filter_format_exists()

20 calls to filter_format_load()
BlockTestCase::setUp in modules/block/block.test
Sets up a Drupal site for running functional and integration tests.
BlockTestCase::testCustomBlockFormat in modules/block/block.test
Test creating custom block using Full HTML.
check_markup in modules/filter/filter.module
Runs all the enabled filters on a piece of text.
FilterAdminTestCase::setUp in modules/filter/filter.test
Sets up a Drupal site for running functional and integration tests.
FilterAdminTestCase::testFilterAdmin in modules/filter/filter.test
Tests filter administration functionality.

... See full list

File

modules/filter/filter.module, line 173
Framework for handling the filtering of content.

Code

function filter_format_load($format_id) {
  $formats = filter_formats();
  return isset($formats[$format_id]) ? $formats[$format_id] : FALSE;
}