Largo custom functions - jacki890/Largo GitHub Wiki

Sorted alphabetically. If a function is prefixed with "largo," the prefix is ignored.

Looking for something? Ctrl-F or ⌘-F

A

  • largo_acm_default_url( $url ): Sets a default ad network URL for the Ad Code Manager plugin. Currently a placeholder. Found in inc/ad-codes.php.
  • largo_acm_output_html( $output_html, $tag_id ): Outputs placeholder ads using http://placehold.it/. Found in inc/ad-codes.php.
  • largo_acm_output_tokens( $output_tokens, $tag_id, $code_to_display ): Demo function to assign values to output tokens for the Ad Code Manager plugin. Found in inc/ad-codes.php.
  • largo_acm_whiltelisted_script_urls( $whitelisted_urls ): Whitelists additional ad network URLs for the Ad Code Manager plugin. Found in inc/ad-codes.php
  • _largo_action_wp_update_nav_menu(): Tracks when nav menus were last edited, to make cache purging for largo_cached_nav_menu easier. Found in inc/cached-core-functions.php.
  • largo_ad_tags_ids( $ad_tag_ids ): Adds ad tags for the Ad Code Manager plugin. Found in inc/ad-codes.php.
  • largo_add_dont_miss_label( $items, $args ): Prepends static label to the beginning of the "Don't Miss" header area, as set in Appearance > Theme Options > Basic Settings. Found in /inc/nav-menus.php.
  • largo_add_footer_menu_label( $items, $args ): Prepends static lable to the beginning of the footer menu area, as set in Appearance > Theme Options > Basic Settings. Found in /inc/nav-menus.php.
  • largo_add_link_to_widget_title( $title, $instance = null ): Makes it possible for widget titles to be links. Found in /inc/widgets.php.
  • largo_add_mce_plugin( $plugin_array ): Adds /js/tinymce/plugins/largo/editor_plugin.js to the plugin array. Found in inc/editor.php
  • largo_add_mce_buttons(): If the user has enabled rich editing, then this filters mce_external_plugins with largo_add_mce_plugin and filters mce_buttons with largo_register_mce_buttons. Found in /inc/editor.php.
  • largo_add_meta_box( $id, $title, $callbacks = array(), $post_types = 'post', $context = 'advanced', $priority = 'default' ): Defines a metabox container. Found in /inc/metabox-api.php.
  • largo_add_meta_content( $callback, $box_id ): Adds a field to a metabox container. Found in /inc/metabox-api.php.
  • largo_add_term_meta( $taxonomy, $term_id, $meta_key, $meta_value, $unique=false ): Adds metadata to a term's meta post. Found in /inc/term-meta.php.
  • largo_add_widget_classes( $params ): Adds custom CSS classes to sidebar widgets. Found in /inc/widgets.php.
    • iterative classes (widget-1, widget-2, etc.) reset for each sidebar
    • odd/even classes
    • default/rev/no-bg classes
    • Bootstrap's responsive classes
  • largo_admin_footer_text( $default_text ): A filter that replaces the admin page footer text with "This website powered by Project Largo from the Investigative News Network and WordPress." Found in /inc/dashboard.php.
  • largo_admin_menu(): Removes the Link Manager menu item that was deprecated in WordPress 3.5. Found in /inc/dashboard.php.
  • largo_admin_users_caps( $caps, $cap, $user_id, $args ): In a multisite network, allow site admins to edit user profiles. H/t http://thereforei.am/2011/03/15/how-to-allow-administrators-to-edit-users-in-a-wordpress-network/. Found in /ince/users.php.
  • largo_attachment_image_link_remove_filter( $content ): Filters 'the_content' and removes links to attachments. Found in /inc/images.php.
  • largo_author( $echo = true ): Get the author name when custom byline optinos are set. $echo is a boolean that determines whether the string is echoed or returned. Found in /inc/post-tags.php.
  • largo_author_link( $echo = true, $post = null ): Gets the author link when custom byline options are set. $echo controls whether the string is echoed or returned. Found in /inc/post-tags.php.

