webdevqa.jp.net

複数のプラグインディレクトリを追加する

タスク

WPインストールにregister_theme_directory()を使用して、追加のThemesディレクトリを登録登録できます。悲しいことに、coreはプラグインと同じ機能を提供しません。私たちはすでにMUプラグイン、ドロップイン、プラグインそしてテーマを持っています。しかし、私たちはより良いファイル編成のためにもっと必要です。

これが達成するべきタスクのリストです:

  • 追加のプラグインディレクトリを追加する
  • それぞれのプラグインディレクトリに対して、ここに示すように新しい "タブ"が必要です。 [1]
  • 追加のディレクトリは、デフォルトのプラグインディレクトリと同じ機能を持ちます。

あなたのためにそこに何がありますか?

最良かつ最も完全な答えは賞金を授与されます。


[1]新しいプラグインフォルダ/ディレクトリの追加タブ

38
kaiser

さて、私はこれで刺します。途中で私が遭遇したいくつかの制限:

  1. WP_List_Tableのサブクラスには多くのフィルターがありません。少なくとも必要な場所にはありません。

  2. そのようなフィルターの欠如のために、私たちは本当に一番上にプラグインタイプの正確なリストを維持することができません。

  3. また、プラグインをアクティブとして表示するには、いくつかの素晴らしい(read:dirty)JavaScriptハックを使用する必要があります。

私は自分の管理領域コードをクラスの中にラップしたので、私の関数名の前には付けられません。このコードの全部を見ることができます ここ 。貢献してください!

セントラルAPI

連想配列にプラグインディレクトリを含むグローバル変数を設定する、単純な関数です。 $keyは、プラグインなどを取得するために内部的に使用されるものになります。$dirは、フルパスまたはwp-contentディレクトリからの相対パスです。 $labelは管理領域に表示するためのものです(例:翻訳可能な文字列)。

<?php
function register_plugin_directory( $key, $dir, $label )
{
    global $wp_plugin_directories;
    if( empty( $wp_plugin_directories ) ) $wp_plugin_directories = array();

    if( ! file_exists( $dir ) && file_exists( trailingslashit( WP_CONTENT_DIR ) . $dir ) )
    {
        $dir = trailingslashit( WP_CONTENT_DIR ) . $dir;
    }

    $wp_plugin_directories[$key] = array(
        'label' => $label,
        'dir'   => $dir
    );
}

そして、もちろん、プラグインをロードする必要があります。しばらくしてplugins_loadedに接続し、アクティブなプラグインを調べてそれぞれをロードします。

管理エリア

機能をクラス内に設定しましょう。

<?php
class CD_APD_Admin
{

    /**
     * The container for all of our custom plugins
     */
    protected $plugins = array();

    /**
     * What custom actions are we allowed to handle here?
     */
    protected $actions = array();

    /**
     * The original count of the plugins
     */
    protected $all_count = 0;

    /**
     * constructor
     * 
     * @since 0.1
     */
    function __construct()
    {
        add_action( 'load-plugins.php', array( &$this, 'init' ) );
        add_action( 'plugins_loaded', array( &$this, 'setup_actions' ), 1 );

    }

} // end class

私たちは本当に早い段階でplugins_loadedに接続し、使用することになる許可された "アクション"を設定します。組み込み関数ではカスタムディレクトリではできないため、これらはプラグインの有効化と無効化を処理します。

function setup_actions()
{
    $tmp = array(
        'custom_activate',
        'custom_deactivate'
    );
    $this->actions = apply_filters( 'custom_plugin_actions', $tmp );
}

それからload-plugins.phpにフックされた関数があります。これはあらゆる種類の楽しいものを行います。

function init()
{
    global $wp_plugin_directories;

    $screen = get_current_screen();

    $this->get_plugins();

    $this->handle_actions();

    add_filter( 'views_' . $screen->id, array( &$this, 'views' ) );

    // check to see if we're using one of our custom directories
    if( $this->get_plugin_status() )
    {
        add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
        add_filter( 'all_plugins', array( &$this, 'filter_plugins' ) );
        // TODO: support bulk actions
        add_filter( 'bulk_actions-' . $screen->id, '__return_empty_array' );
        add_filter( 'plugin_action_links', array( &$this, 'action_links' ), 10, 2 );
        add_action( 'admin_enqueue_scripts', array( &$this, 'scripts' ) );
    }
}

