julien731/wp-dismissible-notices-handler

一个简单的库,用于处理WordPress的Ajax可 dismissable 管理通知

1.2.2 2021-02-17 15:56 UTC

This package is auto-updated.

Last update: 2024-09-17 23:45:33 UTC


README

Scrutinizer Code Quality

从版本4.2开始,WordPress有一个内置机制来处理可 dismissable 管理通知。虽然这个机制可以处理 dismissable 通知,但是 dismissable 并不是持久的。这意味着即使用户已经 dismiss 了这个通知,每次页面加载时用户仍然会看到这个通知。

Dismissible Notices Handler (DNH) 库所做的就是处理 dismissable 管理通知的持久部分。

工作原理

DNH 库非常简单易用,同时也有一些高级选项。

它的基本原理是注册一个新的管理通知。您注册通知时确实需要三样东西:

  • 一个唯一的 ID 来标识通知(如果出现 ID 冲突,您将收到警告)
  • 一个通知类型
  • 在通知中显示的消息

有一个方便的辅助函数可用于注册通知:dnh_register_notice()

此函数接受 4 个参数

  • $id (字符串):通知的唯一 ID
  • $type (字符串):您想要显示的通知类型。目前可以是 error 用于错误通知或 updated 用于成功/更新通知
  • $content (字符串):管理通知的内容
  • $args (数组):可以传递给通知处理器的额外参数(见下文)

安装

使用 DNH 的最简单方法是将它添加为 Composer 依赖项

composer require julien731/wp-dismissible-notices-handler

示例

注册一个管理通知将看起来像这样

dnh_register_notice( 'my_notice', 'updated', __( 'This is my notice' ) );

高级参数

该函数接受一个可选参数数组,允许您对通知及其 dismissable 方式有更多的控制。目前只有 3 个参数可用,但希望很快会有更多。

以下是可以通过 $args 数组传递的可用参数列表。请注意,$args 参数是可选的。