Завдання

Ви можете зареєструвати додавання додаткових каталогів Теми, використовуючи register_theme_directory()для своєї установки WP. На жаль ядро ​​не постачає однакові функції для плагінів. У нас уже є MU-Plugin, Drop-Ins, Plugins та Themes. Але нам потрібно більше для кращої організації файлів.

Ось перелік завдань для досягнення:

• Додайте додатковий каталог плагінів
• Для кожного каталогу плагінів потрібна нова "вкладка", як показано тут ^[1]
• Додатковий каталог матиме таку ж функціональність, як і каталог каталогів плагінів за замовчуванням

Що там у вас?

Найкращу та найповнішу відповідь буде нагороджено щедротою.

^{[1] Додаткова вкладка для нової папки / каталогу плагінів}

Гаразд, я зроблю цей удар. Деякі обмеження, з якими я стикався по дорозі:

1. У підкласах WP_List_Table не дуже багато фільтрів, принаймні немає там, де вони нам потрібні.

2. Через відсутність фільтрів ми не можемо підтримувати точний список типів плагінів у верхній частині.

3. Ми також повинні використовувати деякі дивовижні (читання: брудні) хакі 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функції без жорсткого коду WP_CONTENT_DIRта pluginsбізнесу. В основному: дістаньте каталог з $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_plugin(вирваний з activate_plugin) і cd_apd_deactivate_plugins(вирваний з deactivate_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: додайте наші погляди до списку вгорі таблиці. Це робиться шляхом фільтрації views_{$screen->id}всередині нашої initфункції.

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

Тоді фактична функція гачка просто проходить цикл через $wp_plugin_directories. Якщо в одному із зареєстрованих каталогів є плагіни, ми включимо його у вікно.

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метод just (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) трохи змінюєш імена ніколи.

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' ) );
}

Під час опитування на нашому JS, ми також використаємо 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');
        }
    });
});

Згорнути

Фактичне завантаження додаткових каталогів плагінів є досить незвичним. Правильне відображення таблиці списків є складнішою частиною. Я все ще не повністю задоволений тим, як виявилося, але, можливо, хтось може вдосконалити код

Я особисто не маю інтересу до зміни інтерфейсу користувача, але я б хотів більш організований макет файлової системи з кількох причин.

З цією метою іншим підходом було б використання символьних посилань.

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 підмодулі, або що завгодно більше).

Тоді у вас може бути простий скрипт Bash або команда WP-CLI, яка сканує додаткові каталоги та створює символьне посилання pluginsдля кожної знайденої підпапки.

pluginsвсе ще буде захаращено, але це не має значення, тому що вам потрібно буде лише взаємодіяти з plugins-customі plugins-external.

Масштабування nдодаткових каталогів відбуватиметься за тим самим процесом, що і перші два.

Або ви також можете використовувати КОМПОЗИЦІЙ зі спеціальним шляхом до каталогу, встановленим для вказівки на папку wp-content. Якщо це не пряма відповідь на ваше запитання - це новий спосіб мислення wordpress, перейдіть до композитора, перш ніж він з'їсть вас.