一度に一つのことを見ていきましょう。 get_pluginsメソッドは、他の関数のラッパーです。属性pluginsにデータを入れます。

function get_plugins()
{
    global $wp_plugin_directories;
    foreach( array_keys( $wp_plugin_directories ) as $key )
    {
       $this->plugins[$key] = cd_apd_get_plugins( $key );
    }
}

cd_apd_get_pluginsは、ハードコードされたget_pluginsおよびpluginsを使わずに、組み込みのWP_CONTENT_DIR関数を破ったものです。基本的には、$wp_plugin_directoriesグローバルからディレクトリを取得して開き、すべてのプラグインファイルを見つけます。後でキャッシュに保存します。

<?php
function cd_apd_get_plugins( $dir_key ) 
{
    global $wp_plugin_directories;

    // invalid dir key? bail
    if( ! isset( $wp_plugin_directories[$dir_key] ) )
    {
        return array();
    }
    else
    {
        $plugin_root = $wp_plugin_directories[$dir_key]['dir'];
    }

    if ( ! $cache_plugins = wp_cache_get( 'plugins', 'plugins') )
        $cache_plugins = array();

    if ( isset( $cache_plugins[$dir_key] ) )
        return $cache_plugins[$dir_key];

    $wp_plugins = array();

    $plugins_dir = @ opendir( $plugin_root );
    $plugin_files = array();
    if ( $plugins_dir ) {
        while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
            if ( substr($file, 0, 1) == '.' )
                continue;
            if ( is_dir( $plugin_root.'/'.$file ) ) {
                $plugins_subdir = @ opendir( $plugin_root.'/'.$file );
                if ( $plugins_subdir ) {
                    while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
                        if ( substr($subfile, 0, 1) == '.' )
                            continue;
                        if ( substr($subfile, -4) == '.php' )
                            $plugin_files[] = "$file/$subfile";
                    }
                    closedir( $plugins_subdir );
                }
            } else {
                if ( substr($file, -4) == '.php' )
                    $plugin_files[] = $file;
            }
        }
        closedir( $plugins_dir );
    }

    if ( empty($plugin_files) )
        return $wp_plugins;

    foreach ( $plugin_files as $plugin_file ) {
        if ( !is_readable( "$plugin_root/$plugin_file" ) )
            continue;

        $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.

        if ( empty ( $plugin_data['Name'] ) )
            continue;

        $wp_plugins[trim( $plugin_file )] = $plugin_data;
    }

    uasort( $wp_plugins, '_sort_uname_callback' );

    $cache_plugins[$dir_key] = $wp_plugins;
    wp_cache_set('plugins', $cache_plugins, 'plugins');

    return $wp_plugins;
}

次は、プラグインを実際にアクティブ化したり非アクティブ化したりするという面倒な仕事です。これを行うには、handle_actionsメソッドを使います。これもまた、コアのwp-admin/plugins.phpファイルの先頭からはっきりと切り取られています。

function handle_actions()
{
    $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : '';

    // not allowed to handle this action? bail.
    if( ! in_array( $action, $this->actions ) ) return;

    // Get the plugin we're going to activate
    $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : false;
    if( ! $plugin ) return;

    $context = $this->get_plugin_status();

    switch( $action )
    {
        case 'custom_activate':
            if( ! current_user_can('activate_plugins') )
                    wp_die( __('You do not have sufficient permissions to manage plugins for this site.') );

            check_admin_referer( 'custom_activate-' . $plugin );

            $result = cd_apd_activate_plugin( $plugin, $context );
            if ( is_wp_error( $result ) ) 
            {
                if ( 'unexpected_output' == $result->get_error_code() ) 
                {
                    $redirect = add_query_arg( 'plugin_status', $context, self_admin_url( 'plugins.php' ) );
                    wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) ) ;
                    exit();
                } 
                else 
                {
                    wp_die( $result );
                }
            }

            wp_redirect( add_query_arg( array( 'plugin_status' => $context, 'activate' => 'true' ), self_admin_url( 'plugins.php' ) ) );
            exit();
            break;
        case 'custom_deactivate':
            if ( ! current_user_can( 'activate_plugins' ) )
                wp_die( __('You do not have sufficient permissions to deactivate plugins for this site.') );

            check_admin_referer('custom_deactivate-' . $plugin);
            cd_apd_deactivate_plugins( $plugin, $context );
            if ( headers_sent() )
                echo "<meta http-equiv='refresh' content='" . esc_attr( "0;url=plugins.php?deactivate=true&plugin_status=$status&paged=$page&s=$s" ) . "' />";
            else
                wp_redirect( self_admin_url("plugins.php?deactivate=true&plugin_status=$context") );
            exit();
            break;
        default:
            do_action( 'custom_plugin_dir_' . $action );
            break;
    }

}

