概要
is_wp_version_compatible 関数は、指定したWordPressバージョンと現在のインストールされているWordPressバージョンの互換性をチェックするために使用されます。この関数を使うことで、テーマやプラグインが動作するための最低限のバージョン要件を満たしているかどうかを判断することができます。以下のような機能を実装する際によく使われます。
- プラグインの有効化時のバージョンチェック
- テーマの情報表示や導入時のバージョン要件チェック
- 特定の機能の使用条件としてのバージョンチェック
- アップグレード時の互換性確認
- デバッグ情報やエラーメッセージの表示におけるバージョンチェック
- おすすめのプラグインやテーマのバージョン確認
- プラグインの設定画面でのバージョン相互依存性チェック
- 開発者向けのテストやデバッグツールの作成
構文
is_wp_version_compatible( $compare_version, $operator = '==' );
パラメータ
$compare_version(string) : 比較したいバージョン番号（例：’5.0’）$operator(string) : バージョンを比較するための演算子（デフォルトは ‘==’）
戻り値
- (bool) : 指定されたバージョンと互換性がある場合は
true、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
- WordPress 4.0 以降
コアファイルのパス
wp-includes/functions.php
サンプルコード
- プラグインの有効化時にバージョンをチェックする
function my_plugin_activate() {
if ( ! is_wp_version_compatible( '5.0' ) ) {
deactivate_plugins( plugin_basename( __FILE__ ) );
wp_die( 'このプラグインはWordPress 5.0以降が必要です。' );
}
}
add_action( 'activate_my-plugin/my-plugin.php', 'my_plugin_activate' );
このコードは、プラグインが有効化された際にWordPressのバージョンをチェックし、5.0未満の場合はプラグインを非活性化します。
- テーマの適用時にバージョンを確認する
function my_theme_setup() {
if ( ! is_wp_version_compatible( '4.7' ) ) {
wp_die( 'このテーマはWordPress 4.7以降が必要です。' );
}
}
add_action( 'after_setup_theme', 'my_theme_setup' );
テーマがセットアップされる際に、指定したバージョン以上であるかを確認し、条件を満たさない場合はエラーメッセージを表示します。
- ダッシュボードでバージョンを表示する
function check_version_in_admin() {
if ( is_wp_version_compatible( '5.5' ) ) {
echo '<div class="notice notice-success">WordPressは最新の安定版です。</div>';
} else {
echo '<div class="notice notice-error">このWordPressバージョンは非推奨です。</div>';
}
}
add_action( 'admin_notices', 'check_version_in_admin' );
ダッシュボードの管理画面で、現在のWordPressバージョンが5.5以上かを確認し、ユーザーにメッセージを表示します。
- カスタム機能の条件にバージョンを確認する
function custom_feature() {
if ( is_wp_version_compatible( '5.1', '>=' ) ) {
// 新機能の処理
} else {
// 互換性のない処理
}
}
add_action( 'init', 'custom_feature' );
新しい機能を導入する際に、WordPress 5.1以上の場合のみ有効にする処理を設定しています。
- ショートコードの実装で互換性をチェック
function my_shortcode() {
if ( ! is_wp_version_compatible( '4.9' ) ) {
return 'このショートコードはWordPress 4.9以降でのみ使用できます。';
}
return 'このショートコードは正常に動作しています。';
}
add_shortcode( 'my_shortcode', 'my_shortcode' );
ショートコードを定義する際に、ユーザーのWordPressバージョンを確認し、条件を満たさない場合はエラーメッセージを返します。
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | 〇 |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。