Omeka Classic Logo
  • What’s new in Omeka
  • Tutorials
  • Reference
    • Global (Theming) Functions
    • Hooks
    • Filters
    • models
    • views/helpers
    • controllers
    • Packages
      • Acl
      • Application
      • Auth
      • Captcha
      • Controller
      • Db
      • File\Derivative
      • Filter
      • Form
      • Global Functions
        • Db-related functions
        • Locale-related functions
        • Log-related functions
        • Plugin-related functions
        • Search-related functions
        • Text-related functions
        • User-related functions
        • Utility-related functions
        • View-related functions
      • Http
      • Install
      • Job
      • Navigation
      • Output
      • Plugin
      • Record
      • Session
      • Storage
      • Test
      • Validate
      • View
    • libraries/Omeka
    • Omeka REST API
  • Helping With Documentation
  • Registering a new module or theme with omeka.org
Omeka Classic
  • Reference
  • Global (Theming) Functions
  • Global Functions
  • View-related functions
  • View page source

View-related functions

Up to Global 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
    • css_src — Get the URL to a local css file.
    • 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.
    • img — Get the URL to a local image file.
    • js_tag — Get a tag for including a local JavaScript file.
    • physical_path_to — Get the filesystem path for a local asset.
    • 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.
    • src — Get a URL for a given local file.
    • web_path_to — Get the URL for a local asset.
  • File-related functions
    • 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.
  • Form-related functions
    • element_form — Get the HTML for a form input for a given Element.
    • element_set_form — Return a element set form for a record.
    • get_table_options — Get the options array for a given table.
    • label_table_options — Add a “Select Below” or other label option to a set of select options.
  • Head-related functions
    • 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.
  • Item-related functions
    • files_for_item — Get HTML for all files assigned to an item.
    • get_next_item — Get the next item in the database.
    • get_previous_item — Get the previous item in the database.
    • get_random_featured_items — Get random featured items.
    • get_recent_items — Get the most recently added items.
    • item_image — Get a customized item image tag.
    • item_image_gallery — Get a gallery of file thumbnails for an item.
    • random_featured_items — Get HTML for random featured items.
    • recent_items — Get HTML for recent items.
  • ItemType-related functions
    • item_type_elements — Get the set of values for item type elements.
  • Layout-related functions
    • auto_discovery_link_tags — Get link tags for the RSS and Atom feeds.
    • common — Get HTML from a view file in the common/ directory.
    • foot — Get the view’s footer HTML.
    • head — Get the view’s header HTML.
  • Loop-related functions
    • get_current_record — Get the current record from the view.
    • get_loop_records — Get records from the view for iteration.
    • has_loop_records — Check if records have been set to the view for iteration.
    • loop — Get an iterator for looping over an array of records.
    • 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().
  • Navigation-related functions
    • absolute_url — Get an absolute URL.
    • admin_url — Get a URL to the admin theme.
    • current_url — Get the current URL with query parameters appended.
    • file_display_url — Get the provided file’s URL.
    • is_current_url — Check if the given URL matches the current request URL.
    • items_output_url — Get a URL to an output format page.
    • 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.
    • nav — Create a navigation menu of links.
    • pagination_links — Get HTML for a pagination control for a browse page.
    • 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.
    • record_url — Get a URL to a record.
    • revert_theme_base_url — Revert the base URL to its previous state.
    • set_theme_base_url — Set the base URL for the specified theme.
    • url — Get a URL given the provided arguments.
  • OutputFormat-related functions
    • get_current_action_contexts — Get all output formats available in the current action.
    • output_format_list — Get an HTML list of output formats for the current action.
  • Search-related functions
    • items_search_form — Return the HTML for an item search form.
  • Tag-related functions
    • 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.
Previous Next

© Copyright 2012-2023, Omeka.

Built with Sphinx using a theme provided by Read the Docs.