wp_set_current_user

説明

WP_User wp_set_current_user( int $id [ , string $name = '' ] )
パラメータ$idで指定されたユーザ情報を新しい現在のユーザ情報として設定する。

パラメータ

  • $id
    ユーザIDを指定。
  • $name
    ユーザ名を指定(省略時は'')。

返り値

新しい現在のユーザ情報としてWP_Userのオブジェクト(グローバル変数$current_user)を返す。ユーザ情報のプロパティは次の通り。
プロパティ名データ型意味
dataObject基本データ
IDintユーザID
idintユーザID
capsArray所有するロールの連想配列(キー名がロール名)
cap_keystringロールのキー名
rolesArray所有するロールの配列(値がロール名)
allcapsArray所有する権限の連想配列(キー名が権限名)
first_namestring名前
last_namestring名字
filterstringフィルター
user_loginstringログイン名
user_passstring暗号化されたパスワード
user_nicenamestringナイスネーム
user_emailstringメールアドレス
user_urlstringウェブサイト
user_registeredstring登録日時(書式はyyyy-mm-dd hh:mm:ss)
user_activation_keystringアクティベーションキー
user_statusintステータス
display_namestringブログ上の表示名
spamintスパム
deletedint削除状態
nicknamestringニックネーム
descriptionstringプロフィール情報
rich_editingboolビジュアルリッチエディターの状況
comment_shortcutsboolキーボードショートカットの状況
admin_colorstring管理画面の配色
use_sslintSSL使用
aimstringAIM
yimstringYahoo IM
jabberstringJabber / Google Talk
wp_capabilitiesArray所有するロールの連想配列
wp_user_levelintユーザレベル
wp_dashboard_quick_press_last_post_idintクイック編集用の投稿ID
wp_usersettingsstringユーザ設定内容
wp_usersettingstimeintユーザ設定更新時間(秒数)
source_domainstringドメイン名
primary_blogintブログID
closedpostboxes_postArrayクローズされている編集パーツの配列
metaboxhidden_postArray非表示の編集パーツの配列
metaboxorder_postArray編集パーツの並び順(キー名は'side'、'normal'、'advanced')
screen_layout_postintスクリーンレイアウト(列の数)
managenavmenuscolumnshiddenArray非表示のナビゲーションメニュー項目
metaboxhidden_navmenusArray非表示のナビゲーションメニュー編集パーツ
user_levelintユーザレベル
user_firstnamestring名前
user_lastnamestring名字
user_descriptionstringプロフィール情報

注意

内部では、パラメータ$idおよび$nameで取得したユーザ情報をグローバル変数$current_userに設定する。

使用例

  • ユーザIDが3のユーザを現在のユーザとして設定する。
    <?php $userinfo = wp_set_current_user( 3 ); >

最終更新 : 2011年06月23日 17:17



お勧め

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

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

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

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

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