Overview

Packages

  • Simmer
    • Admin
      • Bulk
      • Functions
      • Recipes
      • Settings
    • Deprecated
    • Frontend
    • Install
    • Recipes
      • Items
        • Ingredients
        • Instructions
      • Shortcode
    • Upgrade
    • Widgets

Classes

  • Simmer_Recipe_Ingredient
  • Simmer_Recipe_Ingredients

Functions

  • simmer_add_recipe_ingredient
  • simmer_delete_recipe_ingredient
  • simmer_get_ingredients_list_heading
  • simmer_get_ingredients_list_type
  • simmer_get_recipe_ingredient
  • simmer_get_the_ingredients
  • simmer_list_ingredients
  • simmer_update_recipe_ingredient
  • Overview
  • Package
  • Function
  • Tree
  • Deprecated
  • Todo

Function simmer_list_ingredients

Print or return an HTML list of ingredients for the current recipe.

Package: Simmer\Recipes\Items\Ingredients
Since: 1.0.0
Located at core/recipes/items/ingredients/template-functions.php
Parameters summary
array $args = array() <p>{ The custom arguments. Optional.</p> <pre><code>$type bool $show_heading Whether show the list heading. Default "true". $type string $heading The list heading text. Default "Ingredients". $type string $heading_type The heading tag. Default "h3". $type string $list_type The list tag. Default "ul". $type string $list_class The class(es) to apply to the list. Default "simmer-ingredients". $type string $item_type The list item tag. Default "li". $type string $item_class The class(es) to apply to the list items. Default "simmer-ingredient". $type string $none_message The message when there are no ingredients. Default "This recipe has no ingredients". $type string $none_class The class to apply to the "none" message. Default "simmer-info". $type bool $echo Whether to echo or return the generated list. Default "true". </code></pre> <p>}</p>
Return value summary
string $output The HTML list of ingredients.
Simmer API documentation generated by ApiGen