krypton/hooks

A hook system for PHP

0.0.1-alpha 2023-06-02 15:25 UTC

Requires

• php: >=8.0.0

GPL-3.0

• Taranjeet Singh Chhabra

• filters
• hooks
• actions
• hook-system
• filters-system

README

The PHP Hooks Class is a fork of the WordPress filters hook system rolled in to a class to be ported into any php based system

• This class is heavily based on the WordPress plugin API and most (if not all) of the code comes from there.

How to install?

composer require krypton/hooks

How to use?

We start with a simple example ...

<?php

use Krypton\Hooks\Hooks;

function print_user_save()
{
    echo "User is Saved";
}

function print_user_added()
{
    echo "User is Added to the System";
}

$hooks = Hooks::getInstance();

$hooks->getAction()->add($hooks->getFilter(), 'user_save', 'print_user_save');

$hooks->getAction()->add($hooks->getFilter(), 'user_save', 'print_user_added');

$hooks->getFilter()->add('uppercase', 'strtoupper');

then all that is left for you is to call the hooked function when you want anywhere in your application, EX:

<?php

$hooks = Hooks::getInstance();

echo '<div id="extra_header">';

echo $hooks->getFilter()->apply('uppercase', 'taranjeet');

$hooks->getAction()->do($hooks->getFilter(), 'user_save');

echo '</div>';

License

Since this class is derived from the WordPress Plugin API so are the license and they are GPL http://www.gnu.org/licenses/gpl.html