ここでも、カスタム機能がいくつかあります。 cd_apd_activate_pluginactivate_pluginから切り取られた)およびcd_apd_deactivate_pluginsdeactivate_pluginsから切り取られた)どちらもハードコードされたディレクトリを除いてそれぞれの "親"関数と同じです。

function cd_apd_activate_plugin( $plugin, $context, $silent = false ) 
{
    $plugin = trim( $plugin );

    $redirect = add_query_arg( 'plugin_status', $context, admin_url( 'plugins.php' ) );
    $redirect = apply_filters( 'custom_plugin_redirect', $redirect );

    $current = get_option( 'active_plugins_' . $context, array() );

    $valid = cd_apd_validate_plugin( $plugin, $context );
    if ( is_wp_error( $valid ) )
        return $valid;

    if ( !in_array($plugin, $current) ) {
        if ( !empty($redirect) )
            wp_redirect(add_query_arg('_error_nonce', wp_create_nonce('plugin-activation-error_' . $plugin), $redirect)); // we'll override this later if the plugin can be included without fatal error
        ob_start();
        include_once( $valid );

        if ( ! $silent ) {
            do_action( 'custom_activate_plugin', $plugin, $context );
            do_action( 'custom_activate_' . $plugin, $context );
        }

        $current[] = $plugin;
        sort( $current );
        update_option( 'active_plugins_' . $context, $current );

        if ( ! $silent ) {
            do_action( 'custom_activated_plugin', $plugin, $context );
        }

        if ( ob_get_length() > 0 ) {
            $output = ob_get_clean();
            return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
        }
        ob_end_clean();
    }

    return true;
}

そして失活機能

function cd_apd_deactivate_plugins( $plugins, $context, $silent = false ) {
    $current = get_option( 'active_plugins_' . $context, array() );

    foreach ( (array) $plugins as $plugin ) 
    {
        $plugin = trim( $plugin );
        if ( ! in_array( $plugin, $current ) ) continue;

        if ( ! $silent )
            do_action( 'custom_deactivate_plugin', $plugin, $context );

        $key = array_search( $plugin, $current );
        if ( false !== $key ) {
            array_splice( $current, $key, 1 );
        }

        if ( ! $silent ) {
            do_action( 'custom_deactivate_' . $plugin, $context );
            do_action( 'custom_deactivated_plugin', $plugin, $context );
        }
    }

    update_option( 'active_plugins_' . $context, $current );
}

cd_apd_validate_plugin関数もあります。これは、もちろん、ハードコードされたがらくたのないvalidate_pluginからの切り取りです。

<?php
function cd_apd_validate_plugin( $plugin, $context ) 
{
    $rv = true;
    if ( validate_file( $plugin ) )
    {
        $rv = new WP_Error('plugin_invalid', __('Invalid plugin path.'));
    }

    global $wp_plugin_directories;
    if( ! isset( $wp_plugin_directories[$context] ) )
    {
        $rv = new WP_Error( 'invalid_context', __( 'The context for this plugin does not exist' ) );
    }

    $dir = $wp_plugin_directories[$context]['dir'];
    if( ! file_exists( $dir . '/' . $plugin) )
    {
        $rv = new WP_Error( 'plugin_not_found', __( 'Plugin file does not exist.' ) );
    }

    $installed_plugins = cd_apd_get_plugins( $context );
    if ( ! isset($installed_plugins[$plugin]) )
    {
        $rv = new WP_Error( 'no_plugin_header', __('The plugin does not have a valid header.') );
    }

    $rv = $dir . '/' . $plugin;
    return $rv;
}

