説明
WP_User | WP_Error wp_authenticate( string $username, string $password )
ユーザー認証を行う。
パラメータ
- $usernameユーザー名（[4.5.0]またはメールアドレス）を指定。
- $passwordパスワードを指定。
返り値
認証が成功した場合はWP_Userオブジェクト（ユーザー情報）を、認証が失敗した場合はWP_Errorオブジェクトを返す。注意
本関数は wp_signon関数などから呼び出され、ユーザー認証を行う。
[2.8.0]実際のユーザー認証処理は'authenticate'フィルターで行われる。
[4.5.0]パラメータ$usernameにメールアドレスが指定可能になった。
[5.4.0]'wp_login_failed'アクションにパラメータ$errorが追加された。
使用例
- ユーザー認証を行う
<?php $result = wp_authenticate( $username, $password ); ?>
フィルター
[2.8.0]パラメータをサニタイズした後に'authenticate'フィルターを呼び出す。パラメータ$userにはnullが、$usernameと$passwordには本関数が受け取った内容をサニタイズした内容が格納されている。$user = apply_filters( 'authenticate', $user, $username, $password );アクション
[2.5.0]認証が失敗した場合は'wp_login_failed'アクションを呼び出す。パラメータ$usernameには本関数が受け取った内容をサニタイズしたものが格納されている。[5.4.0]パラメータ$errorには認証の失敗理由を示すWP_Errorオブジェクトが格納されている。do_action( 'wp_login_failed', $username, $error );ソースファイル
/wp-includes/pluggable.php最終更新 : 2022年01月31日 13:08
関連
お勧め
テキストエディタの文字を変更する（2018年5月27日 更新）
テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。
query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。更新ボタンの横にスピナーを実装する（2019年5月14日 更新）
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない（2018年5月27日 更新）
数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。
Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）
プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。