wp_signon

説明

mixed wp_signon( [ array $credentials = array() [ , mixed $secure_cookie = '' ] ] )
認証処理を行う。

パラメータ

  • $credentials
    認証情報を連想配列で指定(省略時はarray())。連想配列の内容は次の通り。
    キーデータ型意味
    'user_login'stringログイン名
    'user_password'stringパスワード
    'remember'boolログイン情報を保持する場合はtrue
  • $secure_cookie
    セキュアクッキーを使用する場合はtrueを指定(省略時は'')。

返り値

認証できた場合はユーザー情報オブジェクトを返す。認証に失敗した場合は WP_Errorオブジェクトを返す。

注意

パラメータ$credentialsの省略時は$_POSTを参照するが、キー名が異なるので注意が必要である。

$credentialsのキー$_POSTのキー
'user_login''log'
'user_password''pwd'
'remember''rememberme'

パラメータ$secure_cookie省略時は、 is_ssl関数の結果が適用される。


使用例

  • $_POSTパラメータで認証処理を行う。
    <?php wp_signon(); ?>
  • 連想配列を指定した$paramで認証処理を行う。
    <?php wp_signon( $param ); ?>

フィルター

[3.1.0]認証処理を行う(認証時のクッキーを出力する)前、'secure_signon_cookie'フィルターを実行する。パラメータ$secure_cookie$credentialsは省略時処理済みの値が格納されている。
$secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );

アクション

[1.5.1]$credentialsの初期処理後、'wp_authenticate'アクションを実行する。パラメータは配列で、索引0の要素がログイン名のポインタ、索引1の要素がパスワードのポインタが格納されている。
do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
[1.5.0]認証したユーザー情報を返す前に'wp_login'を実行する。パラメータ$user_loginにはログイン名、$userにはユーザー情報オブジェクトが格納されている。
do_action( 'wp_login', $user_login, $user );

ソースファイル

/wp-includes/user.php

最終更新 : 2014年07月24日 13:43



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。