それで、邪魔にならないように。 リストテーブルの表示について実際に話し始めることができます

ステップ1:テーブルの上部にあるリストにビューを追加します。これは、init関数内でviews_{$screen->id}をフィルタリングすることによって行われます。

add_filter( 'views_' . $screen->id, array( &$this, 'views' ) );

その後、実際のフック関数は$wp_plugin_directoriesをループするだけです。新しく登録されたディレクトリの1つにプラグインがある場合は、それを表示に含めます。

function views( $views )
{
    global $wp_plugin_directories;

    // bail if we don't have any extra dirs
    if( empty( $wp_plugin_directories ) ) return $views;

    // Add our directories to the action links
    foreach( $wp_plugin_directories as $key => $info )
    {
        if( ! count( $this->plugins[$key] ) ) continue;
        $class = $this->get_plugin_status() == $key ? ' class="current" ' : '';
        $views[$key] = sprintf( 
            '<a href="%s"' . $class . '>%s <span class="count">(%d)</span></a>',
            add_query_arg( 'plugin_status', $key, 'plugins.php' ),
            esc_html( $info['label'] ),
            count( $this->plugins[$key] )
        );
    }
    return $views;
}

カスタムプラグインディレクトリページを表示している場合に最初に行う必要があるのは、ビューを再度フィルタ処理することです。正確ではないため、inactiveカウントを取り除く必要があります。必要な場所にフィルタがないことの結果です。もう一度接続してください...

if( $this->get_plugin_status() )
{
    add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
}

そして、ちょっと早い...

function views_again( $views )
{
    if( isset( $views['inactive'] ) ) unset( $views['inactive'] );
    return $views;
}

次に、リストテーブルに表示されていたはずのプラグインを取り除き、それらを私たちのカスタムプラグインに置き換えましょう。 all_pluginsにフックします。

if( $this->get_plugin_status() )
{
    add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
    add_filter( 'all_plugins', array( &$this, 'filter_plugins' ) );
}

既にプラグインとデータを設定しているので(上記のsetup_pluginsを参照)、filter_pluginsメソッドは後で(1)すべてのプラグインのカウントを節約し、(2)リストテーブルのプラグインを置き換えます。

function filter_plugins( $plugins )
{
    if( $key = $this->get_plugin_status() )
    {
        $this->all_count = count( $plugins );
        $plugins = $this->plugins[$key];
    }
    return $plugins;
}

そして今、私たちは一括アクションを殺します。これらは簡単にサポートできますか?

if( $this->get_plugin_status() )
{
    add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
    add_filter( 'all_plugins', array( &$this, 'filter_plugins' ) );
    // TODO: support bulk actions
    add_filter( 'bulk_actions-' . $screen->id, '__return_empty_array' );
}

デフォルトのプラグインアクションのリンクは私たちにはうまくいかないでしょう。その代わりに、(カスタムアクションなどを使って)自分自身を設定する必要があります。 init関数内。

if( $this->get_plugin_status() )
{
    add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
    add_filter( 'all_plugins', array( &$this, 'filter_plugins' ) );
    // TODO: support bulk actions
    add_filter( 'bulk_actions-' . $screen->id, '__return_empty_array' );
    add_filter( 'plugin_action_links', array( &$this, 'action_links' ), 10, 2 );
}

ここで変更されるのは、(1)アクションを変更している、(2)プラグインのステータスをそのままにしている、(3)nonce名を少し変更していることだけです。

function action_links( $links, $plugin_file )
{
    $context = $this->get_plugin_status();

    // let's just start over
    $links = array();
    $links['activate'] = sprintf(
        '<a href="%s" title="Activate this plugin">%s</a>',
        wp_nonce_url( 'plugins.php?action=custom_activate&amp;plugin=' . $plugin_file . '&amp;plugin_status=' . esc_attr( $context ), 'custom_activate-' . $plugin_file ),
        __( 'Activate' )
    );

    $active = get_option( 'active_plugins_' . $context, array() );
    if( in_array( $plugin_file, $active ) )
    {
        $links['deactivate'] = sprintf(
            '<a href="%s" title="Deactivate this plugin" class="cd-apd-deactivate">%s</a>',
            wp_nonce_url( 'plugins.php?action=custom_deactivate&amp;plugin=' . $plugin_file . '&amp;plugin_status=' . esc_attr( $context ), 'custom_deactivate-' . $plugin_file ),
            __( 'Deactivate' )
        );
    }
    return $links;
}