B

  • largo_byline( $echo = true, $exclude_date = false ): Outputs custom byline and link if set, otherwise outputs author link and post date. $echo controls whether the string is echoed or returned. Found in /inc/post-tags.php.
  • largo_byline_meta_box_display(): Contents for the byline metabox. Found in /inc/post-meta.php.

C

  • largo_cached_nav_menu( $args = array(), $prime_cache = false ): Wrapper function around wp_nav_menu() that will cache the wp_nav_menu for all tag/category pages used in the nav menus. Found in inc/cached-core-functions.php.
  • largo_categories_and_tags( $max = 5, $echo = true, $link = true, $use_icon = false, $separator = ', ', $item_wrapper = 'span', $exclude = array(), $rss = false ): Returns or echoes a list of categories and tags. Found in /inc/related-content.php.
    • $max: int number of categories and tags to return
    • $echo: bool echo the output or return it (default: echo)
    • $link: bool return the tags and category links or just the terms themselves
    • $use_icon: bool include the tag icon or not (used on single.php)
    • $separator: string to use as a separator between list items
    • $item_wrapper: string html tag to use as a wrapper for elements in the output
    • $exclude: array of term ids to exclude
  • largo_category_archive_posts( $query ): Helper for getting posts in a category archive, sorted with featured posts first. Found in /inc/taxonomies.php.
  • largo_change_default_hidden_metaboxes( $hidden, $screen ): Shows all metaboxes in the edit interface by default. Found in /inc/post-meta.php.
  • largo_check_deprecated_widgets(): Checks for deprecated widgets and posts an alert, as part of /inc/update.php.
  • largo_clear_home_icon_cache( $option ): Clears the homepage icon cache when options are updated. Found in /inc/images.php.
  • largo_comment( $comment, $args, $depth ): Template for comments and pingbacks, used as a callback by wp_list_comments() for displaying the comments. Found in /inc/post-tags.php.
  • largo_contactmethods( $contactmethods ): Modifies the user profile screen, removes AIM, Yahoo IM and Jabber, adds Twitter, Facebook and LinkedIn, adds format hint for Google+. Found in /inc/users.php.
  • largo_content_nav( $nav_id, $in_same_cat = false ): Displays navigation to next/previous pages when applicable. Found in /inc/post-tags.php.
  • largo_copyright_message(): Copyright message for the footer. Found in /inc/header-footer.php.
  • largo_custom_disclaimer_meta_box_display(): Content for the Disclaimer metabox. Found in /inc/post-meta.php.
  • largo_custom_less_variables_init(): Sets which LESS files will be compiled into CSS files. Found in inc/custom-less-variables.php.
    • Default settings:
      • files: 'carousel.less', 'editor-style.less', 'style.less', 'top-stories.less'
      • directories: get_template_directory() . '/less/', get_template_directory_uri() . '/css/'
      • LESS variables: 'variables.less'
    • API functions begin with largo_clv:
      • largo_clv_register_files( $files ): Register the Less files to compile into CSS files
      • largo_clv_register_directory_paths( $less_dir, $css_dir_uri ): Set the file path for the directory with the LESS files and URI for the directory with the outputted CSS.
      • largo_clv_register_variables_less_file( $variables_less_file ): Sets the variable.less file
  • largo_custom_login_logo(): Adds the Largo logo to the login page. Found in inc/cached-core-functions.php.
  • largo_custom_related_meta_box_display(): Content for the Additional Options metabox. Found in /inc/post-meta.php.
  • largo_custom_sidebars_dropdown( $selected = '', $skip_default = false, $post_id = NULL ): Builds a dropdown menu of custom sidebars. Used in the meta box on post/page edit screens and landing page edit screen.
  • largo_custom_taxonomies(): Registers the prominence and series custom taxonomies and inserts the default terms. Found in /inc/taxonomies.php.
  • largo_custom_taxonomy_terms( $post_id ): Outputs custom taxonomy terms attached to a post. Found in /inc/taxonomies.php.
  • largo_custom_wp_link_pages( $args ): Adds pagination to ingle posts. Based on http://bavotasan.com/2012/a-better-wp_link_pages-for-wordpress/, accepts as $args the same array of arguments as wp_link_pages.

