PHPackages                             nystudio107/recipe - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. nystudio107/recipe

ActiveCraft-plugin

nystudio107/recipe
==================

A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support

1.0.3(9y ago)39154[3 issues](https://github.com/nystudio107/recipe/issues)PHP

Since May 1Pushed 7y ago1 watchersCompare

[ Source](https://github.com/nystudio107/recipe)[ Packagist](https://packagist.org/packages/nystudio107/recipe)[ RSS](/packages/nystudio107-recipe/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (4)Dependencies (1)Versions (6)Used By (0)

[![No Maintenance Intended](https://camo.githubusercontent.com/d904056147052e22d8e1c7f46bb50293ed2aeb4c43ead9a2d0cf7a48b46d0562/687474703a2f2f756e6d61696e7461696e65642e746563682f62616467652e737667)](http://unmaintained.tech/)

DEPRECATED
==========

[](#deprecated)

This Craft CMS 2.x plugin is no longer supported, but it is fully functional, and you may continue to use it as you see fit. The license also allows you to fork it and make changes as needed for legacy support reasons.

The Craft CMS 3.x version of this plugin can be found here: [craft-recipe](https://github.com/nystudio107/craft-recipe) and can also be installed via the Craft Plugin Store in the Craft CP.

Recipe plugin for Craft CMS
===========================

[](#recipe-plugin-for-craft-cms)

A recipe FieldType for Craft CMS that includes microdata support

Related: [Recipe for Craft 3.x](https://github.com/nystudio107/craft3-recipe)

[![Screenshot](resources/screenshots/recipe01.png)](resources/screenshots/recipe01.png)

Installation
------------

[](#installation)

To install Recipe, follow these steps:

1. Download & unzip the file and place the `recipe` directory into your `craft/plugins` directory
2. -OR- do a `git clone https://github.com/nystudio107/recipe.git` directly into your `craft/plugins` folder. You can then update it with `git pull`
3. -OR- install with Composer via `composer require nystudio107/recipe`
4. Install plugin in the Craft Control Panel under Settings > Plugins
5. The plugin folder should be named `recipe` for Craft to see it. GitHub recently started appending `-master` (the branch name) to the name of the folder for zip file downloads.

Recipe works on Craft 2.4.x, Craft 2.5.x, and Craft 2.6.x.

Recipe Overview
---------------

[](#recipe-overview)

Recipe adds a 'Recipe' FieldType for Craft CMS that you can add to any of your Sections.

In encapsulates everything you need for a recipe, including the ingredients, a photo of the recipe, directions, cooking time, ratings, and even nutritional information. It handles converting between Imperial and Metric units, outputs 'pretty' fractions for Imperial units, and can output correct ingredient portions for any number of servings.

Recipe also generates the [JSON-LD microdata](https://developers.google.com/structured-data/) for your recipes if you have the [SEOmatic plugin](https://github.com/nystudio107/seomatic) installed, which allows it to be displayed in the [Google knowledge panel](https://developers.google.com/structured-data/rich-snippets/recipes) for search results.

We hope Recipe makes it easier for you to create and share some yummy recipes!

Configuring Recipe
------------------

[](#configuring-recipe)

Create a Recipe field via **Settings->Fields** and you can set the Asset Sources that are used for the recipe images

Using Recipe
------------

[](#using-recipe)

Once you have created the Recipe field, add it to your Section Entry Types, and fill in what recipe information is appropriate. Nothing other than the name is required, so feel free to leave anything blank that you're not using.

Using Recipe in your Templates
------------------------------

[](#using-recipe-in-your-templates)

To display information about a recipe in your templates, you just use familiar Twig code. Let's assume the field handle for your Recipe field is `someRecipe`; this is what you'd use to output information about it:

### Basic Info

[](#basic-info)

- `{{ entry.someRecipe.name }}` - the name of the recipe
- `{{ entry.someRecipe.description }}` - the description of the recipe
- `{{ entry.someRecipe.skill }}` - the skill level required to make this recipe
- `{{ entry.someRecipe.serves }}` - how many people the recipe serves
- `{{ entry.someRecipe.getImageUrl() }}` - a URL to the image for the recipe
- `{{ entry.someRecipe.prepTime }}` - the prep time for the recipe in minutes
- `{{ entry.someRecipe.cookTime }}` - the cooking time for the recipe in minutes
- `{{ entry.someRecipe.totalTime }}` - the total time for the recipe in minutes

### Ingredients

[](#ingredients)

For a list of ingredients, do the following (adding whatever output markup you want):

```
{% set ingredients = entry.someRecipe.getIngredients('imperial', 1) %}
{% for ingredient in ingredients %}
    {{ ingredient }}
{% endfor %}

```

The first parameter is the units you'd like to use (`'imperial'` or `'metric'`). The second parameter is how many people you'd like the recipe portions to be sized for. By default, it will use `'imperial'` and the serving size in the recipe if you don't pass these parameters in, e.g.: `entry.someRecipe.getIngredients()`

### Directions

[](#directions)

For a list of directions, do the following (adding whatever output markup you want):

```
{% set directions = entry.someRecipe.getDirections() %}
{% for direction in directions %}
    {{ direction }}
{% endfor %}

```

### Ratings

[](#ratings)

For a list of the ratings, do the following (adding whatever output markup you want):

```
{% set ratings = entry.someRecipe.ratings %}
{% for rating in ratings %}
    {{ rating.rating }} {{ rating.review }} {{ rating.author }}
{% endfor %}

```

For the aggregate (average) rating for this recipe, do the following (adding whatever output markup you want):

```
{{ entry.someRecipe.getAggregateRating() }}

```

### Nutritional Information

[](#nutritional-information)

To output the nutritional information for the recipe, do the following:

- `{{ entry.someRecipe.servingSize }}` - The serving size, in terms of the number of volume or mass
- `{{ entry.someRecipe.calories }}` - The number of calories per serving
- `{{ entry.someRecipe.carbohydrateContent }}` - The number of grams of carbohydrates per serving
- `{{ entry.someRecipe.cholesterolContent }}` - The number of milligrams of cholesterol per serving
- `{{ entry.someRecipe.fatContent }}` - The number of grams of fat per serving
- `{{ entry.someRecipe.fiberContent }}` - The number of grams of fiber per serving
- `{{ entry.someRecipe.proteinContent }}` - The number of grams of protein per serving
- `{{ entry.someRecipe.saturatedFatContent }}` - The number of grams of saturated fat per serving
- `{{ entry.someRecipe.sodiumContent }}` - The number of milligrams of sodium per serving
- `{{ entry.someRecipe.sugarContent }}` - The number of grams of sugar per serving
- `{{ entry.someRecipe.transFatContent }}` - The number of grams of trans fat per serving
- `{{ entry.someRecipe.unsaturatedFatContent }}` - The number of grams of unsaturated fat per serving

### Image Asset ID

[](#image-asset-id)

If you need to do any further manipulation of the Recipe Image (perhaps a transform) you can get the Asset ID for it:

- `{{ entry.someRecipe.imageId }}` - the Asset ID of the image for the recipe

Rendering Recipe JSON-LD Microdata
----------------------------------

[](#rendering-recipe-json-ld-microdata)

If you have the [SEOmatic plugin](https://github.com/nystudio107/seomatic) installed, Recipe can render JSON-LD microdata for you, which allows it to be displayed in the [Google knowledge panel](https://developers.google.com/structured-data/rich-snippets/recipes) for search results:

```
{{ entry.someRecipe.renderRecipeJSONLD() }}

```

[![Screenshot](resources/screenshots/recipe02.png)](resources/screenshots/recipe02.png)

Recipe Roadmap
--------------

[](#recipe-roadmap)

Some things to do, and ideas for potential features:

- Provide a front-end way to add ratings

Recipe Changelog
----------------

[](#recipe-changelog)

### 1.0.3 -- 2017.01.05

[](#103----20170105)

- \[Added\] Added support for 1/3, 2/3, and 1/6 fractions
- \[Improved\] Updated the README.md

### 1.0.2 -- 2016.09.18

[](#102----20160918)

- \[Fixed\] Handle empty ingredients lists without erroring
- \[Fixed\] Handle empty directions without erroring
- \[Improved\] Updated the README.md

### 1.0.1 -- 2016.05.01

[](#101----20160501)

- \[Fixed\] Fixed a minor issue with Recipe if it was embedded in a Matrix field
- \[Added\] Added the 'Skill Level' field
- \[Improved\] Updated the README.md

### 1.0.0 -- 2016.05.01

[](#100----20160501)

- Initial release

Brought to you by [nystudio107](http://nystudio107.com)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~83 days

Total

4

Last Release

3416d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7570798?v=4)[Andrew Welch](/maintainers/khalwat)[@khalwat](https://github.com/khalwat)

---

Top Contributors

[![khalwat](https://avatars.githubusercontent.com/u/7570798?v=4)](https://github.com/khalwat "khalwat (8 commits)")

---

Tags

craft-plugincraftcmsrecipe

### Embed Badge

![Health badge](/badges/nystudio107-recipe/health.svg)

```
[![Health](https://phpackages.com/badges/nystudio107-recipe/health.svg)](https://phpackages.com/packages/nystudio107-recipe)
```

###  Alternatives

[elgg/elgg

Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications.

1.7k15.7k5](/packages/elgg-elgg)[pressbooks/pressbooks

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS.

44643.1k1](/packages/pressbooks-pressbooks)[johnbillion/user-switching

Instant switching between user accounts in WordPress and WooCommerce.

19768.3k2](/packages/johnbillion-user-switching)[rainlab/blog-plugin

Blog plugin for October CMS

17257.7k](/packages/rainlab-blog-plugin)[rainlab/user-plugin

User plugin for October CMS

11954.3k13](/packages/rainlab-user-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)