そして最後に、JavaScriptを追加する必要があります。 init関数にもう一度(今回は全部一緒に)。

if( $this->get_plugin_status() )
{
    add_filter( 'views_' . $screen->id, array( &$this, 'views_again' ) );
    add_filter( 'all_plugins', array( &$this, 'filter_plugins' ) );
    // TODO: support bulk actions
    add_filter( 'bulk_actions-' . $screen->id, '__return_empty_array' );
    add_filter( 'plugin_action_links', array( &$this, 'action_links' ), 10, 2 );
    add_action( 'admin_enqueue_scripts', array( &$this, 'scripts' ) );
}

OurJSをエンキューしながら、 "all plugins"の総数の値を取得するためにwp_localize_scriptも使用します。

function scripts()
{
    wp_enqueue_script(
        'cd-apd-js',
        CD_APD_URL . 'js/apd.js',
        array( 'jquery' ),
        null
    );
    wp_localize_script(
        'cd-apd-js',
        'cd_apd',
        array(
            'count' => esc_js( $this->all_count )
        )
    );
}

そしてもちろん、JSはリストテーブルのアクティブ/非アクティブプラグインを正しく表示させるためのほんの一部のニックハックです。また、すべてのプラグインの正しい数をAllリンクに戻します。

jQuery(document).ready(function(){
    jQuery('li.all a').removeClass('current').find('span.count').html('(' + cd_apd.count + ')');
    jQuery('.wp-list-table.plugins tr').each(function(){
        var is_active = jQuery(this).find('a.cd-apd-deactivate');
        if(is_active.length) {
            jQuery(this).removeClass('inactive').addClass('active');
            jQuery(this).find('div.plugin-version-author-uri').removeClass('inactive').addClass('active');
        }
    });
});

まとめ

追加のプラグインディレクトリの実際のロードはかなり面白くありません。リストテーブルを正しく表示することはより難しい部分です。私はそれがどうやって判明したかにまだ完全に満足していません、しかし多分誰かが コードを改良することができます

27
chrisguitarguy

私は個人的にはUIの変更には興味がありませんが、いくつかの理由から、もっと整理されたファイルシステムのレイアウトが大好きです。

そのためには、シンボリックリンクを使用するという方法もあります。

wp-content
    |-- plugins
        |-- acme-widgets               -> ../plugins-custom/acme-widgets
        |-- acme-custom-post-types     -> ../plugins-custom/acme-custom-post-types
        |-- acme-business-logic        -> ../plugins-custom/acme-business-logic
        |-- google-authenticator       -> ../plugins-external/google-authenticator
        |-- rest-api                   -> ../plugins-external/rest-api
        |-- quick-navigation-interface -> ../plugins-external/quick-navigation-interface
    |-- plugins-custom
        |-- acme-widgets
        |-- acme-custom-post-types
        |-- acme-business-logic
    |-- plugins-external
        |-- google-authenticator
        |-- rest-api
        |-- quick-navigation-interface

カスタムプラグインをplugins-customに設定することもできます。これは、プロジェクトのバージョン管理リポジトリの一部にすることもできます。

それから、サードパーティの依存関係をplugins-externalにインストールすることができます(Composer、Gitサブモジュール、あるいはあなたが好むものは何でも)。

その後、追加のディレクトリをスキャンし、見つかった各サブフォルダに対してシンボリックリンクをpluginsに作成する単純なBashスクリプトまたはWP-CLIコマンドを使用できます。

pluginsはまだ雑然としていますが、plugins-customplugins-externalと対話するだけでよいため、問題にはなりません。

追加のn追加ディレクトリへのスケーリングは最初の2つと同じプロセスに従うでしょう。

2
Ian Dunn