README

一个小型库，用于轻松管理WordPress仪表板中的通知消息

安装

使用 Composer 依赖此库。

composer require antonioeatgoat/wp-dashboard-notice

然后在您的项目中包含 Composer 自动加载文件：

require_once 'vendor/autoload.php'

如果没有这个选项，则克隆或下载此包，并在您的代码中要求 wp-dashboard-notice/autoload.php 文件。

require_once 'path/to/wp-dashboard-notice/autoload.php';

其中 path/to/wp-dashboard-notice/autoload.php 是 autoload.php 文件的绝对路径。

示例

$notice = ( new NoticeFactory() )->create(
	'hello-world-notice',
	'<strong>Hello World</strong> - This is a sample notice',
	array(
		'title'          => 'This is a sample title',  
		'show_close_btn' => true,
		'cta_text'       => 'This is a custom CTA!',
		'cta_href'       => '#',
		'dismiss_text'   => "Don't show it again",
		'dismiss_mode'   => 'global',
		'status'         => 'success'
	));
NoticesManager::init()->register_notice($notice);

参数

通知创建需要三个参数

• id: (string) 一个唯一的ID，用于标识它（它还用作打印的通知消息的HTML中的id属性）。
• message: (string) 实际通知消息。
• args: (array) 可选。包含更多配置的参数数组。

以下是配置的使用方法。

自定义CTA

您可以使用这些参数打印自定义CTA按钮，两个参数都是必需的，用于显示CTA。

• cta_text: 按钮的文本。
• cta_href: CTA指向的链接。

永久删除

通知消息可以被永久删除，点击特定的链接。它支持三种删除模式

• none: (默认) 通知消息不能被删除，并且不会显示删除链接。
• global: 一旦删除，通知消息将不再显示给任何人。
• user: 一旦删除，通知消息仅对当前用户删除。其他用户将继续看到它。

您可以使用这些参数打印删除链接，两个参数都是必需的，用于显示链接。

• dismiss_text: 链接的文本。
• dismiss_mode: 上面的删除模式。

其他

参数数组的其他参数

• Title: (string) 可选的标题，显示在消息上方。
• status: 通知消息的状态。可用值为 "info" (默认)，"success"，"warning"，"error"。
• show_close_btn: (bool) 默认 false。如果显示关闭通知消息的按钮。**注意**：这将仅关闭通知，而不是删除它。在页面刷新时，如果代码需要，它将再次显示。这对于“一次性”通知消息很有用，例如在激活插件时显示的“插件已激活”通知消息，它不会永久留在页面上。