挂钩和过滤器参考：完整的开发人员指南

挂钩和过滤器参考

受众： 开发人员 — 需要 PHP / Laravel 知识。 类别： 技术参考 — 集成开发人员的技术文档。

你将学到什么

• 了解PolyCMS中的Action vs Filter机制

• 查找钩子名称、参数和调度位置

• 注册主题 functions.php 和模块 ServiceProvider 的钩子

• 使用优先级来控制执行顺序

• 为每个钩子组应用实际用例

1. Hook系统简介

PolyCMS 使用类似 WordPress 的 Hook/Filter 系统，在 Laravel 上原生构建：

• Action (Hook::doAction)：执行副作用（记录、发送电子邮件、同步数据）。不需要返回值。

• Filter (Hook::applyFilters)：接收一个值，修改它，并且必须返回修改后的值。

基本语法

use App\Facades\Hook;

// Register an Action
Hook::addAction('order_completed', function ($order) {
    Mail::to($order->user)->send(new OrderCompletedMail($order));
}, priority: 10);

// Register a Filter
Hook::addFilter('post.default_image', function (?string $imageUrl, $post) {
    if ($post?->categories->contains('slug', 'news')) {
        return '/images/news-default.jpg';
    }
    return $imageUrl;
}, priority: 10);

2. 内容和帖子

过滤器

行动

实际用例

UC1 - 特定于类别的默认缩略图： 当帖子没有特色图像时，为每个类别保留特定的默认缩略图：

Hook::addFilter('post.default_image', function (?string $url, $post) {
    if ($post?->categories->contains('slug', 'tech')) return '/images/defaults/tech.jpg';
    if ($post?->categories->contains('slug', 'lifestyle')) return '/images/defaults/lifestyle.jpg';
    return $url; // fallback to admin setting
});

UC2 — Wiki URL 结构： 将帖子 URL 结构从 /posts/slug 降级/更改为 /docs/slug 以实现 wiki 风格的布局：

Hook::addFilter('post.frontend_url', function ($url, $post) {
    return ($post->type === 'wiki') ? '/docs/' . $post->slug : $url;
});

UC3 — 自动插入内嵌广告： 在帖子的第三段后自动插入广告横幅块：

Hook::addFilter('content.render.html', function (string $html) {
    $adBanner = '<div class="ad-inline">Advertisement</div>';
    $parts = explode('</p>', $html, 4);
    if (count($parts) > 3) {
        $parts[2] .= '</p>' . $adBanner;
        return implode('</p>', $parts);
    }
    return $html;
});

3.媒体库

过滤器

行动

实际用例

UC1 — CDN URL 重写： 与 Cloudflare R2 或 Amazon S3 集成，自动将本地存储路径转换为 ​​CDN URL：

Hook::addFilter('media.url', function (string $url, $media) {
    return str_replace('/storage/', 'https://cdn.mysite.com/', $url);
});

UC2 — 保护关键系统资产： 防止意外删除当前用作站点徽标的任何图像：

Hook::addFilter('media.delete.should', function (bool $allow, $media) {
    $logoUrl = get_option('site_logo', null, 'general');
    return ($media->url === $logoUrl) ? false : $allow;
});

UC3 — 上传时自动优化图像： 调度后台队列以从标准上传生成轻量级 WebP 图像：

Hook::addAction('media.uploaded', function ($media, $file) {
    if (str_starts_with($media->mime_type, 'image/')) {
        dispatch(new ConvertToWebpJob($media));
    }
});

4. 电子商务 — 订单和退款

行动

过滤器

实际用例

UC1 — 新订单的电报通知：

Hook::addAction('order_status_updated', function ($order, $old, $new) {
    if ($old === 'pending' && $new === 'processing') {
        TelegramBot::send(" Order #{$order->code} has been confirmed!");
    }
});

UC2 — 订单完成时的忠诚奖励积分：

Hook::addAction('order_completed', function ($order) {
    if ($order->user_id) {
        $points = (int) floor($order->total / 10); // 1 point per $10 spent
        LoyaltyService::addPoints($order->user_id, $points, "Order #{$order->code}");
    }
});

UC3 — 退款失败的审核日志：

Hook::addAction('order.refund.failed', function ($order, $data, $exception, $userId) {
    AuditLog::create([
        'action' => 'refund_failed',
        'order_id' => $order->id,
        'user_id' => $userId,
        'reason' => $exception->getMessage(),
    ]);
});

5. 电子商务 — 购物车、运输、税收、库存

过滤器

行动

实际用例

UC1 — 订单超过 100 美元免运费：

Hook::addFilter('shipping.calculate_cost', function ($cost, $method, $cart) {
    $subtotal = collect($cart->items)->sum(fn($i) => $i->price * $i->quantity);
    return ($subtotal >= 100) ? 0 : $cost;
});

UC2 — 如果用户未购买产品则阻止评论：

Hook::addFilter('review.can_submit', function (bool $allowed, $user, $product) {
    $hasPurchased = Order::where('user_id', $user->id)
        ->where('status', 'completed')
        ->whereHas('items', fn($q) => $q->where('product_id', $product->id))
        ->exists();
    return $hasPurchased;
});

