add_role()


WordPress関数add_role()は、カスタムのユーザー役割を登録するために使用されます。この関数を使用することで、特定の権限を持つカスタムユーザーグループを作成できます。

シンタックス

add_role( string $role, string $display_name, array $capabilities = array() );

引数の説明:

  • $role (string) — 登録する役割のスラッグ名（例: ‘editor’、’subscriber’など）。
  • $display_name (string) — 管理画面に表示される役割名。
  • $capabilities (array) — ユーザーに割り当てる権限の配列。

例 1: カスタム役割の追加

以下のコードは、「カスタム編集者」という役割を作成し、投稿の編集権限を割り当てます。

<?php
add_role( 'custom_editor', 'カスタム編集者', array(
    'read' => true,
    'edit_posts' => true,
    'edit_pages' => false,
) );
?>

例 2: 権限なしの役割作成

空の権限を持つ役割を作成します。

<?php
add_role( 'guest', 'ゲスト', array() );
?>

例 3: 管理者専用の役割作成

すべての権限を持つ役割を作成します。

<?php
add_role( 'super_admin', 'スーパーユーザー', array(
    'read' => true,
    'edit_posts' => true,
    'delete_posts' => true,
    'manage_options' => true,
) );
?>

例 4: 役割の存在チェック

特定の役割が登録されているかどうかを確認します。

<?php
if ( get_role( 'custom_editor' ) ) {
    echo 'カスタム編集者は既に存在します。';
}
?>

例 5: 役割の削除

作成した役割を削除する場合のコード例です。

<?php
remove_role( 'guest' );
?>

注意事項

  • add_role()を使用する際は、役割のスラッグが他と競合しないように注意してください。
  • 既存の役割を上書きする場合はremove_role()を使用してから再登録してください。
  • 役割の権限はcurrent_user_can()関数でチェックできます。

関連機能：