D

  • largo_dashboard_widgets_member(): Cleans up dashboard for INN members, if INN_MEMBER is set to TRUE in functions.php. Found in /inc/dashboard.php.
    • Removes the following Dashboard widgets:
      • dashboard_plugins
      • dashboard_secondary
      • dashboard_primary
      • dashboard_incoming_links
      • dashboard_recent_comments
      • dashboard_recent_drafts
      • dashboard_quick_press
    • Adds the following Dashboard widgets:
      • largo_dashboard_network_news
      • largo_dashboard_member_news
      • largo_dashboard_quick_links
  • largo_dashboard_widgets_nonmember(): Cleans up Dashboard for nonmembers if INN_MEMBER is set to FALSE in functions.php. Found in /inc/dashboard.php.
    • Removes the following Dashboard widgets:
      • dashboard_plugins
      • dashboard_secondary
      • dashboard_primary
      • dashboard_incoming_links
      • dashboard_recent_comments
    • Adds the following Dashboard widgets:
      • largo_dashboard_network_news
      • largo_dashboard_member_news
      • largo_dashboard_quick_links
  • largo_dashboard_network_news(): Widget that displays one item from http://feeds.feedburner.com/INNArticles. Found in /inc/dashboard.php.
  • largo_dashboard_member_news(): Widget that displays three items from http://feeds.feedburner.com/INNMemberInvestigations Found in /inc/dashboard.php.
  • largo_dashboard_quick_links(): Links to Largo Project documentation at http://largoproject.org. Found in /inc/dashboard.php.
  • largo_delete_term_meta( $taxonomy, $term_id, $meta_key, $meta_value='' ): Deletes metadata from a term's meta post'. Found in /inc/term-meta.php.
  • largo_deprecated_footer_widget(): Notice that the Largo Footer Featured Posts widget is deprecated, as part of /inc/update.php.
  • largo_deprecated_sidebar_widget(): Notice that the Largo Sidebar Featured Posts widget is deprecated, as part of /inc/update.php.
  • largo_donate_button(): Output a donate button, based on theme options. Found in /inc/nav-menus.php.

E

  • largo_edit_permission_check(): Checks that both the editing user and the user being edited are members of the blog and prevents the super-admin from being edited. Found in /inc/users.php.
  • largo_enqueue_admin_scripts(): Enqueues JavaScript and CSS for the admin dashboard. For more information on enqueueing, see wp_enqueue_style and wp_enqueue_script. Found in /inc/enqueue.php.
  • largo_enqueue_home_assets(): Enqueues scripts and styles for the home page. For more information on enqueueing, see wp_enqueue_style and wp_enqueue_script. Found in /inc/home-templates.php.
  • largo_enqueue_js(): Enqueues JavaScript and CSS assets. For more information on enqueueing, see wp_enqueue_style and wp_enqueue_script. Found in /inc/enqueue.php.
  • largo_entry_content( $post ): Replaces the_content() with paginated content if <!--nextpage--> is used in the post.
  • largo_excerpt( $the_post=null, $sentence_count = 5, $use_more = true, $more_link = '', $echo = true, $strip_tags = true, $strip_shortcodes = true ): Makes a nicer-looking post exceprt, regardless of how excerpts were used in the past. Found in /inc/post-tags.php.

F

  • largo_featured_video_meta_box_display(): Content for the Featured Video metabox. Found in /inc/post-meta.php.
  • largo_filter_get_post_related_topics( $topics, $max ): Found in /inc/related-content.php.
  • largo_filter_guest_author_fields( $fields_to_return, $groups ): Similar to largo_contactmethods, but for guest authors in the Co-Authors Plus plugin. Found in /inc/users.php.
  • largo_footer_js(): Social media scripts, loaded in the footer. Found in /inc/enqueue.php.
    • Google Plus
    • Twitter
    • Facebook
  • largo_full_text_feed(): Creates a full-text RSS feed at hxxp://example.org/?feed=fulltext (even if the site is using excerpts in the main feed). Found in /inc/custom-feeds.php.

