Contracts to implement hooks for PoP. The concept of a “hook” is the same as in WordPress: an “action” allows executing extra functionality, and a “filter” allows to modify a value.
Via Composer
composer require getpop/hooksThe source code is hosted on the PoP monorepo, under Engine/packages/hooks.
Initialize the component:
\PoP\Root\App::stockAndInitializeComponentClasses([([
\PoP\Hooks\Component::class,
]);Use it:
use PoP\Hooks\Facades\HooksAPIFacade;
// Get an instance of the service
$hooksapi = HooksAPI::getInstance();
// Add a hook for an Action
$hooksapi->addAction($actionName, $functionName, $priority, $argNum);
// Add a hook for a Filter
$hooksapi->addFilter($filterName, $functionName, $priority, $argNum);
// Execute an Action
$hooksapi->doAction($actionName, $param1, $param2, ...);
// Execute a Filter
$filterValue = $hooksapi->applyFilters($filterName, $filterValue, $param1, $param2, ...);
// Remove an Action
$hooksapi->removeAction($actionName, $functionName, $priority, $argNum);
// Remove a Filter
$hooksapi->removeFilter($filterName, $functionName, $priority, $argNum);PoP uses hooks (as pioneered by WordPress) everywhere, through both functions doAction and applyFilters as defined through interface HooksAPI, allowing any piece of code to be overridable by any 3rd party, or be injected extra functionality. For WordPress, the implementation of the interface is trivial. Other systems can rely on packages to implement this functionality (eg: this one or this one).
Requirements:
- PHP 8.0+ for development
- PHP 7.1+ for production
Check the list of Supported PHP features in leoloso/PoP
Via Rector (dry-run mode):
composer preview-code-downgradeTo check the coding standards via PHP CodeSniffer, run:
composer check-styleTo automatically fix issues, run:
composer fix-stylePlease see CHANGELOG for more information on what has changed recently.
To execute PHPUnit, run:
composer testTo execute PHPStan, run:
composer analyseTo report a bug or request a new feature please do it on the PoP monorepo issue tracker.
We welcome contributions for this package on the PoP monorepo (where the source code for this package is hosted).
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
If you discover any security related issues, please email leo@getpop.org instead of using the issue tracker.
GNU General Public License v2 (or later). Please see License File for more information.