WordPressのcurrent_user_can関数の使い方

最終更新日: 2022/02/05

WordPressのcurrent_user_can関数の使い方を説明しています。指定できるパラメータや返り値、使用例も紹介しています。

current_user_can関数とは？

現在のユーザーが指定した権限を持つかどうかを返す関数です。

構文

current_user_can関数は以下のように記述します。

current_user_can( $capability, $args )

パラメータ

current_user_can関数では2つのパラメータを指定できます。

$capability

権限名を指定します。必須です。

$capabilityに権限グループ（管理者/編集者/投稿者/寄稿者/購読者）を指定することもできますが、意図しない結果を返す場合があります。

$args

$post_idなど追加のパラメータを指定します。省略可能です。

返り値

現在のユーザーが指定した権限を持っている場合はtrue、持っていない場合はfalseを返します。

current_user_can関数の使い方

current_user_can関数を使用し、現在のユーザーが記事の編集権限を持つかどうかを判定する方法を解説します。

権限を指定する

current_user_can関数のパラメータとして記事の編集権限を表す「edit_posts」を指定します。

文字列なのでシングルクォーテーションでパラメータを囲みます。

current_user_can( 'edit_posts' )

IF文の条件式に指定する

IF文の条件式としてcurrent_user_can関数を指定することで現在のユーザーが権限を持っているかどうか判定することができます。

if( current_user_can( 'edit_posts' ) ){
    //記事の編集権限を持つユーザーに対する処理
}

current_user_can関数の使用例

current_user_can関数の使用例をご紹介します。

対応バージョン

WordPress 2.0.0以降

ソースコード

current_user_can関数は「wp-includes/capabilities.php」内で定義されています。