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



お勧め

テーブルブロックを定形に整える(2021年12月27日 更新)

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

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

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