説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。