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

最終更新 : 2020年04月07日 12:41



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。