説明
パラメータ
- $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
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。