1. Home
  2. Docs
  3. Documentation test
  4. Shortcodes
  5. Recipe Index [recipes_browse]

Recipe Index [recipes_browse]

The shortcode used to display recipe cards is:

By Default, this shorcode will show recipes using the settings of Recipes Archive located at : Site Dashboard > Settings > Boo Recipe Settings > Recipe Archive.

There are a number of parameters that you may use to override the settings and show the recipe cards as you want. All parameters are optional. The available arguments are:

ParameterExplanationExpected InputExample
limitMax number of recipes to showinteger6
recipes_per_rowNumber of recipes per rowinteger3
recipe_archive_layoutRecipe Cards Layout Stylegrid | list | modern | overlaygrid
show_in_masonryGrid in masonry viewyes | noyes
heading_for_archive_titlehtml heading tag for titleh1 | h2 | h3 | h4 | h5 | h6h3
color_archive_titleTitle Colorhex color code#444444
color_archive_excerptExcerpt Colorhex color code#333333
color_card_bgCard Background Colorhex color code#f6f6f6
color_archive_keysKey Points Colorhex color code#f2f2f2
show_archive_excerptWant to show recipe excerptyes | noyes
recipe_idsCSV of recipe Ids to showinteger , integer22,26
recipe_ids_excludeCSV of recipe Ids to Excludeinteger , integer22,26
recipe_category_idsLimit recipes to CSV of Recipe Category Idsinteger , integer2,3
recipe_category_slugsLimit recipes to CSV of Recipe Category slugscategory-slug-1 , category-slug-2dinner,lunch
recipe_category_ids_excludeShow recipes excluding CSV of Ids of categoryinteger , integer2,3
recipe_category_slugs_excludeShow recipes excluding CSV of slugs of categorycategory-slug-1 , category-slug-2dinner,lunch
recipe_tags_idsLimit recipes to CSV of Recipe Tags Idsinteger , integer2,3
recipe_tags_slugsLimit recipes to CSV of Recipe Tags slugstags-slug-1 , tags-slug-2onion,halloween,christmas
recipe_tags_ids_excludeShow recipes excluding CSV of Ids of Tagsinteger , integer2,3
recipe_tags_slugs_excludeShow recipes excluding CSV of slugs of Tagstags-slug-1 , tags-slug-2halloween,christmas
skill_level_idsLimit recipes to CSV of Recipe Skill Level Idsinteger , integer5,3
skill_level_slugsLimit recipes to CSV of Recipe Skill Level slugsskill-level-slug-1 , skill-level-slug-2easy,expert
skill_level_ids_excludeShow recipes excluding CSV of Ids of Skill Levelinteger , integer2,3
skill_level_slugs_excludeShow recipes excluding CSV of slugs of Skill Levelskill-level-slug-1 , skill-level-slug-2not-so-difficult

Some of the parameters definition is only available in premium version, list is as below:

ParameterExplanationExpected InputExample
color_archive_hover_overlayOverlay Color for Overlay Layout Stylehex or rgba color codergba(0,0,0,0.5)
card_content_alignmenttext align of card contentsleft | center | rightcenter
color_archive_key_points_bgKey Points Background Colorhex color code#71a866
show_rounded_card_borderCards to have borders?yes | noyes
card_border_radius_pixelsCard border radius in pixelsinteger10
card_border_pixelsCard border width in pixelsinteger2
color_card_borderCard border colorhex color code#f3f3f3
recipe_cuisine_idsLimit recipes to CSV of Recipe Cuisine Idsinteger , integer2,3
recipe_cuisine_slugsLimit recipes to CSV of Recipe Cuisine slugscuisine-slug-1 , cuisine-slug-2american,italian
recipe_cuisine_ids_excludeShow recipes excluding CSV of Ids of Cuisineinteger , integer2,3
recipe_cuisine_slugs_excludeShow recipes excluding CSV of slugs of Cuisinecuisine-slug-1 , cuisine-slug-2american,italian
cooking_method_idsLimit recipes to CSV of Recipe Cooking Method Idsinteger , integer5,6
cooking_method_slugsLimit recipes to CSV of Recipe Cooking Method slugscooking-method-slug-1 , cooking-method-slug-2steaming
cooking_method_ids_excludeShow recipes excluding CSV of Ids of Cooking Methodinteger , integer1,4
cooking_method_slugs_excludeShow recipes excluding CSV of slugs of Cooking Methodcooking-method-slug-1 , cooking-method-slug-2frying

Example 1:

Sorry, no recipes were found for this search criteria

This will show recipes having ids 2168,2177 and 2180 using the layout style “modern” and two recipes per row. It will override the title color to white (#ffffff) and Key points background color to red (#ff0000)

Example 2:

Sorry, no recipes were found for this search criteria

This will show maximum of 6 recipes using layout style defined in the settings. These recipes will have recipe category id 7 but excluding the Skill Level of “Very Expert”.

Note: A guide on how to find recipe id or find id or slug of taxonomy ( category, cuisine, skill level etc.) is described in section on “How to Find Ids” and “How to find Slugs“.