API → Filter Reference
Keep in mind that all tags below should be prepended with atom_ if used with add_action / add_filter. You should use the Atom::add() method instead of these functions, for future compatibility.
Also note that filters are not required to perform simple configuration changes (like changing the default arguments for e certain function). There are dedicated methods which are meant to do this easier and faster (check out the “set()” methods from the Atom Class reference).
Core actions
- setup_options
- Runs after the options are set up for the first time (On first theme install, or option reset)
- sync_options
- After desynced options are synchronized.Arguments:
- $old_version (Version from which we just updated)
- $default_options (Default theme options)
- $current_options (Current theme options)
- uninstall
- Runs when the Atom settings are removed from the database. This happens when the user changes to another theme and the “Auto-uninstall”" option is checked in the advanced settings page.
- init
- After all the Atom hooks have been registered
- core
- After Atom is succesfully initialized. Similar to WP’s after_setup_theme
- js
- Before javascript files are enqueued
- css
- Before stylesheets are enqueued
- before_TEMPLATE
after_TEMPLATE - Before / after a specific Atom template is displayed, like teaser, related-posts etc.
- requests
- GET/POST requests (including asynchronous requests) should be hooked here. Same as WP’s template_redirect
Core filters
- inline_css
- Inline CSS to include in the document head (The User CSS field).Arguments:
- $css CSS code (string)
- logo
- Logo HTML output of the getLogo()method.Arguments:
- $output (string)
- $title Site title (string)
- widget_area
- HTML output for an widget area (or sidebar).Arguments:
- $output (string)
- $area Area ID (string)
- share_fields
- Fields to make available inside URLs, in getShareLinks()Arguments:
- $fields (array)
- share_urls
- URL patterns for getShareLinks()Arguments:
- $urls (array)
- widget_NAME_keywords
- Template keywords for widgets that support templatesArguments:
- $keywords Default keywords (array)
- $object Object that’s being looped (like post, comment, blog etc)
- $args Widget arguments (array)
- widget_tabs_classes
- Tab classes for a arbitrary widget that’s being grouped into tabs. Arguments:
- $classes Default classes (array)
- $options Widget instance options from which the classes were generated (array)
- $count Widget instance number (int)
- widget_tabs_title
- Title for an arbitrary widget that’s being grouped into tabs (usually not visible because most themes will use icons).Arguments:
- $title Default title (string)
- $tab Tab properties (array)
- $options Widget instance options (array)
Theme-specific actions
These actions are located inside template files, and vary from theme to theme because they depend on the design type.
- before_page
- Just after the <body> tag. Should be available inside all themes
- top
- At the top of the page (usually the first element in #page). Should be available inside all themes
- before_main
- After the header, but before the main content + sidebars
- after_main
- After the main content + sidebars, and before the footer
- before_primary
- Inside the main content column, before the heading
- after_primary
- Inside the main content column, after all the content
Last revision 12 years