G

  • largo_get_featured_posts( $args = array() ): Gets featured posts, from a customizable taxonomy. Found in /inc/featured-content.php.

    • Defaults:

       'showposts' => 3,
 'offset' 	=> 0,
 'orderby' 	=> 'date',
 'order' 	=> 'DESC',
 'tax_query' => array(
 	array(
 		'taxonomy' 	=> 'prominence',
 		'field' 	=> 'slug',
 		'terms' 	=> 'footer-featured'
 	)
 ),
 'ignore_sticky_posts' => 1,

  • largo_get_home_templates(): Scans theme and parent theme for homepage templates. Returns an array of templates, with friendly names as keys and arrays with 'path' and 'thumb' as values. Found in /inc/home-templates.php.

  • largo_get_home_thumb( $theme, $file ): Returns the URL of the thumbnail image for a homepage template, or a default /homepages/no-thumb.png. Found in /inc/home-templates.php.

  • largo_get_post_related_topics( $max = 5 ): Provides topics (categories and tags) related to the post currently being considered. Found in /inc/related-content.php.

  • largo_get_recent_posts_for_term( $term, $max = 5, $min = 1 ): Provides recent posts for a term object (category, tag, etc). If number of items is fewer than $min, returns false. Excludes the current post if we're inside The Loop. Found in /inc/related-content.php.

  • largo_filter_get_recent_posts_for_term_query_args( $query_args, $term, $max, $min, $post ):

  • largo_get_related_topics_for_category( $obj ): Shows related tags and subcategories for each main category. Used on category.php to display a list of related terms. Found in /inc/related-content.php.

  • largo_get_series_posts( $series_id, $number = -1 ): Helper function for getting posts in proper landing-page order for a series. Found in /inc/taxonomies.php.

  • get_post_template( $template ): Filters the single template value, replaces it with the template chosen by the user, if they choose one. Found in /inc/post-templates.php.

  • get_post_templates(): Scans template files of active theme, returns an array of [Template Name => {file}.php]. Found in /inc/post-templates.php.

  • largo_get_term_meta( $taxonomy, $term_id, $meta_key, $single=false ): Gets metafata for a term from the term meta post. Found in /inc/term-meta.php.

  • largo_get_term_meta_post( $taxonomy, $term_id ): Gets the proxy post for a given term. Found in /inc/term-meta.php.

  • largo_get_the_main_feature(): Provides "main" feature associated with a post, if there is a feature. Found in /inc/featured-content.php.

  • largo_google_analytics(): Add Google Analytics code to the footer. You must add your GA ID to the theme settings for this to work, in Appearance > Theme Options > Basic Settings. Found in /inc/enqueue.php.

H

  • largo_has_categories_or_tags(): Returns true if a post has tagor, or has a category other than 'Uncategorized'.
  • largo_has_gravatar( $email ): Determines whether or not an author has a valid Gravatar image, where $email is the author's email address. Found in /inc/post-tags.php.
  • largo_have_featured_posts(): Determines if there are any featured posts. Found in /inc/featured-content.php.
  • largo_have_homepage_featured_posts(): Determines if there are any featured posts on the homepage. Found in /inc/featured-content.php.
  • largo_header(): outputs the header. Found in /inc/header-footer.php.
  • largo_header_js(): outputs JavaScript that determines which size of the header banner image to load, based on window width. Found in /inc/enqueue.php.
  • largo_home_hero_side_series(): Gets the various posts for the homepage hero-side-series template. Found in /inc/home-template-functions.php.
  • largo_home_icon( $class='', $size = 'home-logo' ): If there is a square icon logo, it returns the image. If there is not, it returns <i class="icon-home ' . esc_attr( $class ) . '"></i>. Found in /inc/images.php.
  • largo_home_single_top(): Gets the post to display at the top of the home single template. Found in /inc/home-template-functions.php.
  • largo_home_template_path(): Returns the full path to the HPH file of the current homepage template. Found in /inc/home-templates.php.
  • largo_home_transition(): Converts old theme option homepage_top to new home_template as part of /inc/update.php.

