Skip to content

Latest commit

 

History

History
193 lines (109 loc) · 6.7 KB

README.md

File metadata and controls

193 lines (109 loc) · 6.7 KB
Raw

EM Beer Manager

by Erin Morelli

Manage and display your beers with WordPress. Integrates simply with Untappd and Untappd for Business. Great for everyone from home brewers to professional breweries!

Overview

This plugin allows beer creators from home brewers to professional breweries to easily manage and display their beers. Includes a comprehensive beer management section with a variety of options, including:

  • A custom beer "style" taxonomy for classifying your beers pre-populated with styles from Untappd
  • A customizable "group" taxonomy for categorizing and grouping your beers
  • "Menu" taxonomy for creating beer menus
  • Shortcodes and template tags for displaying all or a select number of beers
  • Custom meta boxes to store detailed information about each beer, including ABV, IBU, and ingredients
  • Beer check-in and rating integration with Untappd
  • A "Beer List" widget for simply displaying your beers in sidebars
  • A "Recent Check-Ins" widget for displaying recent beer check-ins for your brewery on Untappd
  • Custom page display for beers and styles
  • [Beta] Import your brewery's beers directly from Untappd
  • [Beta] Import your beers and menus from Untappd for Business

Screenshots

  1. The beer post type list page
  2. Extra beer post metaboxes
  3. Pre-populated styles taxonomy
  4. Plugin settings page
  5. Single beer page display
  6. Beer list widget options & display
  7. Untappd check-in widget options & display

Latest Release

Version 3.1.0 - Feature Release

  • [NEW] Connect to and import beers/menus from your Untappd for Business account
  • [NEW] Sync your imported beers with changes from Untappd
  • [NEW] Beer images now link to their respective beer
  • [FIXED] Bug with how beer styles were displaying in titles

Installation

  1. Unzip the em-beer-manager.zip file to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. See below to learn more about usage.

Usage

Use these shortcodes to display beers in your posts or use the template tags in your theme files.

Single Beer Display

These will display a single beer entry given it's ID number (found in "Beers" admin).

  • Shortcode:

    [beer id={beer id}]

  • Template tag:

    <?php echo EMBM_Output_Shortcodes_Beer_display( $beer_id, $args ); ?>

    Where $beer_id is required and $args is a PHP array of comma-separated key => value pairs. For example:

      <?php echo EMBM_Output_Shortcodes_Beer_display( 123, array(
      'show_profile'   => false,
      'show_extras'    => true,
      'show_rating'    => false,
      'show_checkins'  => true,
      'checkins_count' => 10
  ) ); ?>

  • Options:

    For use with both the shortcode and template code.

    • show_profile => "true, false" (Default = true)

      Displays or hides the "Beer Profile" information section

    • show_extras => "true, false" (Default = true)

      Displays or hides the "More Beer Information" section

    • show_rating => "true, false" (Default = true)

      Displays or hides the Untappd beer rating

    • show_checkins => "true, false" (Default = true)

      Displays or hides the Untappd check-ins section

    • checkins_count => "number" (Default = 5, limit is 15)

      The number of recent Untappd check-ins to display

List All Beers

These will display a formatted listing of all beers.

  • Shortcode:

    [beer-list]

  • Template tag:

    <?php echo EMBM_Output_Shortcodes_List_display( $args ); ?>

    Where $args is a PHP array of comma-separated key => value pairs. For example:

      <?php echo EMBM_Output_Shortcodes_List_display( array(
      'show_extras'    => false,
      'show_rating'    => true,
      'beers_per_page' => 3,
      'orderby'        => 'name',
      'order'          => 'ASC'
  ) ); ?>

  • Options:

    For use with both the shortcode and template code.

    • show_profile => "true, false" (Default = true)

      Displays or hides the "Beer Profile" information section

    • show_extras => "true, false" (Default = true)

      Displays or hides the "More Beer Information" section

    • show_rating => "true, false" (Default = true)

      Displays or hides the Untappd beer rating

    • style => "style name" (String e.g. "India Pale Ale")

      Displays only beers belonging to a specific beer style

    • group => "group name" (String e.g. "Seasonal Beers")

      Displays only beers belonging to a specific group

    • exclude => "beer ids" (Comma-separated list of beer IDs e.g. "4,23,24")

      Hides listed beers from output

    • beers_per_page => "number" (Default = -1, shows all beers on one page)

      Paginates output and displays the given number of beers per page

    • offset => "number" (Default = 0, starts at the first beer)

      Offsets the output of beers by given number

    • paginate => "true, false" (Default = true)

      Disables/enables pagination

    • orderby => "string" (Default = date, see this list for options)

      Orders output by given paramater

    • order => "DSC, ASC" (Default = DSC)

      Sorts beer list by orderby value in ascending or descending order

Translations

I would love to be able to expand this section - let me know if you are able to contribute!

  • English
  • Icelandic (is_IS) - thanks to rodonmanes
  • Norwegian Bokmål (nb_NO) - thanks to Lars Kvisle
  • Brazilian Portuguese (pt_BR) - thanks to Lucas Alexandre