Global (Theming) Functions¶
All Functions¶
- __ (double underscore) — Translate a string.
- _log — Log a message.
- absolute_url — Get an absolute URL.
- 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.
- add_shortcode — Add a shortcode.
- add_translation_source — Add an translation source directory.
- admin_url — Get a URL to the admin theme.
- all_element_texts — Get all element text metadata for a record.
- apply_filters — Apply a set of plugin filters to a given value.
- auto_discovery_link_tags — Get link tags for the RSS and Atom feeds.
- body_tag — Get a <body> tag with attributes.
- browse_sort_links — Get the list of links for sorting displayed records.
- clear_filters — Clear all implementations for a filter (or all filters).
- common — Get HTML from a view file in the common/ directory.
- css_src — Get the URL to a local css file.
- current_url — Get the current URL with query parameters appended.
- current_user — Return the currently logged in User record.
- debug — Log a message with ‘DEBUG’ priority.
- delete_option — Delete an option from the options table.
- element_exists — Check whether an element set contains a specific element.
- element_form — Get the HTML for a form input for a given Element.
- element_set_form — Return a element set form for a record.
- file_display_url — Get the provided file’s URL.
- file_id3_metadata — Return HTML for a file’s ID3 metadata.
- file_image — Get a customized file image tag.
- file_markup — Get HTML for a set of files.
- files_for_item — Get HTML for all files assigned to an item.
- fire_plugin_hook — Declare the point of execution for a specific plugin hook.
- flash — Return a flashed message from the controller.
- foot — Get the view’s footer HTML.
- format_date — Format a date for output according to the current locale.
- get_acl — Get the ACL object.
- get_collection_for_item — Get the Collection object for the current item.
- get_current_action_contexts — Get all output formats available in the current action.
- get_current_record — Get the current record from the view.
- get_custom_search_record_types — Get all record types that have been customized to be searchable.
- get_db — Get the database object.
- get_html_lang — Get the HTML “lang” attribute for the current locale.
- get_loop_records — Get records from the view for iteration.
- get_next_item — Get the next item in the database.
- get_option — Get an option from the options table.
- 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_previous_item — Get the previous item in the database.
- get_random_featured_collection — Get a random featured collection.
- get_random_featured_items — Get random featured items.
- get_recent_collections — Get the most recently added collections.
- get_recent_files — Get the most recent files.
- get_recent_items — Get the most recently added items.
- get_recent_tags — Get the most recent tags.
- 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.
- get_search_query_types — Get all available search query types.
- get_search_record_types — Get all record types that may be indexed and searchable.
- get_specific_plugin_hook_output — Get the output of a specific plugin’s hook as a string.
- get_table_options — Get the options array for a given table.
- get_theme_option — Get a theme option.
- get_user_roles — Get the names of all user roles.
- get_view — Get the view object.
- has_loop_records — Check if records have been set to the view for iteration.
- head — Get the view’s header HTML.
- head_css — Get the CSS link tags that will be used on the page.
- head_js — Get the JavaScript tags that will be used on the page.
- html_escape — Escape a value to display properly as HTML.
- img — Get the URL to a local image file.
- insert_collection — Insert a collection
- insert_element_set — Insert an element set and its elements into the database.
- insert_files_for_item — Add files to an item.
- insert_item — Insert a new item into the Omeka database.
- insert_item_type — Insert a new item type.
- is_admin_theme — Determine whether the script is being executed through the admin interface.
- is_allowed — Check whether the current user has a give permission.
- is_current_url — Check if the given URL matches the current request URL.
- item_image — Get a customized item image tag.
- item_image_gallery — Get a gallery of file thumbnails for an item.
- item_search_filters — Get a list of the current search item filters in use.
- item_type_elements — Get the set of values for item type elements.
- items_output_url — Get a URL to an output format page.
- items_search_form — Return the HTML for an item search form.
- js_escape — Escape a value for use in javascript.
- js_tag — Get a tag for including a local JavaScript file.
- label_table_options — Add a “Select Below” or other label option to a set of select options.
- latest_omeka_version — Get the latest available version of Omeka.
- link_to — Get a link to a page within Omeka.
- link_to_admin_home_page — Get a link to the admin home page.
- link_to_collection — Get a link to a collection.
- link_to_collection_for_item — Get a link to the collection to which the item belongs.
- link_to_file_show — Get a link to the file metadata page for a particular file.
- link_to_home_page — Get a link to the public home page.
- link_to_item — Get a link to an item.
- link_to_item_search — Get HTML for a link to the item search form.
- link_to_items_browse — Get HTML for a link to the browse page for items.
- link_to_items_in_collection — Get a link to the collection items browse page.
- link_to_items_rss — Get a link the the items RSS feed.
- link_to_items_with_item_type — Get a link to item type items browse page.
- link_to_next_item_show — Get a link to the item immediately following the current one.
- link_to_previous_item_show — Get a link to the item immediately before the current one.
- loop — Get an iterator for looping over an array of records.
- max_file_size — Get the maximum file upload size.
- metadata — Get metadata for a record.
- nav — Create a navigation menu of links.
- option — Get the value of a particular site setting for display.
- output_format_list — Get an HTML list of output formats for the current action.
- pagination_links — Get HTML for a pagination control for a browse page.
- physical_path_to — Get the filesystem path for a local asset.
- pluck — Return one column of a multidimensional array as an array.
- plugin_is_active — Determine whether a plugin is installed and active.
- public_nav_items — Get the navigation for items.
- public_nav_main — Get the main navigation for the public site.
- public_url — Get a URL to the public theme.
- queue_css_file — Add a CSS file or files to the current page.
- queue_css_string — Add a CSS string to the current page.
- queue_css_url — Add a CSS file to the current page by URL.
- queue_js_file — Add a local JavaScript file or files to the current page.
- queue_js_string — Add a JavaScript string to the current page.
- queue_js_url — Add a JavaScript file to the current page by URL.
- random_featured_collection — Get HTML for displaying a random featured collection.
- random_featured_items — Get HTML for random featured items.
- recent_items — Get HTML for recent items.
- record_image — Get an image tag for a record.
- record_url — Get a URL to a record.
- release_object — Release an object from memory.
- revert_theme_base_url — Revert the base URL to its previous state.
- search_filters — Get a list of current site-wide search filters in use.
- search_form — Get the site-wide search form.
- set_current_record — Set a record to the view as the current record.
- set_loop_records — Set records to the view for iteration with loop().
- set_option — Set an option to the options table.
- set_theme_base_url — Set the base URL for the specified theme.
- set_theme_option — Set a theme option.
- 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.
- src — Get a URL for a given local file.
- strip_formatting — Strip HTML tags from a string.
- tag_attributes — Generate attributes for an HTML tag.
- tag_cloud — Create a tag cloud made of divs that follow the hTagcloud microformat
- tag_string — Return a tag string given an Item, Exhibit, or a set of tags.
- 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.
- theme_header_background — Get the theme’s header background image style.
- theme_header_image — Get the theme’s header image tag.
- theme_logo — Get the theme’s logo image tag.
- total_records — Get the total number of a given type of record in the database.
- update_collection — Update an existing collection.
- update_item — Update an existing item.
- url — Get a URL given the provided arguments.
- url_to_link — Convert any URLs in a given string to links.
- url_to_link_callback — Callback for converting URLs with url_to_link.
- web_path_to — Get the URL for a local asset.
- xml_escape — Escape a value for use in XML.