I

  • largo_instantiate_widget( $kind, $instance_settings, $region ): Insets a widget programmatically. This is slightly dangerous, as it makes some assumptions about existing plugins. If $instance_settings are wrong, bad things might happen. Used in /inc/update.php.
  • is_post_template( $template = '' ): By default, determines if the post is a a single post template. Optionally determines if the post is a $template template. Found in /inc/post-templates.php.

L

  • largo_layout_meta_box_display(): Contents for the Layout Options metabox. Found in /inc/post-meta.php
  • largo_load_custom_template_functions(): Loads /inc/home-template-functions.php. Found in /inc/home-templates.php.
  • largo_load_of_script_for_widget(): Loads scripts for options framework on the widgets. Found in /inc/sidebars.php.

M

  • largo_mailchimp_rss(): Creates a custom RSS feed for MailChimp's RSS feed import, including thumbnail images. References /feed-mailchimp.rss. Use the *|RSSITEM:IMAGE|* merge tag in your MailChimp template. Found in /inc/cached-core-functions.php.
  • largo_make_slug( $string, $maxLength = 63 ): Helper function to transform user-entered text into WordPress-compatible slugs. Found in /inc/sidebars.php.
  • _largo_meta_box_save( $post_id ): Private function to handle saving inputs registered with largo_register_meta_input(). Found in /inc/metabox-api.php.
  • _largo_metaboxes_content( $post, $callbacks = array() ): Private function to generate fields and mark up within Largo metaboxes. Found in /inc/metabox-api.php.
  • _largo_metaboxes_generate(): Private function to actually generate the metaboxes, via add_action. Found in /inc/metabox-api.php.
  • largo_module_shortcode( $atts, $content, $code ): Adds the shortcode module, used for pullquotes and asides within posts. Included for backwards compatibility; no longer used. Found in /inc/editor.php.
  • largo_move_author_to_publish_metabox(): Moved author dropdown to the "Publish" metabox so it's easier to find. Found in /inc/post-meta.php.

N

  • largo_need_updates(): Checks if new widgets need to be placed by checking old theme settings. In 0.4, many 0.3 theme settings were spun off into widgets. This only works for Largo versions => 0.3.0. Found in /inc/update.php.

O

  • largo_opengraph(): Adds appropriate Open Graph, Twitter Cards, and Google Publisher tags to the header based on the page type displayed. Found in /inc/open-graph.php.

P

  • largo_perform_update(): Performs various database updates upon Largo version change. Found in /inc/update.php.
  • largo_post_in_series( $post_id = NULL ): Determins whether a post is in a series. Found in /inc/taxonomies.php.
  • largo_post_social_links( $echo = true ): Outputs Facebook, Twitter, email, share and print utility links on article pages. $echo controls whether the string is echoed or returned. Found in /inc/post-tags.php.
  • post_type_icon( $options = array() ): Returns the post-type icon for a post.
  • post_templates_dropdown(): Builds a dropdown of all post templates. Found in /inc/post-templates.php.

R

  • largo_register_mce_buttons( $buttons ): Registers TinyMCE buttons. Found in /inc/editor.php.
  • largo_register_meta_input( $input_names, $presave_fn ): Call this function from within a largo_add_meta_field callback to register an input as a post meta field. Found in /inc/metabox-api.php.
  • largo_register_home_sidebars(): Registers the sidebars specified in the chosen homepage template, and sets the value for $largo['home_rail']. Found in /inc/home-templates.php.
  • largo_register_required_plugins(): Registers plugins required by Largo, nags logged-in users about it in the Dashboard. Found in /ing/largo-plugin-init.php.
  • largo_register_sidebars(): Registers sidebars and widget areas. Found in /inc/sidebars.php.
  • largo_register_term_meta_poost_type(): Registers the proxy post type that bridges between a term_id and a post_meta field. Found in /inc/term-meta.php.
  • largo_register_widget_custom_fields( $instance, $widget ): Registers widget custom fields. Found in /inc/widgets.php.
  • largo_remove_default_post_screen_metaboxes(): Hides the tackbacks, slug, revisions, author and comments metaboxes to clean up the post and page edit screens.
  • largo_robots(): Defaults for robots.txt. See http://codex.wordpress.org/Search_Engine_Optimization_for_WordPress#Robots.txt_Optimization. Found in /inc/robots.php.

