Hooks Reference

This is the complete catalogue of extension points MultiSaas fires. Plugins and themes both extend the platform through this single contract. For the API itself and worked examples, see Plugin Development and Theme Development.

How the system works

All extensibility is on the WordPress-like hook bus:

add_action('tag', $cb, $priority) / do_action('tag', ...$args) / render_action('tag', ...$args)
add_filter('tag', $cb, $priority) / apply_filters('tag', $value, ...$args)
menu_insert_before / menu_insert_after / menu_insert_before_many / menu_insert

hook() (HookService) stores tag ⇒ priority ⇒ [callable]. Unknown tags are no-ops (do_action returns void, render_action returns '', apply_filters returns $value). Register callbacks from a service provider's boot(); the registry is per-request.

Naming: snake_case with a scope prefix. Generic frontend_* / admin_* tags fire on both landlord and tenant; scoped landlord_* / tenant_* tags fire only in that context.

Frontend hooks

add_action('tenant_frontend_head', function () {
    echo '<link rel="stylesheet" href="'.asset('plugin-assets/yourplugin.css').'">';
}, 10);

Admin panel hooks

Sidebar menu item shape

landlord_admin_menu_items uses the same shape as tenant_admin_menu_items (MenuWithPermission items). Use the menu helpers with anchor keys equal to item ids (dashboard-menu, general-settings-menu-items, appearance-settings-menu-items, languages, external menu ids):

add_filter('tenant_admin_menu_items', function (array $items) {
    return menu_insert_before_many($items, 'appearance-settings-menu-items', [
        'seo-manager-menu' => [
            'route'       => 'tenant.admin.seo-manager.settings',
            'label'       => __('SEO Manager'),
            'parent'      => null,
            'permissions' => ['seo-manager'],
            'icon'        => 'mdi mdi-search-web',
            'class'       => 'plugin-menu',
        ],
    ]);
}, 10);

User dashboard menu hooks

The landlord user dashboard sidebar (landlord/frontend/user/dashboard/user-master.blade.php, web guard — fires only for authenticated users) and the tenant user dashboard mirror each other.

landlord_user_dashboard_menu_items (filter, preferred)

Core items in render order, with their anchor keys:

add_filter('landlord_user_dashboard_menu_items', function (array $items) {
    if (! auth()->user() || count(auth()->user()->tenant_details ?? []) < 1) {
        return $items;               // condition decides visibility
    }
    return menu_insert_after($items, 'custom_domain', 'my_domains', [
        'label'  => __('My Domains'),
        'url'    => route('landlord.user.dashboard.domains.index'),
        'icon'   => 'la-globe',
        'active' => request()->routeIs('landlord.user.dashboard.domains.*'),
    ]);
}, 10);

When an anchor is optional (may be absent for some users), use menu_insert with fallbacks so the item stays pinned above a safe anchor:

return menu_insert($items, 'tolt_affiliate', [
    'label' => __('Affiliate Earnings'), 'url' => route('landlord.user.dashboard.tolt.index'),
    'icon' => 'la-handshake', 'active' => request()->routeIs('landlord.user.dashboard.tolt.*'),
], ['after' => 'payment_logs', 'before' => 'logout']);

Item shape: label, url, icon (a las la-* / la-* icon name), optional active (bool), optional children (array of ['label','url','active'] for submenus).

Other dashboard hooks

Landlord tenant-list hooks

landlord/admin/tenant/index.blade.php is fully hookable end-to-end:

Pricing, plan and order hooks

Extension points on the landlord frontend purchase funnel (/pricing is the PageBuilder price-plan addon; details is view-plan; checkout is order-page):

add_filter('landlord_pricing_plan_buttons', function ($html, $plan) {
    return $plan->price == 0 ? $html.'<span class="badge">Free forever</span>' : $html;
}, 10, 2);

Fallback template filters

Fallback frontend templates (used when the active theme does not ship a view) expose filters so plugins can replace or decorate whole sections without touching core views. When the filter returns empty, the fallback renders its own default.

Payment gateway hooks

Critical tags (money movement): landlord_payment_gateways, tenant_payment_gateways, tenant_gateway_payment_complete, landlord_gateway_payment_complete. Plugins must never remove the filter or the IPN dispatch — payments silently stop.

Public helpers: gateway_registry(), gateway_currency(), gateway_success_url($scope,$id), gateway_cancel_url($scope), gateway_ipn_url($slug), gateway_mark_payment_complete($scope,$id,$txn), gateway_charge_context($params).

Response conventions:

Theme-local hooks

Every theme ships these placeholders (empty string when no plugin listens). hook:audit verifies them.

These are generic — a plugin listening on theme_before_navbar fires for every theme. For theme-scoped hooks use ThemeHookService::themeTag($slug, 'before_navbar').

Hooks fired by shipped plugins

These are stable extension points you can consume today.

DomainReseller

ToltAffiliate

ToltAffiliate consumes several hooks and fires none of its own yet; it registers on landlord_admin_menu_items, landlord_user_dashboard_menu_items, landlord_gateway_payment_complete (to report completed orders to Tolt), landlord_frontend_head and landlord_frontend_footer (the tolt.js pixel and lead binding).

Firing your own hooks

• Prefix with your slug: yourplugin_after_enrollment.
• Fire filters wherever a value could plausibly be overridden: $title = apply_filters('yourplugin_widget_title', $title, $widget);.
• For template sections, use render_action in your Blade.
• Document every hook you add (tag, type, payload, firing location) in the same format as this page.

do_action('yourplugin_after_enrollment', $enrollment, $user);

add_action('yourplugin_after_enrollment', function ($enrollment, $user) {
    // react
}, 10);

Verifying and debugging

# Full audit: emitters × listeners × per-theme hooks
php artisan hook:audit
php artisan hook:audit --verbose          # prints the file:line table
php artisan hook:audit --theme=agency     # one theme
php artisan hook:audit --theme=my-theme   # third-party theme in themes/my-theme/

# Raw grep used to generate the audit
grep -rn "do_action\|render_action\|apply_filters" core --include="*.php" --include="*.blade.php" | sort
grep -rn "add_action\|add_filter" core plugins --include="*.php" | grep -v "function add_" | sort

App\Services\Hook\MandatoryHooks::all() is the machine-readable source of truth consumed by hook:audit. If you add a new render_action or apply_filters in core, add its tag to MandatoryHooks and to this page in the same commit.