README

Methods Folder is a plugin for Kirby to automatically register local methods provided in the folder site/methods just like Kirby accepts local collections, controllers or models without the need of writing a dedicated plugin.

Note

Please check out the online documentation at kirby.hananils.de/plugins/methods-folder for further information.

Installation

Download

Download and copy this repository to /site/plugins/methods-folder.

Git submodule

git submodule add https://github.com/hananils/kirby-methods-folder.git site/plugins/methods-folder

Composer

composer require hananils/kirby-methods-folder

Creating custom methods

After installing this plugin, you can create custom methods in site/methods by creating separate files for the different method types:

site
└ methods
  └ collection.php
  └ field.php
  └ block.php
  └ blocks.php
  └ layout.php
  └ layouts.php
  └ layout-column.php
  └ file.php
  └ files.php
  └ page.php
  └ pages.php
  └ site.php
  └ user.php
  └ users.php

Those files have to return an array:

<?php

return [
    'my-method' => function () {
        // your method code here
    }
];

Please see the official docs for more information about the different method types: https://getkirby.com/docs/reference/plugins/extensions

Creating custom helpers

You can also create a helpers.php file inside the site folder where you can put custom methods you'd like to have available universally:

site
 └ helpers.php

This file will automatically be included and may contain as many global helper functions as needed.

License

This plugin is provided freely under the MIT license by hana+nils · Büro für Gestaltung.
We create visual designs for digital and analog media.