user_register アクションで行います。コールバックは $user_id と、WordPress 5.8.0 から追加された第2引数 $userdata を受け取れます。第2引数を使うには、add_action の第4引数に 2 を指定します。first_name など)。今回の環境では保存済みでしたが、前提にしないようにします。sanitize_text_field() などで整えてから update_user_meta() を使います。user_register ではなく registration_errors フックの役割です。公式リファレンスにも、このフックで登録フィールドの検証をしないよう注意書きがあります。user_register の時点ではユーザーはすでに作成済みなので、ここでエラーを返して登録を止めることはできません。user_register は、wp_insert_user()(wp_create_user() の内部でも使われます)がユーザーを新規作成した直後に実行されます。管理画面からの追加、wp-login.php?action=register の登録、プログラムからの追加のどれでも発火します。
| 目的 | 使うフック |
|---|---|
| 登録直後にメタを保存・通知する | user_register |
| 登録フォームの入力チェック | registration_errors |
| プロフィール更新後の処理 | profile_update |
| ログインしたとき | wp_login |
user_register は「更新」では呼ばれず、新規作成のときだけです。更新を拾いたいときは profile_update を使います。
登録元(signup_source)をメタに保存する例です。
add_action( 'user_register', 'myplug_after_user_register', 10, 2 );
function myplug_after_user_register( $user_id, $userdata = array() ) {
// 入力はサニタイズしてから保存
$source = isset( $userdata['signup_source'] ) ? sanitize_text_field( $userdata['signup_source'] ) : 'unknown';
update_user_meta( $user_id, 'signup_source', $source );
// 例: 管理者に通知(本文に入るユーザー名は用途に合わせて整える)
$user = get_userdata( $user_id );
if ( $user ) {
wp_mail(
get_option( 'admin_email' ),
'新規ユーザーが登録されました',
'ユーザー名: ' . $user->user_login
);
}
}
フォームから受け取る場合は、フィールドを $_POST から読み、wp_unslash() と sanitize_text_field() を通します。wp-login.php の登録フォームにフィールドを足す場合は、register_form フックで表示し、registration_errors で検証します。
WordPress 7.1.2(ja)、PHP 8.2.12。php run.php user-register-after.php でテストユーザーを作成し、確認後に削除しました。
[hook] user_id=4
[hook] userdata keys: user_login,user_pass,user_email,first_name,role,signup_source
[hook] first_name meta in hook: [Taro]
after insert first_name: Taro
signup_source: campaign // " <b>campaign</b> " がサニタイズされた
roles: subscriber
$userdata には、wp_insert_user() に渡した配列がそのまま入っていました(signup_source のような独自キーも含む)。" <b>campaign</b> " は、sanitize_text_field() により campaign として保存されました。first_name が取得できました。ただし公式は「保存済みでない場合がある」としているため、挙動に依存しない書き方($userdata から読む)を勧めます。$userdata は wp_insert_user() に渡された配列なので、user_pass(平文のパスワード)も入る場合があります。ログ出力やメールに含めないでください。$userdata を使うには、WordPress 5.8.0 以降が必要です。それ以前に対応する場合は、$_POST を読む方法になりますが、CLIや管理画面追加と挙動が違うため注意します。user_register の中でユーザーを再度 wp_update_user() すると、profile_update などの更新系フックが走ります。そちらにも処理があると連鎖し、意図しない重複処理や無限ループのもとになります。wp_insert_user() の role で行うのが基本です。後処理で set_role() を使うと、他プラグインと衝突することがあります。add_action( 'user_register', 'fn' ) と書き、引数の数を指定せず、第2引数 $userdata が渡されない(既定値のまま。既定値なしの関数定義なら ArgumentCountError になる)。user_register の中で wp_die() を呼ぶ(既にユーザーが作成されている)。$_POST をサニタイズせずにメタへ保存する。wp_mail() の本文に、エスケープなしでユーザー入力を入れる(HTMLメールの場合)。add_action の優先度の後ろに引数の数 2 を指定したか。registration_errors で行っているか。user_pass を出力していないか。Q. 管理画面から追加したユーザーにも発火しますか?
A. 発火します。wp_insert_user() を通る追加は、すべて対象です。
Q. ログイン後に初回だけ処理したいときは?
A. wp_login フックと、ユーザーメタの「初回済みフラグ」を併用する方法があります。
Q. 登録時のロールを変えたいのですが?
A. 設定の「新規ユーザーのデフォルト権限グループ」を変える方法が確実です(default_role オプション)。
user_register は「登録が成立したあとの副作用」を置く場所だと考えます。入力を弾く処理を置くと、ユーザーだけが作られて処理が止まる不整合が起きやすいので、検証は前段(registration_errors)に分けて書くのが安全だと思います。
wp_user_roles オプション)に保存されます。プラグインやテーマの読み込みのたびに add_role() を呼ぶ必要はなく、有効化時に1回だけ実行します。add_role() を呼ぶと、何も変更されず null が返ります。権限を変えたいときは get_role()->add_cap() / remove_cap() を使います。manage_shop_reports)は、どのロールにも追加でき、current_user_can() で確認できます。管理者に付けたい場合は、管理者ロールにも明示的に add_cap() が必要です。remove_role() / remove_cap() で片付けます。公式ドキュメントでは、最初の add_role() の後でロールとそのケイパビリティがDBに保存され、以降の呼び出しは何もしないと説明されています。init などで毎回呼ぶと、無駄な処理が増えます。
| 操作 | 関数 | 備考 |
|---|---|---|
| ロールを作る | add_role( $role, $display_name, $caps ) |
既存なら null |
| 権限を足す | get_role( $role )->add_cap( $cap ) |
DBへ保存される |
| 権限を外す | get_role( $role )->remove_cap( $cap ) |
|
| ロールを消す | remove_role( $role ) |
ロール定義だけが消え、そのロールのユーザーは権限を失う |
プラグインの有効化・無効化フックで実行する例です。
register_activation_hook( __FILE__, 'myplug_activate' );
function myplug_activate() {
// カスタムロール
add_role( 'shop_staff', '店舗スタッフ', array(
'read' => true,
'edit_posts' => true,
) );
// 既存ロールにカスタム権限を追加(管理者にも付ける)
foreach ( array( 'administrator', 'shop_staff' ) as $name ) {
$role = get_role( $name );
if ( $role ) {
$role->add_cap( 'manage_shop_reports' );
}
}
}
register_deactivation_hook( __FILE__, 'myplug_deactivate' );
function myplug_deactivate() {
$role = get_role( 'administrator' );
if ( $role ) {
$role->remove_cap( 'manage_shop_reports' );
}
remove_role( 'shop_staff' );
}
使う側は、ロール名ではなくケイパビリティで確認します。
if ( current_user_can( 'manage_shop_reports' ) ) {
// レポートを表示
}
WordPress 7.1.2(ja)、PHP 8.2.12。php run.php add-cap-to-role.php を実行しました。テスト用ロール test_editor_x とテストユーザーを作成し、最後に削除しています(manage_shop_reports は検証用の名前)。
first add_role: WP_Role
second add_role: NULL // 同名ロールの再追加は null
caps after 2nd add_role: read // 2回目に渡した edit_posts は反映されない
caps after add_cap: read,manage_shop_reports
stored in option 'wp_user_roles': bool(true)
user can manage_shop_reports: bool(true)
user can edit_posts: bool(false)
admin has it? bool(false) // 管理者には自動では付かない
removed: NULL
重要なのは次の3点です。
add_role() で渡した edit_posts は、反映されませんでした。add_cap() した権限は、wp_user_roles オプションに保存されました。add_cap() が必要です。add_cap() を実行するか、バージョン番号をオプションに保存して、更新時にだけ実行します。remove_role() で消す前に、そのロールのユーザーがいないか確認します。remove_role() はユーザー側のロール指定(usermeta)までは書き換えないため、そのユーザーは有効な権限を持たない状態になります。先に別のロールへ移します。init で毎回 add_role() を呼び、権限の変更が反映されないと悩む。add_role() の第3引数を変えれば更新されると思い込む。current_user_can( 'shop_staff' ) と判定し、権限ベースの設計を崩す。add_cap() しているか。current_user_can() に、ケイパビリティ名で行っているか。Q. テーマの functions.php でも実行できますか?
A. 可能ですが、テーマを切り替えるとロールだけDBに残ります。プラグインでの管理が向いています。
Q. 反映されないときの確認方法は?
A. get_role( 'ロール名' )->capabilities を表示すると、DBに保存された権限が見られます。
Q. ユーザー単位で権限を付けられますか?
A. WP_User::add_cap() で可能ですが、管理が複雑になるため、ロール単位を基本にします。
ロールを「コードで毎回定義する設定」だと思うと、DB保存の挙動に戸惑うと考えます。実際には「一度書き込む設定データ」なので、更新用のバージョン管理を持っておく設計が現実的です。権限の名前を最初にきちんと決めておくことが、後の保守で一番効くと思います。
is_admin() は「いま管理画面側のリクエストか」を返す関数で、ユーザーが管理者かどうかは判定しません。公式にも、ロールや権限の確認には current_user_can() を使うよう書かれています。is_admin() ではなく current_user_can( 'manage_options' ) などのケイパビリティで守ります。administrator)ではなくケイパビリティ名を渡すのが公式の推奨です。is_admin() は admin-ajax.php 経由のリクエストでも true になります。Ajaxの権限確認は特に current_user_can() が必須です。名前が「admin」なので、「管理者かどうか」と誤解されやすい関数です。実際には、管理画面のスクリプト(wp-admin/ 配下)が実行されたことを示す WP_ADMIN 定数や、現在の画面情報を見ているだけです。ログインしているかどうかも見ていません。
| 関数 | 判定する内容 | 使う場面 |
|---|---|---|
is_admin() |
管理画面側のリクエストか | 管理画面専用のフックやファイルの読み分け |
current_user_can( $cap ) |
現在のユーザーがその権限を持つか | 処理を許可するか |
is_user_logged_in() |
ログイン中か | ログイン必須の表示 |
current_user_can() は init フック以降で呼ぶのが安全です。それ以前(プラグイン読み込み直後など)では、ユーザー情報が未確定だったり、関連する関数(pluggable.php)がまだ読み込まれていなかったりすることがあります。
管理画面のメニュー追加と、保存処理の両方で、権限を明示する例です。
// メニュー追加(権限のない人にはメニュー自体が出ない)
add_action( 'admin_menu', function () {
add_menu_page( '売上レポート', '売上レポート', 'manage_options', 'myplug-report', 'myplug_render_report' );
} );
function myplug_render_report() {
// 画面表示の関数でも権限を再確認する
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( '権限がありません。' );
}
echo '<div class="wrap"><h1>' . esc_html( get_admin_page_title() ) . '</h1></div>';
}
// 悪い例: 管理画面なら誰でも通る
add_action( 'admin_init', function () {
if ( is_admin() && isset( $_POST['myplug_reset'] ) ) {
delete_option( 'myplug_data' ); // ← 購読者でも実行できてしまう
}
} );
悪い例は、購読者(subscriber)などのログインユーザーが admin-post.php や admin-ajax.php に直接リクエストを送ると、通ってしまう構造です。次のように直します。
add_action( 'admin_init', function () {
if ( isset( $_POST['myplug_reset'] ) ) {
check_admin_referer( 'myplug_reset' ); // CSRF
if ( ! current_user_can( 'manage_options' ) ) { // 認可
wp_die( '権限がありません。' );
}
delete_option( 'myplug_data' );
}
} );
なお add_menu_page() の capability 引数は、メニューを表示する権限です。メニューは admin_menu フックで追加します。それより早いフックで呼ぶと権限エラーになります(公式の記載)。上の add_menu_page の部分のコードは、構文は確認しましたが、画面の表示までは実行していません(未検証)。
WordPress 7.1.2(ja)、PHP 8.2.12 で php run.php is-admin-vs-current-user-can.php を実行しました。購読者(subscriber)のテストユーザーを作って切り替え、最後に削除しています。
is_admin() (CLI default): bool(false)
is_admin() after define(WP_ADMIN): bool(true)
admin manage_options: bool(true)
subscriber is_admin(): bool(true) // 管理画面側という状態でも
subscriber manage_options: bool(false) // 権限はなし
subscriber read: bool(true)
subscriber edit_post(1): bool(false)
role name as cap 'administrator' (admin user): bool(true)
logged-out manage_options: bool(false)
WP_ADMIN 定数を定義して管理画面側のリクエストを模擬すると、購読者でも is_admin() は true、manage_options は false でした。is_admin() が true でも、権限があるとは言えないことが確認できます。なお、ロール名 administrator を渡しても管理者では true になりましたが、公式はロール名での確認を推奨していません。
is_admin() はテーマのカスタマイザーのプレビューでは false を返します。判定には is_customize_preview() を使います(公式の記載)。is_admin() が便利です。「読むかどうか」と「許可するかどうか」を分けて考えます。current_user_can( 'edit_post', $post_id ) のように、第2引数で対象IDを渡します(メタケイパビリティ)。true になります。is_admin() を認可に使う。current_user_can() を書かない。current_user_can() があるか。admin-post.php でも権限とnonceを確認しているか。Q. フロントエンドで is_admin() を使うことはありますか?
A. 「管理画面ではない」条件で読み込み分けをするときに ! is_admin() を使います。
Q. 一番よく使う権限は?
A. 設定画面なら manage_options、投稿編集なら edit_posts や edit_post です。
Q. ユーザーIDで判定してもよいですか?
A. 固定IDで判定すると保守しにくくなります。ケイパビリティで判定してください。
is_admin() という名前は、関数名として紛らわしいと感じます。「場所の判定」と「人の判定」を別物として覚えておけば、権限まわりの事故はかなり減ると考えます。迷ったら、処理の最初に current_user_can() を置いて、失敗したらすぐ終了する形に統一するのがよいと思います。
get_current_user_id() は、現在ログインしているユーザーのIDを返す関数です。
get_current_user_id(): int
引数はありません。
ユーザーID。未ログインなら 0。
if ( get_current_user_id() === 1 ) {
// ユーザーID 1 のときの処理
}
0 を返します。0 が返る。確認せずに使う。0 かどうかだけで判断している。判定には is_user_logged_in() が分かりやすい。init フックより前に呼び、0 になる。NG例
update_user_meta( get_current_user_id(), 'last_seen', time() ); // 未ログインだと、ID 0 に保存される
OK例
$user_id = get_current_user_id();
if ( $user_id ) {
update_user_meta( $user_id, 'last_seen', time() );
}
| やりたいこと | 使うもの |
|---|---|
| 現在のユーザーのID | get_current_user_id() |
| 現在のユーザーのオブジェクト | wp_get_current_user() |
| ログインしているか判定 | is_user_logged_in() |
wp_get_current_user()、is_user_logged_in()
公式リファレンス:get_current_user_id() | Function | WordPress Developer Resources
]]>wp_generate_password() は、ランダムなパスワードを生成する関数です。
wp_generate_password( int $length = 12, bool $special_chars = true, bool $extra_special_chars = false ): string
$length:文字数$special_chars:記号を含めるか$extra_special_chars:さらに追加の記号を含めるか生成したパスワード。
$pass = wp_generate_password( 16, true );
random_bytes() などを検討します。NG例
$pass = wp_generate_password( 4 ); // 短すぎる
OK例
$pass = wp_generate_password( 20, true, false );
$user_id = wp_create_user( 'taro', $pass, '[email protected]' );
| 関数 | 役割 |
|---|---|
wp_generate_password() |
ランダムなパスワードを生成する |
wp_hash_password() |
パスワードを、ハッシュ化する |
wp_check_password() |
平文とハッシュが、一致するかを確認する |
wp_hash_password()、wp_insert_user()
公式リファレンス:wp_generate_password() | Function | WordPress Developer Resources
]]>wp_hash_password() は、パスワードをハッシュ化する関数です。
wp_hash_password( string $password ): string
$password:平文のパスワードハッシュ化した文字列。
$hash = wp_hash_password( 'password' );
wp_check_password() を使わずに、== で比べる。ハッシュは、毎回違う値になる。wp_insert_user() や、wp_update_user() には、平文を渡せば、自動でハッシュ化される(ID を指定した wp_insert_user() の更新では、ハッシュ化されない)。NG例
wp_update_user( array( 'ID' => $id, 'user_pass' => wp_hash_password( $pass ) ) ); // 二重にハッシュ化される
OK例
wp_update_user( array( 'ID' => $id, 'user_pass' => $pass ) ); // 平文を渡すと、自動でハッシュ化される
| 関数 | 役割 |
|---|---|
wp_hash_password() |
パスワードを、ハッシュ化する |
wp_check_password() |
平文とハッシュが、一致するかを確認する |
wp_generate_password() |
ランダムなパスワードを生成する |
wp_check_password()、wp_generate_password()
公式リファレンス:wp_hash_password() | Function | WordPress Developer Resources
]]>wp_check_password() は、平文のパスワードが、保存済みのハッシュと一致するかを確認する関数です。
wp_check_password( string $password, string $hash, string|int $user_id = '' ): bool
$password:平文のパスワード$hash:保存されているハッシュ$user_id:ユーザーID(任意)一致すれば true。
$user = get_userdata( 1 );
$ok = wp_check_password( 'password', $user->user_pass, $user->ID );
== で比べている。ハッシュは、毎回違う値になるため、一致しない。この関数で確認する。md5() など、古い方法で比べている。NG例
if ( $user->user_pass === wp_hash_password( $password ) ) {
// ハッシュは毎回違う値になるため、一致しない
}
OK例
if ( wp_check_password( $password, $user->user_pass, $user->ID ) ) {
// 一致
}
| 関数 | 役割 |
|---|---|
wp_check_password() |
平文のパスワードが、ハッシュと一致するかを確認する |
wp_hash_password() |
パスワードを、ハッシュ化する |
wp_authenticate() |
ユーザー名とパスワードで、認証する |
wp_hash_password()、wp_authenticate()
公式リファレンス:wp_check_password() | Function | WordPress Developer Resources
]]>wp_authenticate() は、ユーザー名とパスワードを検証する関数です。ログインはさせません。
wp_authenticate( string $username, string $password ): WP_User|WP_Error
$username:ユーザー名$password:パスワード認証に成功したら WP_User、失敗したら WP_Error。
$user = wp_authenticate( 'taro', 'password' );
if ( is_wp_error( $user ) ) {
// 認証失敗
}
wp_signon() を使う。WP_Error のときを、考えていない。NG例
wp_authenticate( $name, $pass ); // ログインはされない
OK例
$user = wp_authenticate( $name, $pass );
if ( ! is_wp_error( $user ) ) {
// 認証に成功
}
| 関数 | 役割 |
|---|---|
wp_authenticate() |
認証だけを行う |
wp_signon() |
認証し、ログインする |
wp_check_password() |
パスワードが、ハッシュと一致するかだけを確認する |
wp_signon()、wp_check_password()
公式リファレンス:wp_authenticate() | Function | WordPress Developer Resources
]]>wp_signon() は、ユーザー名とパスワードでログイン処理を行う関数です。
wp_signon( array $credentials = array(), string|bool $secure_cookie = '' ): WP_User|WP_Error
$credentials:user_login、user_password、remember$secure_cookie:SSL専用Cookieにするかログイン成功時は WP_User、失敗時は WP_Error。
$user = wp_signon( array(
'user_login' => 'taro',
'user_password' => 'password',
'remember' => true,
) );
is_wp_error() で確認します。WP_Error のときを、考えていない。認証に失敗すると、エラーが返る。$credentials のキーを間違えている(user_login・user_password・remember)。wp_signon() のあとの、同じリクエストでは、is_user_logged_in() が false のまま。必要なら、wp_set_current_user() も呼ぶ。NG例
$user = wp_signon( array( 'user_login' => $name, 'password' => $pass ) ); // キーが違う
OK例
$user = wp_signon( array(
'user_login' => $name,
'user_password' => $pass,
'remember' => true,
), is_ssl() );
if ( is_wp_error( $user ) ) {
// 認証に失敗
}
| 関数 | 役割 |
|---|---|
wp_signon() |
認証し、ログインする(Cookieも設定) |
wp_authenticate() |
認証だけを行う(ログインはしない) |
wp_set_auth_cookie() |
ログインのCookieを設定する(認証は行わない) |
wp_set_auth_cookie()、wp_authenticate()
公式リファレンス:wp_signon() | Function | WordPress Developer Resources
]]>wp_set_auth_cookie() は、ユーザーの認証Cookieを設定し、ログイン状態にする関数です。
wp_set_auth_cookie( int $user_id, bool $remember = false, bool|string $secure = '', string $token = '' ): void
$user_id:ユーザーID$remember:ログイン状態を保持するか$secure:SSL専用Cookieにするか$token:セッショントークン戻り値はありません。
wp_set_current_user( 5 );
wp_set_auth_cookie( 5 );
headers already sent エラーを避ける)に呼びます。wp_set_current_user() を併せて呼んでいない。そのリクエストの間は、まだログインしていない状態になる。NG例
wp_set_auth_cookie( $user_id ); // 認証なしに、ログイン状態にしている
OK例
$user = get_user_by( 'email', $email );
if ( $user && wp_check_password( $password, $user->user_pass, $user->ID ) ) {
wp_set_current_user( $user->ID );
wp_set_auth_cookie( $user->ID );
}
| 関数 | 役割 |
|---|---|
wp_set_auth_cookie() |
ログインのCookieを設定する(認証は行わない) |
wp_signon() |
認証し、ログインする(Cookieも設定) |
wp_set_current_user() |
そのリクエストの間だけ、現在のユーザーを設定する |
wp_set_current_user()、wp_signon()
公式リファレンス:wp_set_auth_cookie() | Function | WordPress Developer Resources
]]>