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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。