wpdesk/wp-notice

显示 WordPress 通知的库。

3.2.5 2024-07-23 13:33 UTC

README

pipeline status coverage report Latest Stable Version Total Downloads Latest Unstable Version License

wp-notice

这是一个简单但非常实用的 WordPress 插件库,允许在管理区域显示不同类型的通知。它可以轻松用于

  • 显示简单的错误、警告、成功和信息通知
  • 显示永久可关闭的通知
  • 使用 AJAX 请求处理关闭功能。

要求

PHP 5.5 或更高版本。

通过 Composer 安装

要使用 Composer 安装绑定,请运行以下命令

composer require wpdesk/wp-notice

然后,使用 Composer 的 自动加载 来使用它们

require_once 'vendor/autoload.php';

手动安装

如果您不希望使用 Composer,您也可以 下载最新的库发布版本。一旦完成,只需包含 init.php 文件即可使用通知。

require_once('/path/to/wp-desk/wp-notice/init.php');

入门指南

通知使用示例

$notice = wpdesk_wp_notice('Notice text goes here');

// Is equivalent to:
$notice = WPDeskWpNotice('Notice text goes here');

// Is equivalent to:
$notice = \WPDesk\Notice\Factory::notice('Notice text goes here');

// Is equivalent to:
$notice = new \WPDesk\Notice\Notice('Notice text goes here'); 

请注意,通知必须在 WordPress admin_notices 动作之前使用。您可以在 此处 找到 WordPress 管理动作顺序列表。

永久可关闭的通知

AJAX 处理程序

为了使用永久可关闭的通知,需要首先创建 AJAX 处理程序并初始化钩子

wpdesk_init_wp_notice_ajax_handler();

// Is equivalent to:
( new \WPDesk\Notice\AjaxHandler() )->hooks();

显示永久可关闭的通知

以下代码用于显示永久可关闭的通知

wpdesk_permanent_dismissible_wp_notice( 'Notice text goes here', 'notice-name' );

// Is equivalent to
$notice = new \WPDesk\Notice\PermanentDismissibleNotice( 'Notice text goes here', 'notice-name' );

项目文档

PHPDoc: https://wpdesk.gitlab.io/wp-notice/index.html