Global Functions
Up to Packages
- Db-related functions
get_db— Get the database object.get_recent_files— Get the most recent files.get_record— Get a single record from the database.get_record_by_id— Get a record by its ID.get_records— Get a set of records from the database.total_records— Get the total number of a given type of record in the database.- Collection-related functions
- ElementSet-related functions
- Item-related functions
- ItemType-related functions
- Option-related functions
- Locale-related functions
__ (double underscore)— Translate a string.add_translation_source— Add an translation source directory.format_date— Format a date for output according to the current locale.get_html_lang— Get the HTML “lang” attribute for the current locale.plural— Transform arguments in an array suitable for __.
- Log-related functions
- Plugin-related functions
add_file_display_callback— Add a callback for displaying files with a given mimetype and/or extension.add_file_fallback_image— Add a fallback image for files of the given mime type or type family.add_filter— Declare a filter implementation.add_plugin_hook— Declare a plugin hook implementation within a plugin.apply_filters— Apply a set of plugin filters to a given value.clear_filters— Clear all implementations for a filter (or all filters).fire_plugin_hook— Declare the point of execution for a specific plugin hook.get_plugin_broker— Get the broker object for Omeka plugins.get_plugin_hook_output— Get the output of fire_plugin_hook() as a string.get_plugin_ini— Get specified descriptive info for a plugin from its ini file.get_specific_plugin_hook_output— Get the output of a specific plugin’s hook as a string.plugin_is_active— Determine whether a plugin is installed and active.
- Search-related functions
get_custom_search_record_types— Get all record types that have been customized to be searchable.get_search_query_types— Get all available search query types.get_search_record_types— Get all record types that may be indexed and searchable.item_search_filters— Get a list of the current search item filters in use.search_filters— Get a list of current site-wide search filters in use.search_form— Get the site-wide search form.
- Text-related functions
html_escape— Escape a value to display properly as HTML.js_escape— Escape a value for use in javascript.snippet— Return a substring of a given piece of text.snippet_by_word_count— Return a substring of the text by limiting the word count.strip_formatting— Strip HTML tags from a string.text_to_id— Convert a word or phrase to a valid HTML ID.text_to_paragraphs— Replace newlines in a block of text with paragraph tags.url_to_link— Convert any URLs in a given string to links.url_to_link_callback— Callback for converting URLs with url_to_link.xml_escape— Escape a value for use in XML.
- User-related functions
- Utility-related functions
- View-related functions
add_shortcode— Add a shortcode.all_element_texts— Get all element text metadata for a record.body_tag— Get a <body> tag with attributes.browse_sort_links— Get the list of links for sorting displayed records.flash— Return a flashed message from the controller.get_recent_tags— Get the most recent tags.get_view— Get the view object.is_admin_theme— Determine whether the script is being executed through the admin interface.lightgallery— Display lightGallery media viewer.lightgallery_other_files— Display “other files” from lightGallery,metadata— Get metadata for a record.option— Get the value of a particular site setting for display.random_featured_collection— Get HTML for displaying a random featured collection.queue_lightgallery_assets— Queue assets for lightgallery media viewer.record_image— Get an image tag for a record.record_image_url— Get an image URL for a record.tag_attributes— Generate attributes for an HTML tag.- Asset-related functions
- File-related functions
- Form-related functions
- Head-related functions
- Item-related functions
- ItemType-related functions
- Layout-related functions
- Loop-related functions
- Navigation-related functions
- OutputFormat-related functions
- Search-related functions
- Tag-related functions