概要
wp_check_password関数は、ユーザーのログインパスワードが正しいかどうかを検証するために使用されるWordPressの関数です。この関数は、ログイン機能やパスワード管理に関連するさまざまなシナリオでよく使われます。具体的には以下のような機能を実装する際に利用されます。
- ユーザーのログイン認証
- パスワードのリセット機能
- ユーザーアカウントのセキュリティチェック
- パスワード強度の確認
- サードパーティの認証システムとの統合
- ユーザーが新しいパスワードを設定する際の確認
- ユーザー登録時のパスワード検証
- プラグインやテーマによるカスタム認証ハンドリング
構文
bool wp_check_password( string $password, string $hash, string $user_id = '' )
パラメータ
$password(string): 確認するパスワード。$hash(string): ハッシュ化されたパスワード。$user_id(string): オプションのユーザーID。デフォルトは空。
戻り値
- (bool): パスワードが一致する場合は
true、一致しない場合はfalse。
関連する関数
使用可能なバージョン
wp_check_password関数は、WordPress 2.5以降で使用可能です。
コアファイルのパス
wp-includes/pluggable.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 |
この関数は特定のWordPressバージョンで非推奨または削除されていません。