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



お勧め

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

ポップアップのログインフォームに何か表示する(2018年11月6日 更新)

まもなくリリースされるWordPress 5.0にタイミングを合わせて「Login rebuilder」プラグインのアップデートを予定している。管理画面にログインしてしばらく操作しないと、ログインフォームがポップアップ表示される。このログインフォームに何かを表示するのが今回の内容だ。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

Login rebuilder:プラグイン作ってみました(2019年9月7日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。