• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

クラスリファレンス/WP User

提供: WordPress Codex 日本語版
移動先: 案内検索

このページ「クラスリファレンス/WP User」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

説明

WordPress User クラスを使うと、特定のユーザーの属性・権限グループ・権限にアクセスできます。

使い方

特定のユーザーのインスタンスを作成するには、クラスコンストラクターを使えます。

<?php $users = new WP_User( $id [, $name [, $blog_id ] ] ); ?>

また、wp_get_current_user グローバル関数を使って現在ログインしているユーザーと一致する WP_User オブジェクトを取得することもできます。

<?php $current_user = wp_get_current_user(); ?>

コンストラクター

WP_User コンストラクターでは以下のパラメータが使えます。

  • id (int) - ユーザーのID。代わりに、ログイン名を使用する場合は空白のまま。
  • name (string) - ユーザーのログイン名。 idが設定されている場合は無視される。
  • blog_id (int) - マルチサイト環境でのブログID。デフォルト値は現在の blog id。

The semantics seem rather fuzzy. If id is a WP_User or other object, or an array of properties, it seems to clone it without touching the cache. Otherwise if id is a number it seems to try to read it possibly from the cache, or from the database using ->get_data_by(), which can also update the cache. If id is empty it reads by login name.

パブリックプロパティ

  • ID (int) - ユーザーのID.
  • caps (array) - 個々の機能はユーザーが指定されています。
  • cap_key (string) -
  • roles (array) - the roles the user is part of.
  • allcaps (array) - all capabilities the user has, including individual and role based.
  • first_name (string) - ユーザーの名。
  • last_name (string) -ユーザーの姓。

注: If called with the "id" or "name" parameter, the constructor queries the wp_users table. If successful, the additional row data become properties of the object: user_login, user_pass, user_nicename, user_email, user_url, user_registered, user_activation_key, user_status, display_name, spam (マルチサイトのみ), deleted (マルチサイトのみ).

マジックメソッド

These are PHP5 magic methods that facilitate property overloading. They don't need to be called directly, but are called automatically when a class property is referenced.

__get( $key )

カスタムフィールドにアクセスするためのマジックメソッド。

パラメータ 
  • key (string) - プロパティ。
戻り値 
(string) Single value of the property filtered.
新規導入 
3.3.0

__isset( $key )

プロパティまたはメタキーは、ユーザーとusermetaテーブルから設定されているかどうかを確認します。

パラメータ 
  • key (string) - プロパティ。
戻り値 
(bool) ユーザーは、プロパティを持っている場合は true、そうでなければ false
新規導入 
3.3.0

__set( $key, $value )

カスタムフィールドを設定するためのマジックメソッド。

Please note that setting custom fields affects only the current WP_User object, and does not set the value in the database. To change the database value use wp_update_user() or update_user_meta().

パラメータ 
  • key (string) - プロパティ.
  • value (string) - 値.
戻り値 
なし
新規導入 
3.3.0

パブリックメソッド

exists()

Determine whether the user exists in the database.

It actually tests !empty(ID), which will normally indicate that the user record was in the database at some stage. It does not access the database.

パラメータ 
なし
戻り値 
(bool) ユーザーが存在するなら true、そうでなければ false
新規導入 
3.4.0

get( $key )

Retrieve the value of a property or meta key from the users and usermeta tables.

パラメータ 
  • key (string) - プロパティ。
戻り値 
(mixed) String of the property filtered if single value, or array if value is stored as a serialized array
新規導入 
3.3.0

has_prop( $key )

Determine whether a property or meta key is set from the users and usermeta tables.

パラメータ 
  • key (string) - property.
戻り値 
(bool) true if user has property, false otherwise.
新規導入 
3.3.0

get_role_caps()

Retrieve all of the role capabilities and merge with individual capabilities.

All of the capabilities of the roles the user belongs to are merged with the users individual roles. This also means that the user can be denied specific roles that their role might have, but the specific user isn't granted permission to.

Sets the roles and allcaps properties.

パラメータ 
なし
戻り値 
なし
新規導入 
2.0.0

add_role( $role )

Add role to user.

Updates the user's meta data option with capabilities and roles.

パラメータ 
  • role (string) - role name.
戻り値 
なし
新規導入 
2.0.0

remove_role($role)

Remove role from user.

パラメータ 
  • role (string) - role name.
戻り値 
なし
新規導入 
2.0.0

set_role($role)

Set the role of the user.

This will remove the previous roles of the user and assign the user the new one. You can set the role to an empty string and it will remove all of the roles from the user.

パラメータ 
  • role (string) - role name.
戻り値 
なし
新規導入 
2.0.0
Related actions 
* set_user_role

add_cap($cap [, $grant ] )

Add capability and grant or deny access to capability.

パラメータ 
  • cap (string) - capability name.
  • grant (bool) - whether to grant capability to user. デフォルト値は true
戻り値 
なし
新規導入 
2.0.0

remove_cap($cap)

Remove capability from user.

パラメータ 
  • cap (string) - capability name.
戻り値 
なし
新規導入 
2.0.0

remove_all_caps()

Remove all of the capabilities of the user.

パラメータ 
なし
戻り値 
なし
新規導入 
2.1.0

has_cap($cap)

Whether user has capability or role name.

パラメータ 
  • cap (string) - capability or role name to search.
戻り値 
(bool) true if user has capability, false if they do not have the capability.
新規導入 
2.0.0

用例

Checking if the current user can edit user profiles :

<?php
    $cu = wp_get_current_user();
    if ($cu->has_cap('edit_users')) {
       // do something
    }    
?>

Check if user exists:

<?php
    $user = wp_get_current_user();
    if ( $user->exists() ) {
       // do something
    }    
?>

Check if user has a property:

<?php
    $user = wp_get_current_user();
    if ( $user->has_prop( 'twitter' ) ) {
       // do something
    }    
?>

更新履歴

2.0.0 以降

ソースファイル

WP_Userwp-includes/capabilities.php にあります。

関連資料

外部リンク

クラスリファレンス関数リファレンスの各インデックスも参照してください。

最新英語版: WordPress Codex » Class_Reference/WP_User最新版との差分