メディアギャラリーで独自の絞り込みを追加する


データベースへのクエリーの調整は ajax_query_attachment_args フィルターを使う。
ajax_query_attachments_args – Hook | Developer.WordPress.org

これに加えて、メディアギャラリーのドロップダウンの調整が必要になる。しかし、適当なフックは用意されていないというか、WordPress コアの実装が JavaScript のテンプレートから HTML を生成するという実装になっていて、フックを入れる余地がない。
WordPress/wp-includes/media-template.php at master · WordPress/WordPress

ドロップダウンの選択肢を JavaScript で書き換えるのが一苦労だったが、生成AIならメディアギャラリーの JS コードを解析してカスタマイズする JS が出せるようになった。用途と実装コストに合わせて適宜やっていきましょう。

セレクターを「横取り」する

前に必要があって実装した際は JavaScript で DOM を監視&操作して「スプレッドシート」の選択肢を「横取り」する形で実装した。これが結構骨が折れた。

JS のクラスを拡張する方法でドロップダウンを追加する方法も使える。そちらの方がいいかも。コアのコードをザッと読んだ感じ、できそうには見えなかったが、生成AIが出力したコードで確かにできる。

MutationObserver で監視してオプションを上書きする

検知すべきイベントが二つある。

  1. 「メディアの選択またはアップロード」のモーダルの開閉を検知
  2. 「メディアライブラリ」タブの選択を検知

「ファイルをアップロード」タブか「メディアライブラリータブ」か、タブを切り替えたりすると非表示のタブは DOM がなくなるので二つ監視する。

エンキューする JS のコード例
「未添付」を「横取り」する場合。ラベルのみ書き換える。値まで書き換えるとメディアライブラリーのフィルターで弾かれてバックエンドに何も渡ってこない。

jQuery(($) => {
  $(document).ready(() => {
    // 「未添付」オプションのテキストを上書きする関数
    const overwriteLabel = () =>{
      $('#media-attachment-filters option[value="unattached"]')
        .text('他ユーザーが所有 ');
    }

    // 「メディアの選択またはアップロード」のモーダルが開いたかの監視
    // モーダルが開いていたら、選択肢の追加とタブの表示のイベント監視を実行
    const observer = new MutationObserver(( mutationRecords )=>{
      mutationRecords.forEach((record)=>{
        if( record.attributeName === 'class'
          && record.target.classList.contains('modal-open') ){
            overwriteLabel()
            observeMenuItemBrowse()
        }
      })
    })

    observer.observe( document.body,{ attributes: true } )

    // 「メディアライブラリ」のタブの変化を監視する関数
    // アクティブに変化していたら、選択肢の追加を実行
    const observeMenuItemBrowse = () => {
      const observer = new MutationObserver(( MutationRecord ) => {
        MutationRecord.forEach((record)=>{
          if( record.attributeName === 'class'
            && record.target.classList.contains('active') ){
              overwriteLabel()
          }
        })
      })

      observer.observe( document.getElementById('menu-item-browse'), { attributes: true })
    }

  })
})

クエリーの調整

ようやく ajax_query_attachment_args の出番。

「未添付」 で絞り込まれた時に、別のクエリー―他のユーザーが所有を適用する。

これでメディアライブラリーに他ユーザーが所有する画像のみが一覧表示される。

add_filter(
    'ajax_query_attachments_args',
    function ( $query ){
        if( ! key_exists( 'post_parent', $query ) ) {
            return $query;
        }

        unset( $query['post_parent'] );
        $query['author__not_in'] = array( get_current_user_id() )
        return $query;
    }
);

「スプレッドシート」の 絞り込みを「横取り」するなら、$query['post_mime_type'] の値で分岐させる。

独自のドロップダウンを追加する

生成 AI に指示すると、こういう感じの JS コードを生成してドロップダウンを追加する。

ドロップダウンを追加する JS コード

レイアウトが崩れてしまうので適当にスタイルを当ててやること。

(function ($) {

  const MyFilter = wp.media.view.AttachmentFilters.extend({
    id: 'my-custom-filter',

    createFilters() {
      this.filters = {
        all: {
          text: '指定なし',
          props: {
            own: ''
          },
          priority: 10,
        },

        other_images: {
          text: '他ユーザーが所有',
          props: {
            own: 'others'
          },
          priority: 20,
        },
      };
    },
  });

  const AttachmentBrowser = wp.media.view.AttachmentsBrowser;

  wp.media.view.AttachmentsBrowser =
    AttachmentBrowser.extend({

      createToolbar() {
        AttachmentBrowser.prototype.createToolbar.call(this);

        this.toolbar.set(
          'MyFilter',
          new MyFilter({
            controller: this.controller,
            model: this.collection.props,
            priority: -80,
          }).render()
        );
      }

    });

})(jQuery);
レイアウトを特に指定してないと「タイプで絞り込む」ドロップダウンの直下に追加される。

