README

在该屏幕上显示可定制的横幅，并记住用户何时已将其关闭。

在您的网站上显示自定义横幅警报。

要求

php7.4+
Advanced Custom Fields Pro
nvm 或 fnm
node 16+
yarn 1.22+
npm 8.3+

快速开始第一次运行

安装SquareOne Docker (so)
运行: so bootstrap
运行: nvm use
运行: yarn install
运行: yarn mix
在WordPress仪表板中激活您的插件并开始开发！

拉取请求/构建

在提交PR之前，确保运行yarn prod以确保resources/dist文件夹已更新为最新的构建。

前端

前端构建由Laravel Mix提供支持。

构建

nvm use

yarn install

用法

为开发构建

yarn dev

监视文件更改

yarn watch

轮询文件更改

yarn watch-poll

使用热模块替换监视

yarn hot

为生产构建

yarn production

查看更多选项：yarn mix --help

安装此插件

每次发布版本后，都会自动创建一个tribe-alerts.zip，这是一个完全构建和供应商范围的WordPress插件，发布后大约一分钟。要手动安装，请访问发布页面，然后在WordPress插件文件夹中下载并解压缩zip文件。

Composer

通过使用出色的ffraenz/private-composer-installer插件，包括发布zip文件是最佳方式。

将自定义仓库添加到项目composer.json中的repository键

  "repositories": [
    {
      "type": "package",
      "package": {
        "name": "moderntribe/tribe-alerts",
        "version": "1.1.0",
        "type": "wordpress-plugin",
        "dist": {
          "type": "zip",
          "url": "https://github.com/moderntribe/tribe-alerts/releases/download/{%VERSION}/tribe-alerts.zip"
        },
        "require": {
          "ffraenz/private-composer-installer": "^5.0"
        }
      }
    },
 ],

注意：只需更新上面的版本并运行composer update即可在将来升级插件。

然后，将插件定义添加到require部分

  "require": {
    "moderntribe/tribe-alerts": "*",
  }

通过extra部分告诉Composer将您的WordPress插件/主题放置在哪里。

注意：根据您的项目调整路径。

  "extra": {
    "wordpress-install-dir": "wp",
    "installer-paths": {
      "wp-content/mu-plugins/{$name}": [
        "type:wordpress-muplugin"
      ],
      "wp-content/plugins/{$name}": [
        "type:wordpress-plugin"
      ],
      "wp-content/themes/{$name}": [
        "type:wordpress-theme"
      ]
    }
  },

您可能还需要在配置中允许此插件

    "allow-plugins": {
      "composer/installers": true,
      "ffraenz/private-composer-installer": true,
    }

最后，安装插件

composer update

显示警报

横幅设置为自动通过wp_footer钩子显示。如果您需要手动将其添加到主题或插件中，请将以下代码添加以渲染警报视图

<?php if ( function_exists( '\Tribe\Alert\tribe_alert' ) && function_exists( '\Tribe\Alert\render_alert' ) ) {
    \Tribe\Alert\render_alert();
} ?>

您可以通过在wp-config.php中定义以下内容来隐藏自动的wp_footer输出

define( 'TRIBE_ALERTS_AUTOMATIC_OUTPUT', false );

自定义警报视图标记

您可以通过以下方式过滤我们查找视图文件的目录，例如。

add_filter( 'tribe/alerts/view_directory', static fn ( string $directory ) => get_stylesheet_directory() . '/components/alerts', 10, 1 );

然后，将resources/views/alert.php复制到您的指定文件夹并按需自定义。

ACF Swatch 字段选项

默认情况下禁用了颜色选项。您可以通过在wp-config.php中定义以下内容来启用它

define( 'TRIBE_ALERTS_COLOR_OPTIONS', true );

过滤提供给ACF Swatch字段的颜色选项

add_filter( 'tribe/alerts/color_options', static fn ( array $options ) => [
    '#880ED4' => [
        'name'  => esc_html__( 'Purple', 'tribe-alerts' ),
        'class' => 'purple-mono',
    ],
    '#8155BA' => [
        'name'  => esc_html__( 'Violet', 'tribe-alerts' ),
        'class' => 'violet',
    ],
    '#323E42' => [
        'name'  => esc_html__( 'Charcoal', 'tribe-alerts' ),
        'class' => 'charcoal',
    ],          
], 10, 1 );

颜色主题的默认CSS类前缀是 tribe-alerts__theme，一旦选择了一种颜色，将变为 tribe-alerts__theme-$name。

过滤CSS类前缀

add_filter( 'tribe/alerts/color_options/css_class_prefix', static fn ( string $prefix ) => 'new-prefix', 10, 1 );

致谢

基于 Spatie Skeleton

许可证

GNU通用公共许可证GPLv2（或更新版）。请参阅许可证文件获取更多信息。

moderntribe / tribe-alerts

维护者

详细信息