概要
wp_is_application_passwords_available 関数は、WordPress においてアプリケーションパスワードが利用できるかどうかを判定する際に使用されます。この関数は、API を通じてセキュアに認証を行うためのアプリケーションパスワード機能が有効であるかを確認するために役立ちます。アプリケーションパスワードを利用できるか調べることで、実装されている機能が正常に動作するかを確認できます。以下は、この関数がよく使われる場面の例です。
- プラグインの設定画面でアプリケーションパスワードの利用可否を確認する場合
- REST API のエンドポイントでアプリケーションパスワードの認証を行う場合
- 他のサービスとの連携の際にアプリケーションパスワードが必要かどうかを調べる場合
- ユーザーの認証においてセキュリティを強化する際に利用する場合
- 過去のパスワードエントリがアプリケーションパスワードであるかを確認する場合
- カスタム API エンドポイントでアプリケーションパスワードをチェックする場合
- デフォルトの WordPress のインストール時にアプリケーションパスワードの有効性を確認する場合
- ユーザーのセキュリティチェックを自動化するスクリプトで使う場合
構文
wp_is_application_passwords_available();
パラメータ
この関数にはパラメータはありません。
戻り値
bool– アプリケーションパスワードが利用可能である場合はtrue、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
- WordPress 5.6 以上
コアファイルのパス
wp-includes/user.php
サンプルコード
サンプルコード 1: アプリケーションパスワードの利用可否を確認する
if ( wp_is_application_passwords_available() ) {
echo "アプリケーションパスワードが利用可能です。";
} else {
echo "アプリケーションパスワードは利用できません。";
}
このコードは、アプリケーションパスワードが利用可能かどうかを確認し、その結果に基づいてメッセージを表示します。
サンプルコード 2: アプリケーションパスワードを要する機能の実装
if ( wp_is_application_passwords_available() ) {
// アプリケーションパスワードが利用できる場合の処理
register_api_endpoints();
} else {
// アプリケーションパスワードが利用できない場合の処理
show_error_message();
}
このコードスニペットは、アプリケーションパスワードが利用可能かどうかを確認し、利用可能な場合はAPIエンドポイントを登録します。
サンプルコード 3: REST API ハンドラーでの利用
add_action('rest_api_init', function() {
if ( ! wp_is_application_passwords_available() ) {
register_rest_route('myplugin/v1', '/data', [
'methods' => 'GET',
'callback' => 'my_api_callback',
'permission_callback' => '__return_false',
]);
}
});
このコードはREST APIハンドラーを登録し、アプリケーションパスワードが利用できない場合には適切なガードを配置します。
サンプルコード 4: 管理画面でのチェック
function check_application_passwords_in_admin() {
if ( ! wp_is_application_passwords_available() ) {
add_notice("アプリケーションパスワードが無効です。");
}
}
add_action('admin_notices', 'check_application_passwords_in_admin');
このコードは管理画面においてアプリケーションパスワードの利用可否をチェックし、無効な場合には通知を表示します。
サンプルコード 5: ユーザープロファイルでの状態確認
function display_application_passwords_status() {
if ( wp_is_application_passwords_available() ) {
echo "あなたのサーバーはアプリケーションパスワードをサポートしています。";
} else {
echo "アプリケーションパスワードはサポートされていません。";
}
}
add_action('show_user_profile', 'display_application_passwords_status');
このコードでは、ユーザーのプロファイル画面にアプリケーションパスワードのサポート状況を表示します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
この関数は特定のアクションでの利用例が確認されていません。
非推奨または削除されたバージョン
この関数は特定のバージョンで非推奨または削除されていません。