Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add information about extending blueprints the right way #1097

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add information about extending blueprints the right way #1097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions pages/04.plugins/03.plugin-tutorial/docs.md
View file
Open in desktop
Expand Up @@ -375,6 +375,26 @@ class RandomizerPlugin extends Plugin

If you followed along, you should have a fully functional **Randomizer** plugin enabled for your site. Just point your browser to the `http://yoursite.com/random`, and you should see a random page. You can also download the original **Random** plugin directly from the [Plugins Download](https://getgrav.org/downloads/plugins) section of the [getgrav.org](https://getgrav.org/downloads/plugins) site.

## Extending blueprints

If your plugin needs to extend blueprints, e.g. default.yaml from /system/blueprints/pages/default.yaml there's no need to register your blueprint via hooks if you respect the folder structure placing your extending blueprint inside of [your-plugin-directory]/blueprints/pages/default.yaml. Grav will merge your extended blueprint definitions while themes can do the same lateron.

> system inheritance if you create this folder structure inside your plugin
> > - blueprints
> > - - pages
> > - - - default.yaml

> admin inheritance if you create this folder structure inside your plugin
> > - blueprints
> > - - admin
>> - - - pages
> > - - - - raw.yaml
>
> From admin you have to inherit raw or others and theme blueprints extending default won't make it into your configuration.

If it's not pages, do it the same way for other inheritances...
This way you can keep extending changes at a minimum, that's what extending is all about :-).

## Merging Plugin and Page Configuration

One popular technique that is used in a variety of plugins is the concept of merging the plugin configuration (either default or overridden user config) with page-level configuration. This means you can set **site-wide** configuration, and then have a specific configuration for a given page as needed. This provides a lot of power and flexibility for your plugin.
Expand Down