Adicionar vários diretórios de plugins


39

A tarefa

Você pode registrar adicionar diretórios de Temas adicionais usando register_theme_directory()a instalação do WP. Infelizmente, o núcleo não oferece a mesma funcionalidade para plugins. Já temos MU-Plugin, Drop-Ins, Plugins e Temas. Mas precisamos de mais para uma melhor organização de arquivos.

Aqui está a lista de tarefas a serem realizadas:

  • Adicionar um diretório de plug-in adicional
  • Para cada diretório de plug-in, é necessária uma nova "guia", como mostrado aqui [1]
  • O diretório adicional teria a mesma funcionalidade que o diretório de plug-ins padrão

O que há para você?

A melhor e mais completa resposta receberá uma recompensa.


[1] Guia adicional para uma nova pasta / diretório de plugins


3
Como a estrutura de diretórios está bastante ligada às constantes do diretório, tenho dúvidas de que isso seja prático no nível do sistema de arquivos (sem a adoção principal). A camada virtual da organização no administrador pode ser mais fácil de alcançar no nível da extensão.
Rarst

@Rarst que não deve segurar você de volta da adição de seus pensamentos :)
kaiser

Isso seria um ótimo recurso.
ltfishie

O recurso parece bom. Só preciso reverter o núcleo da engenharia, descobrir como isso deve ser feito (da maneira WP) e enviar um patch para os Devs ... você gostaria de olhar para register_theme_directory () - search_theme_directories () - get_raw_theme_root () - get_theme_roots () - get_theme () - get_themes ()
Sterling Hamilton

2
Caras: Enviar o que ? Esta é uma pergunta, não uma resposta com o código completo :) FYI: Um novo ticket no trac para reescreverget_themes() em uma classe.
kaiser

Respostas:


28

Ok, vou dar uma facada nisso. Algumas limitações que encontrei ao longo do caminho:

  1. Não há muitos filtros nas subclasses de WP_List_Table, pelo menos não onde precisamos deles.

  2. Devido a essa falta de filtros, não podemos manter uma lista precisa dos tipos de plug-ins na parte superior.

  3. Também precisamos usar alguns hacks JavaScript impressionantes (leia-se: sujos) para exibir plug-ins como ativos.

Coloquei meu código de área de administrador em uma classe, para que meus nomes de função não sejam prefixados. Você pode ver todo esse código aqui . Por favor contribua!

API central

Apenas uma função simples que configura uma variável global que contém nossos diretórios de plugins em um array associativo. O $keyque vai ser algo usado internamente para buscar plugins, etc. $diré um caminho ou algo completo em relação ao wp-contentdiretório. $labelserá para nossa exibição na área de administração (por exemplo, uma string traduzível).

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

Então, é claro, precisamos carregar os plugins. Conecte-se plugins_loadedtarde e analise os plug-ins ativos, carregando cada um.

Área de administração

Vamos configurar nossa funcionalidade dentro de uma classe.

<?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

Vamos nos conectar plugins_loadedmuito cedo e configurar as "ações" permitidas que usaremos. Eles manipularão a ativação e desativação de plug-ins, pois as funções internas não podem fazê-lo com diretórios personalizados.

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

Depois, há a função conectada load-plugins.php. Isso faz todo tipo de coisa divertida.

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

Vamos passar por uma coisa de cada vez. o get_pluginsmétodo, é um invólucro em torno de outra função. Ele preenche o atributo pluginscom dados.

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é uma parte da get_pluginsfunção incorporada sem os códigos WP_CONTENT_DIRe os pluginsnegócios. Basicamente: obtenha o diretório $wp_plugin_directoriesglobal, abra-o, encontre todos os arquivos de plug-in. Armazene-os no cache para mais tarde.

<?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;
}

A seguir, é o negócio incômodo de realmente ativar e desativar plugins. Para fazer isso, usamos o handle_actionsmétodo Isso é, novamente, flagrantemente arrancado da parte superior do wp-admin/plugins.phparquivo principal .

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

}

Algumas funções personalizadas aqui novamente. cd_apd_activate_plugin(roubado de activate_plugin) e cd_apd_deactivate_plugins(roubado de deactivate_plugins). Ambos são iguais às suas respectivas funções "pai" sem os diretórios codificados.

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

E a função de desativação

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

Também existe uma cd_apd_validate_pluginfunção, a qual, é claro, é um roubo, validate_pluginsem o lixo codificado.

<?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;
}

Tudo bem, com isso fora do caminho. Na verdade, podemos começar a falar sobre a exibição da tabela da lista

