|
|
@@ -7,7 +7,8 @@ toc:
|
|
|
nav: 3
|
|
|
---
|
|
|
|
|
|
-# Plugins
|
|
|
+## Plugins
|
|
|
+
|
|
|
At the heart of customizing Pico is a plugin. You can 'hook-in' to the Pico
|
|
|
engine at many different times during the rendering of your site and its content.
|
|
|
You will find a full example template in [plugins/DummyPlugin.php]({{ site.base_url }}/phpDoc/master/classes/DummyPlugin.html) to get you
|
|
|
@@ -18,65 +19,54 @@ Officially tested plugins can be found at [http://picocms.org/plugins]({{ site.b
|
|
|
but there are many awesome third-party plugins out there! A good start point
|
|
|
for discovery is our [Wiki](#plugin-wiki).
|
|
|
|
|
|
----
|
|
|
+### Migrating from 0.X to 1.0
|
|
|
|
|
|
-# Migrating from 0.X to 1.0
|
|
|
The new event system supports plugin dependencies as well as some new events.
|
|
|
You will be able to set an enabled/disabled state by default as well. If you
|
|
|
have previously cerated a plugin for Pico, it is *HIGHLY* recommended that you
|
|
|
update your class to extend from [AbstractPicoPlugin]({{ site.base_url }}/phpDoc/master/classes/AbstractPicoPlugin.html) and use the new events
|
|
|
to avoid activating the [PicoDeprecated](https://github.com/picocms/Pico/blob/master/plugins/00-PicoDeprecated.php) plugin.
|
|
|
|
|
|
- |---------------------|-----------------------------------------------------------|
|
|
|
- | Event | ... triggers the deprecated event |
|
|
|
- |---------------------|-----------------------------------------------------------|
|
|
|
- | onPluginsLoaded | plugins_loaded() |
|
|
|
- | onConfigLoaded | config_loaded($config) |
|
|
|
- | onRequestUrl | request_url($url) |
|
|
|
- | onContentLoading | before_load_content($file) |
|
|
|
- | onContentLoaded | after_load_content($file, $rawContent) |
|
|
|
- | on404ContentLoading | before_404_load_content($file) |
|
|
|
- | on404ContentLoaded | after_404_load_content($file, $rawContent) |
|
|
|
- | onMetaHeaders | before_read_file_meta($headers) |
|
|
|
- | onMetaParsed | file_meta($meta) |
|
|
|
- | onContentParsing | before_parse_content($rawContent) |
|
|
|
- | onContentParsed | after_parse_content($content) |
|
|
|
- | onContentParsed | content_parsed($content) |
|
|
|
- | onSinglePageLoaded | get_page_data($pages, $meta) |
|
|
|
- | onPagesLoaded | get_pages($pages, $currentPage, $previousPage, $nextPage) |
|
|
|
- | onTwigRegistration | before_twig_register() |
|
|
|
- | onPageRendering | before_render($twigVariables, $twig, $templateName) |
|
|
|
- | onPageRendered | after_render($output) |
|
|
|
- |---------------------|-----------------------------------------------------------|
|
|
|
-
|
|
|
----
|
|
|
-
|
|
|
-# Your First Plugin
|
|
|
-
|
|
|
-## 1. To get started, navigate to your `plugins` directory
|
|
|
++---------------------+-----------------------------------------------------------+
|
|
|
+| Event | ... triggers the deprecated event |
|
|
|
++---------------------+-----------------------------------------------------------+
|
|
|
+| onPluginsLoaded | plugins_loaded() |
|
|
|
+| onConfigLoaded | config_loaded($config) |
|
|
|
+| onRequestUrl | request_url($url) |
|
|
|
+| onContentLoading | before_load_content($file) |
|
|
|
+| onContentLoaded | after_load_content($file, $rawContent) |
|
|
|
+| on404ContentLoading | before_404_load_content($file) |
|
|
|
+| on404ContentLoaded | after_404_load_content($file, $rawContent) |
|
|
|
+| onMetaHeaders | before_read_file_meta($headers) |
|
|
|
+| onMetaParsed | file_meta($meta) |
|
|
|
+| onContentParsing | before_parse_content($rawContent) |
|
|
|
+| onContentParsed | after_parse_content($content) |
|
|
|
+| onContentParsed | content_parsed($content) |
|
|
|
+| onSinglePageLoaded | get_page_data($pages, $meta) |
|
|
|
+| onPagesLoaded | get_pages($pages, $currentPage, $previousPage, $nextPage) |
|
|
|
+| onTwigRegistration | before_twig_register() |
|
|
|
+| onPageRendering | before_render($twigVariables, $twig, $templateName) |
|
|
|
+| onPageRendered | after_render($output) |
|
|
|
++---------------------+-----------------------------------------------------------+
|
|
|
+
|
|
|
+### Your First Plugin
|
|
|
+
|
|
|
+#### 1. To get started, navigate to your `plugins` directory
|
|
|
|
|
|
|
|
|
----
|
|
|
-
|
|
|
-## 2. Create a new folder and name it your desired name using CammelCase
|
|
|
+#### 2. Create a new folder and name it your desired name using CammelCase
|
|
|
|
|
|
|
|
|
> *Note:* It's not necessary to create the folder, if you do not have assets to
|
|
|
> include, you can simply skip this step and continue to Step 3
|
|
|
|
|
|
----
|
|
|
-
|
|
|
-## 3. Next, you should copy `DummyPlugin.php` inside your newly created folder and give it the same name as you did the folder
|
|
|
+#### 3. Next, you should copy `DummyPlugin.php` inside your newly created folder and give it the same name as you did the folder
|
|
|
|
|
|
|
|
|
----
|
|
|
-
|
|
|
-## 4. You will need to name the `class` the same as the `folder` and the `.php` file
|
|
|
+#### 4. You will need to name the `class` the same as the `folder` and the `.php` file
|
|
|
|
|
|
|
|
|
----
|
|
|
-
|
|
|
-## 5. From here, you will be able to hook-in to Pico's processing
|
|
|
+#### 5. From here, you will be able to hook-in to Pico's processing
|
|
|
Choose an event that makes sense for your situation. Do you need to load configuration values?
|
|
|
[onConfigLoaded]({{ site.base_url }}/phpDoc/master/classes/DummyPlugin.html#method_onConfigLoaded). You need to modify the content of the page before it is
|
|
|
rendered by markdown? [onPageRendering]({{ site.base_url }}/phpDoc/master/classes/DummyPlugin.html#method_onPageRendering). Etc... Plugin developers shouldn't
|
|
|
@@ -84,5 +74,3 @@ manipulate data in "wrong" events, this could lead to unexpected behavior.
|
|
|
|
|
|
> *Note:* Don't forget to set your plugins enabled/disabled state, either by default or
|
|
|
> through your sites `config/config.php` file.
|
|
|
-
|
|
|
----
|
Daniel Rudolf