wp_authenticate

（2.5.0以降）
wp_authenticate - ユーザー認証を行う

説明

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

関連

参考

Code Reference: wp_authenticate

お勧め

フィードにサムネイル画像を追加する（2022年11月1日 更新）

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。

5.5の機能強化：コメントフォームのちょっとした改良（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3（以降Beta 3）」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました（2018年5月27日 更新）

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる（2011年10月14日 更新）

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた（こんなことを考えてるのは自分だけだろうか！？）。