1 filter.module filter_format_load($format_id)

Loads a text format object from the database.

Parameters

$format_id: The format ID.

Return value

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

File

core/modules/filter/filter.module, line 247
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;
}