function filter_format_load

1 filter.module filter_format_load($format_id, $load_if_disabled = FALSE)

Loads a text format object from the database.

Parameters

$format_id: The format ID.

boolean $load_if_disabled: If TRUE the format will be loaded when disabled.

Return value

stdClass|FALSE: A fully-populated text format object or FALSE if the format is not found.

See also

filter_format_exists()

22 calls to filter_format_load()

BlockTestCase::setUp in core/modules/block/tests/block.test: Sets up a Backdrop site for running functional and integration tests.
BlockTestCase::testCustomBlockFormat in core/modules/block/tests/block.test: Test creating custom block using Raw HTML (full_html).
check_markup in core/modules/filter/filter.module: Runs all the enabled filters on a piece of text.
CKEditor5UpgradeTestCase::testUpgrade in core/modules/ckeditor5/tests/ckeditor5_upgrade.test: Test upgrading a CKEditor 4 text format to CKEditor 5.
FilterAdminTestCase::setUp in core/modules/filter/tests/filter.test: Sets up a Backdrop site for running functional and integration tests.

... See full list

File

core/modules/filter/filter.module, line 263: Framework for handling the filtering of content.

Code

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