UC3 — AddToCart 事件的 Facebook 像素跟踪：

Hook::addAction('cart.item.added', function ($item, $cart) {
    session()->push('fb_pixel_events', [
        'event' => 'AddToCart',
        'product_id' => $item->product_id,
        'value' => $item->price,
    ]);
});

6. 电子商务——支付网关

过滤器

实际用例：向银行转账网关添加自定义字段：

Hook::addFilter('payment.gateway.config_schema', function ($schema, $gateway) {
    if ($gateway->code === 'bank_transfer') {
        $schema['branch_code'] = [
            'type' => 'text', 'label' => 'Branch Code', 'required' => false,
        ];
    }
    return $schema;
});

7. 主题和外观

过滤器

行动

实际用例

UC1 — 从模块注入促销横幅：

Hook::addFilter('frontend.topbar.banners', function (array $banners) {
    $banners[] = [
        'text' => ' Flash Sale — 30% Off Today!',
        'url' => '/sale',
        'bg_color' => '#ff4444',
    ];
    return $banners;
});

UC2 — Google Analytics 头部注入：

Hook::addAction('cms_head', function () {
    $ga = get_option('google_analytics_id', null, 'seo');
    if ($ga) {
        echo "<script async src='https://www.googletagmanager.com/gtag/js?id={$ga}'></script>";
    }
});

UC3 — 加载热门帖子侧边栏变量：

Hook::addFilter('theme.view.data', function ($data, $viewName) {
    if ($viewName === 'posts.index') {
        $data['popular_posts'] = Post::orderBy('views', 'desc')->limit(5)->get();
    }
    return $data;
});

8. 设置和配置

过滤器

行动

实际用例

UC1 — 通过模块注册自定义设置部分：

Hook::addFilter('settings.defaults', function ($defaults) {
    $defaults['mymodule'] = [
        'mymodule_api_key' => [
            'key' => 'mymodule_api_key', 'value' => '', 'type' => 'text',
            'label' => 'API Key', 'description' => 'Enter your API key',
        ],
    ];
    return $defaults;
});

UC2 — 清除永久链接上的路由缓存更新：

Hook::addAction('settings.saved', function ($payload) {
    if (($payload['group'] ?? '') === 'permalinks') {
        Artisan::call('route:clear');
        Cache::tags('routes')->flush();
    }
});

9. 用户、角色和身份验证

过滤器

行动

实际用例

UC1 — 多重身份验证拦截器：

Hook::addFilter('auth.login.pre_token', function ($response, $user, $request) {
    if ($user->hasRole('admin') && !$request->filled('otp_code')) {
        return response()->json(['requires_2fa' => true, 'user_id' => $user->id], 403);
    }
    return $response; // null = continue token generation
});

UC2 — 用户注册欢迎电子邮件：

Hook::addAction('user.creating', function ($data) {
    dispatch(new SendWelcomeEmail($data['email'], $data['name']));
});

10. 搜索引擎优化

过滤器

实际用例 — 多语言设置的规范 URL：

Hook::addFilter('seo.canonical_url', function (string $url) {
    $locale = app()->getLocale();
    if ($locale !== 'en') {
        return url("/{$locale}" . parse_url($url, PHP_URL_PATH));
    }
    return $url;
});

11. 小部件

过滤器

行动

实际用例 — 注册“商店地图”小部件类型：

Hook::addAction('widgets.register_types', function ($manager) {
    $manager->registerType('store_map', [
        'label' => 'Store Map',
        'description' => 'Google Maps showing store locations',
        'fields' => [
            'api_key' => ['type' => 'text', 'label' => 'Google Maps API Key'],
            'lat' => ['type' => 'text', 'label' => 'Latitude'],
            'lng' => ['type' => 'text', 'label' => 'Longitude'],
        ],
        'view' => 'widgets.store-map',
    ]);
});

12. 管理导航和编辑器

过滤器

行动

实际用例 - 将自定义 SEO 状态菜单项添加到顶栏：

Hook::addFilter('topbar.menu.items', function (array $items, $request, $user) {
    $items[] = [
        'key' => 'seo_score',
        'label' => 'SEO Score',
        'icon' => 'chart-bar',
        'url' => '/admin/seo/score',
        'position' => 50,
    ];
    return $items;
});

13. 模块

过滤器

行动

实际用例 - 在模块激活时自动运行迁移：

Hook::addAction('module.activating', function ($moduleKey, $module) {
    Artisan::call('migrate', [
        '--path' => "modules/Polyx/{$moduleKey}/database/migrations",
        '--force' => true,
    ]);
});

14. 系统引导

行动

实际用例 - 模块注册自定义功能/权限：

Hook::addAction('roles.register_permissions', function ($registry) {
    $registry->register('manage analytics', 'Analytics', 'View and manage analytics dashboard');
    $registry->register('export reports', 'Analytics', 'Export analytics reports to CSV');
});

相关文章

• Hooks & Filters 概述 — 事件系统总体概述

• 主题开发 — 自定义主题入门

• 模块开发 — 自定义模块入门

• REST API 身份验证 — 对 API 客户端进行身份验证