agence-adeliom / lumberjack-hooks
1.0.41
2022-09-13 08:44 UTC
Requires
- php: >=8.0.2
- doctrine/annotations: ^1.6
- rareloop/lumberjack-core: ^5.0
This package is auto-updated.
Last update: 2023-01-18 18:06:17 UTC
README
Register WordPress hooks, filters and shortcodes with PHP Attributes
Requirements
- PHP 8.0 or greater
- Composer
- Lumberjack
Installation
composer require agence-adeliom/lumberjack-hooks
# Copy the configuration file
cp vendor/agence-adeliom/lumberjack-hooks/config/hooks.php web/app/themes/YOUR_THEME/config/hooks.php
Register the service provider into web/app/themes/YOUR_THEME/config/app.php
'providers' => [ ... \Adeliom\Lumberjack\Hooks\HookProvider::class ]
Usage
Create your hook class :
<?php namespace App\Hooks; use Adeliom\Lumberjack\Hooks\Models\Action; use Adeliom\Lumberjack\Hooks\Models\Filter; class MyClass { #[Action(tag: "init")] public function doSomethingAtInit() { // do something } #[Filter(tag: "enter_title_here")] public function alterEnterTitleHere() { // do something } }
Register the class into your config file web/app/themes/YOUR_THEME/config/hooks.php
:
return [ 'register' => [ ... App\Hooks\MyClass::class ], ];
And you're done!
API
#[Action(tag: "the hook name", priority: 1, accepted_args: 1)] #[Filter(tag: "the filter name", priority: 1, accepted_args: 1)] #[Shortcode(tag: "the shortcode code", priority: 1, accepted_args: 1)]
License
Lumberjack Hooks is released under the MIT License.