PHPackages ksfraser/fa-hooks - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ksfraser/fa-hooks ActiveLibrary[Utility & Helpers](/categories/utility) ksfraser/fa-hooks ================= Lightweight hook system for FrontAccounting module extensions 05HTML Since Feb 6Pushed 3mo agoCompare [ Source](https://github.com/ksfraser/FA_Hooks)[ Packagist](https://packagist.org/packages/ksfraser/fa-hooks)[ RSS](/packages/ksfraser-fa-hooks/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) FA\_Hooks ========= [](#fa_hooks) A lightweight, extensible hook system for FrontAccounting module extensions, providing WordPress/SuiteCRM-style hooks for extending core FA functionality without modifying core files. Overview -------- [](#overview) FA-Hooks is designed to be installed as a **separate FA module** that provides a generic hook system for ALL your other FA modules. This enables cross-module integration and extensibility. ### Key Features [](#key-features) - **Priority-based hook execution** - Control the order of hook callbacks - **Exception handling** - Continues execution even if individual hooks fail - **Hook data storage** - Store and retrieve data between hooks - **Multiple callback support** - Register multiple callbacks per hook - **Dynamic hook registration** - Modules can register their own hook points - **Version abstraction** - Automatic handling of FA version differences - **Type-safe containers** - Object-oriented data management - **Cross-module integration** - Extensions can modify other modules' behavior Installation ------------ [](#installation) ### As an FA Module (Recommended for Multi-Module Setups) [](#as-an-fa-module-recommended-for-multi-module-setups) For use with multiple FA modules, install FA-Hooks as a separate module: ``` # Install in FA modules directory cd /path/to/frontaccounting/modules git clone https://github.com/ksfraser/FA_Hooks.git fa-hooks # Install PHP dependencies (automatically done during FA module activation) cd fa-hooks composer install --no-dev --optimize-autoloader # Activate in FA admin (Setup → Install/Update Modules) ``` **What happens during activation:** - FA automatically installs PHP dependencies via `ComposerInstaller` - Hook system is initialized globally as `$GLOBALS['fa_hooks_manager']` - Access control is configured (requires admin access for future admin screens) This makes the hook system available to ALL your FA modules. ### As a Library [](#as-a-library) For single-module use or development: ``` # Clone the repository git clone https://github.com/ksfraser/FA_Hooks.git # Install dependencies composer install ``` Then include in your project: ``` require_once '/path/to/fa-hooks/src/Ksfraser/FA_Hooks/HookManager.php'; $hooks = new Ksfraser\FA_Hooks\HookManager(); ``` Security & Access Control ----------------------------- [](#security--access-control) When installed as an FA module, FA-Hooks includes predefined access control constants: ``` // Security constants (defined in hooks.php) define('SS_FAHOOKS', 100); // Security Section for FA Hooks define('SA_FAHOOKS', 1); // Security Area for FA Hooks ``` **Current Access Requirements:** - Module installation requires admin access (`SA_FAHOOKS`) - Future admin screens will automatically inherit this access control **For Module Developers:**When creating admin interfaces that extend FA-Hooks, use these constants: ``` // Check access in your admin screens if (!check_edit_security(SS_FAHOOKS)) { // Handle access denied } ``` Usage ----- [](#usage) ### Basic Hook Registration [](#basic-hook-registration) ``` use Ksfraser\FA_Hooks\HookManager; // Get the global hook manager instance $hooks = new HookManager(); // Register a callback $hooks->add_hook('my_hook', function($param) { echo "Hook called with: $param"; return $param; }); // Call the hook $result = $hooks->call_hook('my_hook', 'Hello World'); ``` ### Priority-based Execution [](#priority-based-execution) ``` // Higher priority numbers execute later $hooks->add_hook('save_data', 'validate_data', 10); $hooks->add_hook('save_data', 'sanitize_data', 5); // Executes first $hooks->add_hook('save_data', 'log_data', 20); // Executes last ``` ### Filter Hooks (with return values) [](#filter-hooks-with-return-values) ``` $hooks->add_hook('filter_content', function($content) { return strtoupper($content); }); $filtered = $hooks->call_hook('filter_content', 'hello world'); // Result: "HELLO WORLD" ``` ### Action Hooks (no return values) [](#action-hooks-no-return-values) ``` $hooks->add_hook('user_login', function($user_id) { // Log the login error_log("User $user_id logged in"); }); $hooks->call_hook('user_login', 123); // No return value expected ``` FrontAccounting Integration --------------------------- [](#frontaccounting-integration) This library is designed to work with FrontAccounting's module system: ``` // In your module's hooks.php class hooks_my_module extends hooks { function register_hooks() { $hooks = fa_hooks(); // Global FA hook manager $hooks->add_hook('pre_item_write', [$this, 'my_save_handler']); $hooks->add_hook('pre_item_delete', [$this, 'my_delete_handler']); } } ``` API Reference ------------- [](#api-reference) ### HookManager [](#hookmanager) #### `add_hook(string $hook_name, callable $callback, int $priority = 10): void` [](#add_hookstring-hook_name-callable-callback-int-priority--10-void) Register a callback for a hook. #### `remove_hook(string $hook_name, callable $callback): void` [](#remove_hookstring-hook_name-callable-callback-void) Remove a callback from a hook. #### `call_hook(string $hook_name, ...$args): mixed` [](#call_hookstring-hook_name-args-mixed) Execute all callbacks for a hook. Returns the filtered value or null. #### `has_hook(string $hook_name): bool` [](#has_hookstring-hook_name-bool) Check if a hook has registered callbacks. #### `set_hook_data(string $key, $value): void` [](#set_hook_datastring-key-value-void) Store data for hooks to access. #### `get_hook_data(string $key, $default = null): mixed` [](#get_hook_datastring-key-default--null-mixed) Retrieve stored hook data. #### `clear(): void` [](#clear-void) Clear all hooks and data. Development ----------- [](#development) ``` # Install dependencies composer install # Run tests composer test # or ./vendor/bin/phpunit ``` License ------- [](#license) MIT License - see LICENSE file for details. ### Health Score 19 — LowBetter than 10% of packages Maintenance54 Moderate activity, may be stable Popularity4 Limited adoption so far Community6 Small or concentrated contributor base Maturity12 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/c8870cc04b29a973eed9ad367a936ab274d744de37ff0c35fa0540a932905271?d=identicon)[ksfraser](/maintainers/ksfraser) --- Top Contributors [![ksfraser](https://avatars.githubusercontent.com/u/54461925?v=4)](https://github.com/ksfraser "ksfraser (1 commits)") ### Embed Badge ![Health badge](/badges/ksfraser-fa-hooks/health.svg) ``` [![Health](https://phpackages.com/badges/ksfraser-fa-hooks/health.svg)](https://phpackages.com/packages/ksfraser-fa-hooks) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)