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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。