5 Plugin Breaking Changes

Grav is still in Beta after all...

2 minutes

Today along with Grav 0.9.13 being released, we have made several updates to five of our plugins that could cause your site to break. If you use Breadcrumbs, GitHub, Pagination, SnipCart or TaxonomyList plugins on your Grav site, you need to read this!

Reasoning

The reason for this update is purely for consistency, and we need to do it sooner rather than later or the issue will just compound.

When we originally developed our plugins, we put any Twig templates into a templates/ folder within the plugin. However, Twig snippets, or non-page-level Twig files, should be put in a templates/partials/ folder. Some of our plugins were doing this correctly, but older ones were not. This plugin change is minor, however, any themes that reference these plugins will need to be updated to reference the correct template location.

We have already updated Antimatter, Afterburner 2, and Bootstrap themes to have these new fixed template references, so if you are running a vanilla version of these themes, you can just update. If you are running a modified or custom theme, you will need to update your theme manually.

GPM Update

To update the standard Grav plugins and themes, you just use GPM:

$ bin/gpm update

Follow the prompts to update everything.

Manual Update

Manual updates are pretty easy also. First follow the previous step, and update any plugins and themes via GPM.

Then, if you have any references in your theme's .twig.html template files similar to:

{% include 'breadcrumbs.html.twig' %}
{% include 'github.html.twig' %}
{% include 'pagination.html.twig' %}
{% include 'taxonomylist.html.twig' %}

You just need to update them to:

{% include 'partials/breadcrumbs.html.twig' %}
{% include 'partials/github.html.twig' %}
{% include 'partials/pagination.html.twig' %}
{% include 'partials/taxonomylist.html.twig' %}

From this point on, we will rigorously follow this methodology and hopefully this kind of issue will not come up again.