WP Group Admin Notices

「Not Wiz」 が開発・制作している Composerライブラリ です。WordPress の管理画面内で表示したい Notice(警告) を、簡単にグループ管理し、まとめた表示をすることを可能にします。

どのようなライブラリか

WordPress の管理画面内の Notice(警告) を、簡単に警告グループとして管理します。警告グループで管理する事で、複数の警告をまとめた状態で表示できます。

インストールコマンド

ライブラリをコマンドでインストールする際は、次のとおりです。

composer require kmix39/wp-group-admin-notices

使用方法

インスタンスの生成

$notices = \Kmix39\WP_Group_Admin_Notices\Bootstrap::instance();

Kmix39\WP_Group_Admin_Notices\Bootstrap クラスは、シングルトンのクラスとなっています。常に同一のインスタンスを返却します。

このことは、ライブラリを使用するプログラム内のどの箇所でも管理者画面の警告グループを追加、削除できるように設計されている為です。

警告グループに警告を追加する

$notices->add_notice(
	<警告グループのslug>,
	<警告グループのcode>,
	<警告内に表示されるメッセージ>
);

add_notice 関数は、警告グループの追加をします。

  • 第1引数の 警告グループの slug は、同一値をすべて1つの警告内に表示を行う管理を行います。
  • 第2引数は、警告グループの code となります。第1引数のグループに対してコード名でカテゴライズを行えます。
  • 第3引数は、警告内に表示されるメッセージとなります。

警告グループから警告を削除する

$notices->remove_notice(
	<警告グループのslug>,
	<警告グループのcode>
);

remove_notice 関数は、指定されたすべての警告を削除します。

  • 第1引数で、警告グループの slug を指定します。
  • 第2引数で、警告グループの code を指定します。

警告グループを表示する

$notices->display_notices(
	<警告グループのslug>,
	<警告のスタイルのclass>
);

display_notices 関数は、指定された警告グループのすべての警告を1つの警告にまとめて表示します。

  • 第1引数は、警告グループの slug を指定します。
  • 第2引数は、警告のスタイルの class となっており、 notice-info や notice-warning と言った定義を設定できます。

リソースの公開先

開発リソースは、次の GitHubリポジトリ で公開をしています。

GitHub – WP Group Admin Notices リポジトリページ