php に書く ajax_query_attachment_args フィルターはこんな感じ

add_filter(
    'ajax_query_attachments_args',
    function ( $query ){
        if( isset( $_REQUEST['query']['own'] )
           && 'others' === $_REQUEST['query']['own'] ) {
               $query['author__not_in'] = array( get_current_user_id() );
        }

        return $query;
    }
);

underscorejs のライブラリで関数を拡張してオプションを追加するコードも出力されたが、こちらはどうも動かない。

var originalCreateFilters = wp.media.view.AttachmentFilters.Mime.prototype.createFilters;

wp.media.view.AttachmentFilters.Mime.prototype.createFilters = function() {

  // まずは元の選択肢(すべて、画像、音声、動画など)を生成させる
  originalCreateFilters.apply(this, arguments);

  // 既存の this.filters 配列に、独自の選択肢を「追加(追加結合)」する
  _.extend(this.filters, {
      // 独自の選択肢1
      only_pdf: {
        text:  'PDFファイルのみ',
        props: { status: null, type: null, uploadedTo: null, post_mime_type: 'only_pdf' }
      },
...

メディアページのドロップダウン・オプションを追加

メディアライブラリで絞り込めるようになったら、メディアページでも絞り込めた方がいいと思うので、実装例。

いつもの組み合わせ。セレクターを追加して pre_get_posts で絞り込む。

add_action(
    'restrict_manage_posts',
    function ( $post_type ) {
        if ( 'attachment' !== $post_type ) {
            return;
        }
        $queried =  get_query_var( 'owner' ) ?: false;
        $options = array(
            "others" => "他のユーザーが所有"
        );
    ?>
        <select name="owner">
            <option value="">所有者</option>
            <?php
                foreach ( $options as $key => $option ) :
                    $selected = $queried === strval( $key ) ? 'selected' : '';
            ?>
                <option value="<?php echo esc_attr( $key ); ?>" <?php echo esc_attr( $selected ); ?> ><?php echo esc_html( $option ); ?></option>
            <?php endforeach ?>
        </select>
        <?php
        },
        10
);

add_filter(
    'query_vars',
    function ( $qvars ) {
        $qvars[] = 'owner';
        return $qvars;
    }
);

add_action(
    'pre_get_posts',
    function ( $query ) {
        if ( ! is_admin()
            || ! $query->is_main_query()
            || ! isset( $query->query['post_type'] )
            || 'attachment' !== $query->query['post_type'] ) {
                return;
        }
	
        if( 'others' === get_query_var( 'owner' ) ){
            $query->set( 'author', 0 );
            $query->set( 'author__not_in', get_current_user_id() );
        }

        return;
    }
);

絞り込みを組み合わせていると wp-admin/upload.php?mode=list&attachment-filter=mine&m=0&owner=others&filter_action=絞り込み&s&action... のようなURLパラメターになって、ドロップダウン二つで矛盾するような表示になってしまう。気になるならJSで表示を頑張ってください。

media_view_settings フィルター

メディアページのグリッドビューなら、これでオプション追加は一応できる。リストビューだと効かない、エディタ内のメディアライブラリでも効かなくてピンポイントすぎるフィルター。

add_filter(
    'media_view_settings', 
    function ( $settings ) {
        $settings['mimeTypes']['others'] = '他のユーザーが所有';
        return $settings;
    }
);

付録:管理画面 Ajax のバックエンド

任意の処理を追加するには、wp_ajax_{$action} フックを使う。
wp_ajax_{$action} – Hook | Developer.WordPress.org

このフック自体が処理を振り分けるディスパッチャとなっていて、管理画面の既定の処理もこのフックを経由して実行される。

REST API は基底クラスを拡張して登録なので、だいぶ異なる。

今後、変わるかも?

v6.6 あたりから React コンポーネントをベースにしたプラグイン設定ページが作れるようになっている。
How to use WordPress React components for plugin pages | WordPress Developer Blog

この場合は、デフォルトの wp-json/wp/ エンドポイントを使うか、自分で必要なエンドポイントを追加して呼び出すことになり、wp_ajax_{$action} フィルターは経由しない。

管理画面のリビルドも予定されている。

今のところ wp_ajax_{$action} の廃止はロードマップにはない。しかし、もしかしたら、この先は使われないかも。

カテゴリー:

最終更新: