README

Unlike collection and controllers, Kirby only allows for the creation of custom methods via plugins. Methods Folder bridges this gap by automatically registering methods located in site/methods. In additon to all methods types, it also provides a way to register helper functions via a dedicated file.

Introduction

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: 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.

Installation

By default, plugins in Kirby reside in a special folder located at /site/plugins. Each plugin is installed in its proprietary subfolder. This installation can be handled in four different ways: you can either install them manually or manage them using Kirby CLI, Git submodules or Composer. You can install Methods Folder either way and should choose the method suiting your project best.

Please note that all examples given here assume you are using the default plugin root. If you changed your plugin root, e. g. with a custom folder setup, you’ll also have to adjust the paths given in this guide. For further information on how to manage plugins, please read the official Kirby plugin introduction.

Download

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

Kirby CLI

kirby plugin:install hananils/kirby-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

Documentation

Where possible, files contain inline annotations. For extended documentation, please visit our dedicated plugin site at kirby.hananils.de/​plugins/​methods-folder.

Reference

• Site Methods
• Pages Methods
• Page Methods
• Field Methods
• Layouts Methods
• Layout Methods
• Layout Column Methods
• Blocks Methods
• Block Methods
• Files Methods
• File Methods
• Users Methods
• User Methods
• Collection Methods

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.