remove_role() の使い方|説明・引数・注意点

説明

remove_role() は、ユーザーロールを削除する関数です。

基本構文

remove_role( string $role ): void

引数

  • $role:ロールの識別名

戻り値

戻り値はありません。

使い方(サンプル)

remove_role( 'shop_manager' );

注意点

  • そのロールを持つユーザーがいる場合、権限が失われます。

実務での使いどころ

  • 不要になった、独自のロールを削除するとき。
  • プラグインのアンインストール時に、独自のロールを削除するとき。

よくあるミスと対処

  • WordPress標準のロール(administrator など)を削除し、サイトが壊れる。
  • そのロールを持つユーザーが、いる状態で削除している。ロールを失ったユーザーは、権限が使えなくなる。事前に別のロールへ移す。

NG例

remove_role( 'editor' ); // 標準のロールを削除している

OK例

// uninstall.php
remove_role( 'client' );

使い分け早見表

関数 役割
remove_role() ロールを削除する
add_role() ロールを作る
get_role() ロールを取得する

関連項目

add_role()、get_role()

公式リファレンス:remove_role() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました