WP Active Check

「Not Wiz」 が開発・制作している Composer ライブラリ です。WordPress のウェブサイトで指定のテーマ、またはプラグインが有効化されているかを、簡単にチェックを行うことを可能にします。

ライブラリについて

WordPress のウェブサイトで指定のテーマ、またはプラグインが有効化されているかを簡易的にチェックします。また、複数のプラグインがすべて有効化しているのかチェックすることも可能です。

インストールコマンド

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

composer require kmix39/wp-active-check

使用方法

インスタンスの生成

$active_check = new Kmix39\WP_Active_Check\Bootstrap();

いずれかのテーマの有効化チェック

is_theme_active 関数を用意しています。

$result = $active_check->is_theme_active(
	[
		<テーマのディレクトリ名> => [ <バージョン>, <論理記号> ],
		<テーマのディレクトリ名> => [ <バージョン>, <論理記号> ],
	]
);

引数には、チェックテーマ要素の連想配列を渡します。

要素のキー名は、テーマのディレクトリ名になります。実際のテーマ名を記入しません。例えば、標準テーマである TwentyTwenty では twentytwenty となります。

バージョンは、数値文字列を記入します。 例えば、1.0.0 であれば '1.0.0' となります。

論理記号は、条件を判定するための論理記号を記入します。例えば、該当のバージョン以降を判定したい場合は '>=' となります。

チェックするテーマが有効な場合は true の値を返却します。有効でない場合は false の値を返却します。

チェックするテーマは複数指定可能で、複数指定した場合はいずれかのテーマが有効な場合は true の値を返却します。それ以外の場合は false の値を返却します。

いずれかのプラグインの有効化チェック

is_plugin_active 関数を用意しています。

$result = $active_check->is_plugin_active( [
	<プラグインの実行ファイル名> => [ <バージョン>, <論理記号> ],
	<プラグインの実行ファイル名> => [ <バージョン>, <論理記号> ],
] );

引数には、チェックテーマ要素の連想配列を渡します。

要素のキー名は、プラグインの実行ファイル名になります。実際のプラグイン名では指定しません。例えば、Hello Dolly では hello-dolly/hello.php となります。

バージョン、論理記号の記述方法は、テーマの有効化チェックである is_theme_active 関数と同様です。

チェックするプラグインが有効な場合は true の値を返却します。有効でない場合は false の値を返却します。

チェックするプラグインは、複数指定可能です。複数指定した場合は、いずれかのプラグインが有効な場合は true の値を返却します。すべて有効でない場合は false の値を返却します。

すべてのプラグインの有効化チェック

$result = $active_check->is_plugins_active( [
	'hello-dolly/hello.php' => [ '1.7.2', '>=' ],
] );

is_plugin_active 関数の and版 のような関数として is_plugins_active 関数を用意しています。

この関数は、指定されたプラグインがすべて有効化になっている場合のみ true の値を返却します。それ以外の場合は false の値を返却します。

リソースの公開先

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

GitHub – WP Active Check リポジトリページ