S

  • largo_scrub_sticky_posts( $after, $before ): If a post is marked as sticky, this unsticks any other sticky posts on the blog, so that we only have one sticky post at a time. Found in /inc/featured-content.php.
  • largo_seo(): SEO tags for the <head>, including noindex and additional Google News tags. Found in /inc/header-footer.php.
  • largo_shortcut_icons(): Outputs favicon and Apple Touch icons for <head>. Found in /inc/header-footer.php.
  • largo_social_links(): Outputs a <li> for each social media link in the theme options. Found in /inc/header-footer.php.
  • _subcategories_for_category( $cat_id ): Returns an array of the subcategories of $cat_id. Found in /inc/related-content.php.

T

  • _tags_associated_with_category( $cat_id, $max = 5): Gets a list of tags used in posts in this category, sorts by popularity, returns an array of the top $max tags. Found in /inc/related-content.php.

  • largo_term_to_label( $term ): Output format for the series custom taxonomy at the bottom of single posts. Found in /inc/taxonomies.php.

  • largo_time( $echo = true ): For posts published less than 24 hours ago, show "time ago" instead of date, otherwise just use get_the_date. $echo controls whether the time is echoed or returned. Found in /inc/post-tags.php.

  • largo_tinymce_config( $init ): Removes weird span tags inserted by TinyMCE. Found in /inc/editor.php.

  • largo_top_tag_display(): Additional content for the Additional Options metabox. Found in /inc/post-meta.php.

  • largo_top_term( $options = array() ): Returns (or echoes) the 'top term' for a post, falling back to a category if a top term was not specified in the editor. Found in /inc/related-content.php.

    • Defaults:

       $defaults = array(
 	'post' => get_the_ID(),
 	'echo' => TRUE,
 	'link' => TRUE,
 	'use_icon' => FALSE,
 	'wrapper' => 'span',
 	'exclude' => array(),	//only for compatibility with largo_categories_and_tags
 );

  • largo_top_terms_js(): Loads JavaScript for the top-terms selector in largo_top_tag_display(). Found in /inc/post-meta.php.

  • largo_trim_sentences( $input, $sentences, $echo = false ): Attempts to trum input at sentence breaks, while escaping titles and other things that normally use periods. Found in /inc/post-tags.php.

  • largo_twitter_url_to_username ( $url ): Takes a Twitter URL, finds the username without the @. Found in /inc/open-graph.php.

U

  • largo_update_term_meta( $taxonomy, $term_id, $meta_key, $meta_value, $prev_value='' ): Updates metadata on a term's meta post. Found in /inc/term-meta.php.
  • largo_update_widgets(): Puts new widgets into sidebars as appropriate based on old theme options, as part of /inc/update.php.

V

  • largo_version(): Returns the current version of Largo. Found in /inc/update.php.

W

  • largo_widget_counter_reset( $text ): Resets the largo_add_widget_classes counter for each sidebar. Found in /inc/widgets.php.
  • largo_widget_custom_fields_form( $widget, $args, $instance ): Adds Largo-specific custom fields to widget forms. Found in /inc/widgets.php.
  • largo_widget_in_region( $widget_name, $region = 'article-bottom' ): Checks to see if a given widget is in a given region already, as part of /inc/update.php.
  • largo_widget_settings(): Render widget setting fields on the widget page for Largo Sidebar Options. Found in /inc/sidebars.php.
  • largo_widget_update_extend( $instance, $new_instance ): Adds additional fields to widget update callback. Found in /inc/widgets.php.
  • largo_widgets(): Sets up Largo custom widgets, unregisters a number of default WordPress widgets. Largo widgets can be found in /inc/widgets/. This function found in /inc/widgets.php.

Questions or comments? file an issue, or contact INN directly

⚠️ **GitHub.com Fallback** ⚠️