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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

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

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。