Etapa 1: adicione nossas visualizações à lista na parte superior da tabela. Isso é feito filtrando views_{$screen->id}dentro de nossa initfunção.

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

Em seguida, a função de gancho real apenas percorre o $wp_plugin_directories. Se um dos diretórios recém-registrados tiver plug-ins, nós o incluiremos na exibição.

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

A primeira coisa que precisamos fazer se estiver visualizando uma página de diretório de plugins personalizada é filtrar as visualizações novamente. Precisamos nos livrar da inactivecontagem, porque não será preciso. Uma conseqüência de não haver filtros onde precisamos deles. Ligue novamente ...

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

E uma rápida desabilitação ...

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

Em seguida, vamos nos livrar dos plugins que você teria visto na tabela de lista e substituí-los por nossos plugins personalizados. Engate all_plugins.

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

Como já configuramos nossos plugins e dados (veja setup_pluginsacima), o filter_pluginsmétodo just (1) salva a contagem de todos os plugins para mais tarde e (2) substitui os plugins na tabela de lista.

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

E agora vamos matar as ações em massa. Estes poderiam ser facilmente suportados, suponho?

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

Os links de ações padrão do plug-in não funcionarão para nós. Então, em vez disso, precisamos configurar nossos próprios (com as ações personalizadas, etc). Na initfunção.

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

As únicas coisas que são alteradas aqui são (1) estamos alterando as ações, (2) mantendo o status do plug-in e (3) alterando um pouco os nomes dos 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;
}

E, finalmente, precisamos enfileirar um pouco de JavaScript para completar. Na initfunção novamente (todos juntos desta vez).

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

Ao enfileirar nosso JS, também usaremos wp_localize_scriptpara obter o valor da contagem total de "todos os plugins".

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

E, é claro, o JS é apenas alguns truques legais para fazer com que a tabela da lista seja exibida corretamente. Também colocaremos a contagem correta de todos os plug-ins no Alllink.

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

Embrulhar

O carregamento real de diretórios de plug-ins adicionais é bastante desinteressante. Conseguir que a tabela da lista seja exibida corretamente é a parte mais difícil. Ainda não estou completamente satisfeito com o resultado, mas talvez alguém possa melhorar o código


1
Impressionante! Realmente bom trabalho. Levarei algum tempo no fim de semana para estudar seu código. Nota: Existe uma função __return_empty_array().
fuxia

Obrigado! O feedback é sempre bem-vindo. Incorporou a __return_empty_arrayfunção!
chrisguitarguy

1
Você deve coletar uma lista de todos os locais em que um simples filtro principal teria economizado uma função separada. E então ... envie um ticket Trac.
Fuxia

Isso é realmente ótimo. Seria ainda mais legal se pudéssemos isso como uma biblioteca dentro de um tema (ver o meu comentário no Github: github.com/chrisguitarguy/WP-Plugin-Directories/issues/4 )
julien_c

1
+1 Não posso acreditar que eu tenha perdido essa resposta - ótimo trabalho! Examinarei seu código com mais detalhes no final de semana :). @Julien_c - por que você usaria isso dentro de um tema?
Stephen Harris

2

Pessoalmente, não tenho nenhum interesse em modificar a interface do usuário, mas adoraria um layout mais organizado do sistema de arquivos, por vários motivos.

Para esse fim, outra abordagem seria usar links simbólicos.

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

Você pode configurar seus plugins personalizados plugins-custom , que podem fazer parte do repositório de controle de versão do seu projeto.

Em seguida, você pode instalar dependências de terceiros no plugins-external (via sub-módulos Composer ou Git, ou o que você preferir).

Em seguida, você pode ter um script Bash simples ou um comando WP-CLI que varre os diretórios adicionais e cria um link simbólico pluginspara cada subpasta encontrada.

pluginsainda estaria confuso, mas isso não importaria, porque você só precisaria interagir com plugins-custome plugins-external.

Escalar para ndiretórios extras seguiria o mesmo processo que os dois primeiros.


-3

Ou você também pode usar o COMPOSER com o caminho do diretório personalizado definido para apontar para a pasta wp-content. Se não for uma resposta direta da sua pergunta, é uma nova maneira de pensar no wordpress, vá para o compositor antes que ele o consuma.


Concluído a mudança para o Composer há muito tempo. Por favor, procure a data desta pergunta. Além disso: Esta não é realmente uma resposta. Talvez mostre como realmente configurar isso?
Kaiser
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.