プラグインUser Role Editorのure_attachments_show_full_listフィルタの使用方法・解説

概要

ure_attachments_show_full_listは、WordPressのUser Role Editorプラグインで使用されるフィルタフックです。このフックを利用することで、ユーザーがメディアライブラリ内の添付ファイルのインターフェースをカスタマイズできます。具体的には、ユーザーのロール（役割）に応じて表示されるメディアファイルのリストを制御することができます。

このフィルタは、以下のような機能を実装する際に役立ちます。

特定のユーザーグループに対するメディアライブラリの制限
特定のファイルタイプやカテゴリに基づく表示制御
メディアライブラリのカスタムフィルタの作成
ユーザーが管理できるメディアの数を制御
ユーザーに特定のメディアへのアクセスを提供するための設定
レポートや分析のために、特定のメディアリストを表示

構文

apply_filters( 'ure_attachments_show_full_list', $full_list, $user_id );

パラメータ

$full_list (array): 表示するメディアファイルのリスト。
$user_id (int): 現在のユーザーのID。

戻り値

array: フィルタを適用した後のメディアファイルのリスト。

必要なバージョン

User Role Editor バージョン: 4.0以上
WordPress バージョン: 5.0以上

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプルコード1: 特定のユーザー役割に対するメディア表示制限

add_filter( 'ure_attachments_show_full_list', 'restrict_media_for_editor', 10, 2 );

function restrict_media_for_editor( $full_list, $user_id ) {
    if ( user_can( $user_id, 'editor' ) ) {
        // 編集者には自分がアップロードしたファイルのみを表示
        $full_list = array_filter( $full_list, function( $item ) use ( $user_id ) {
            return $item->post_author == $user_id;
        });
    }
    return $full_list;
}

このコードは、編集者の役割を持つユーザーのためにメディアライブラリをフィルタリングし、彼らがアップロードしたメディアファイルのみを表示します。

サンプルコード2: カスタム条件によるメディア表示の制御

add_filter( 'ure_attachments_show_full_list', 'custom_media_filter', 10, 2 );

function custom_media_filter( $full_list, $user_id ) {
    // 自分のアップロードしたファイルと特定のカテゴリーに属するファイルのみを表示
    $allowed_categories = array( 'images', 'documents' );

    $full_list = array_filter( $full_list, function( $item ) use ( $allowed_categories ) {
        return in_array( get_the_category( $item->ID )[0]->slug, $allowed_categories );
    });

    return $full_list;
}

このコードでは、特定のカテゴリーに属するメディアファイルのみが表示されるように制御しています。

サンプルコード3: メディアファイルのサムネイルをカスタマイズ

add_filter( 'ure_attachments_show_full_list', 'customize_media_thumbnails', 10, 2 );

function customize_media_thumbnails( $full_list, $user_id ) {
    foreach ( $full_list as $item ) {
        $item->thumbnail = wp_get_attachment_image_src( $item->ID, 'medium' );
        // 必要に応じて他の属性も追加
    }
    return $full_list;
}

このコードは、メディアファイルのサムネイル表示をカスタマイズし、中サイズのサムネイルを設定します。

サンプルコード4: メディアリストの表示順序を変更

add_filter( 'ure_attachments_show_full_list', 'sort_media_attachments', 10, 2 );

function sort_media_attachments( $full_list, $user_id ) {
    usort( $full_list, function( $a, $b ) {
        return strtotime( $b->post_date ) - strtotime( $a->post_date ); // 最新のものを先に
    });
    return $full_list;
}

このコードはメディアファイルをアップロード日時の新しい順に並べ替えます。

サンプルコード5: 特定のファイルタイプのフィルタリング

add_filter( 'ure_attachments_show_full_list', 'filter_by_file_type', 10, 2 );

function filter_by_file_type( $full_list, $user_id ) {
    $allowed_types = array( 'image/jpeg', 'image/png' ); // JPEGとPNGファイルのみ表示

    $full_list = array_filter( $full_list, function( $item ) use ( $allowed_types ) {
        return in_array( get_post_mime_type( $item->ID ), $allowed_types );
    });

    return $full_list;
}

このコードは、ユーザーに対してJPEGおよびPNGファイルのみを表示します。

概要

構文