概要
wp_is_application_passwords_supported関数は、WordPressがアプリケーションパスワードをサポートしているかどうかを確認するために使用されます。アプリケーションパスワードは、ユーザーが外部アプリケーションと安全に接続するための一つの方法です。この関数は、アプリケーションパスワードが使用できるかどうかを調べるために、特に以下のような場面でよく使われます：
- サードパーティプラグインの認証機能
- モバイルアプリとの連携
- APIエンドポイントへの接続
- ユーザー管理機能を強化するプラグイン
- セキュリティ向上のためのカスタム機能
- 自動化ツールの設定
- ウェブサービスとの統合
- クライアントサイドアプリケーションの認証処理
構文
wp_is_application_passwords_supported();
パラメータ
この関数にはパラメータはありません。
戻り値
- 真（true）: アプリケーションパスワードがサポートされている場合
- 偽（false）: アプリケーションパスワードがサポートされていない場合
関連する関数
使用可能なバージョン
この関数は、WordPress 5.6以降で使用可能です。
ワードプレスのコアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
サンプルコード
-
アプリケーションパスワードのサポートチェック
if ( wp_is_application_passwords_supported() ) { echo 'アプリケーションパスワードがサポートされています。'; } else { echo 'アプリケーションパスワードはサポートされていません。'; }- このコードは、アプリケーションパスワードのサポートをチェックし、その結果に基づいてメッセージを表示します。
-
エラーメッセージの出力
if ( ! wp_is_application_passwords_supported() ) { error_log( 'アプリケーションパスワードは使用できません。' ); }- アプリケーションパスワードがサポートされていない場合にエラーログにメッセージを記録します。
-
APIレスポンスの調整
if ( wp_is_application_passwords_supported() ) { $response['supports_app_passwords'] = true; } else { $response['supports_app_passwords'] = false; }- このサンプルは、APIレスポンスにアプリケーションパスワードのサポート情報を追加しています。
-
プラグインの機能制御
function my_plugin_function() { if ( ! wp_is_application_passwords_supported() ) { deactivate_plugins( plugin_basename(__FILE__) ); } } add_action( 'plugins_loaded', 'my_plugin_function' );- プラグインがアプリケーションパスワードをサポートしていない場合は、プラグインを無効化します。
-
カスタムウィジェットの条件付き表示
function my_widget_display() { if ( wp_is_application_passwords_supported() ) { // ウィジェットの内容を表示するコード } }- アプリケーションパスワードがサポートされている場合にだけウィジェットの内容を表示する条件を設定しています。