Aggiungi più directory di plugin


39

L'obiettivo

È possibile registrare aggiungere ulteriori directory di temi da utilizzare register_theme_directory()per l'installazione di WP. Purtroppo core non offre le stesse funzionalità per i plugin. Abbiamo già plugin MU, drop-in, plugin e temi. Ma abbiamo bisogno di più per una migliore organizzazione dei file.

Ecco l'elenco delle attività da svolgere:

  • Aggiungi una directory plugin aggiuntiva
  • Per ogni directory dei plugin, è necessaria una nuova "scheda" come mostrato qui [1]
  • La directory aggiuntiva avrebbe le stesse funzionalità della directory di plugin predefinita

Cosa c'è lì dentro per te?

Alla risposta migliore e più completa verrà assegnato un premio.


[1] Scheda aggiuntiva per una nuova cartella / directory plugin


3
Poiché la struttura delle directory è piuttosto legata alle costanti delle directory, ho dubbi sul fatto che farlo a livello di file system sia pratico (senza l'adozione del core). Il livello virtuale di organizzazione in admin potrebbe essere più facile da raggiungere a livello di estensione.
Rarst

@Rarst Che non dovrebbe tenere si torna di aggiungere i vostri pensieri :)
kaiser

Questa sarebbe una grande caratteristica.
ltfishie

La funzionalità suona bene. Ho solo bisogno di invertire il core ingegnere, capire come dovrebbe essere fatto (il modo WP) e quindi inviare una patch agli sviluppatori ... vorresti dare un'occhiata a register_theme_directory () - search_theme_directories () - get_raw_theme_root () - get_theme_roots () - get_theme () - get_themes ()
Sterling Hamilton

2
Ragazzi: Invia cosa ? Questa è una domanda, non una risposta con codice completo :) FYI: un nuovo biglietto su trac da riscrivereget_themes() in una classe.
Kaiser

Risposte:


28

Va bene, mi prenderò una pugnalata. Alcune limitazioni che ho riscontrato lungo la strada:

  1. Non ci sono molti filtri nelle sottoclassi di WP_List_Table, almeno non dove ne abbiamo bisogno.

  2. A causa della mancanza di filtri, non possiamo davvero mantenere un elenco accurato di tipi di plugin nella parte superiore.

  3. Dobbiamo anche usare alcuni fantastici (leggi: sporchi) hack JavaScript per visualizzare i plugin come attivi.

Ho racchiuso il mio prefisso amministrativo in una classe, quindi i nomi delle mie funzioni non hanno il prefisso. Puoi vedere tutto questo codice qui . Per favore, contribuisci!

API centrale

Solo una semplice funzione che imposta una variabile globale che conterrà le nostre directory di plugin in un array associativo. La $keysta per essere qualcosa di usato internamente per andare a prendere i plugin, ecc $diro è un percorso o qualcosa di completo relativo alla wp-contentdirectory. $labelsarà per il nostro display nell'area di amministrazione (es. una stringa traducibile).

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

Quindi, ovviamente, dobbiamo caricare i plugin. Aggancia plugins_loadedtardi e passa attraverso i plugin attivi, caricandoli ciascuno.

Area di amministrazione

Impostiamo la nostra funzionalità all'interno di una 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

Ci collegheremo plugins_loadedmolto presto e creeremo le "azioni" consentite che useremo. Gestiranno l'attivazione e la disattivazione dei plug-in in quanto le funzioni integrate non possono farlo con le directory personalizzate.

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

Quindi c'è la funzione agganciata load-plugins.php. Questo fa ogni sorta di cose divertenti.

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

Esaminiamo quella cosa alla volta. il get_pluginsmetodo è un wrapper attorno a un'altra funzione. Riempie l'attributo pluginscon i dati.

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è un frammento della get_pluginsfunzione integrata senza hardcoded WP_CONTENT_DIRe pluginsbusiness. Fondamentalmente: ottieni la directory dal $wp_plugin_directoriesglobale, aprila, trova tutti i file del plugin. Conservali nella cache per dopo.

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

Il prossimo è il fastidioso compito di attivare e disattivare i plugin. Per fare questo, usiamo il handle_actionsmetodo. Questo è, ancora una volta, palesemente strappato dalla cima del wp-admin/plugins.phpfile core .

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

}

Un paio di funzioni personalizzate di nuovo qui. cd_apd_activate_plugin(strappato da activate_plugin) e cd_apd_deactivate_plugins(strappato da deactivate_plugins). Entrambi sono uguali alle rispettive funzioni "parent" senza le directory hard coded.

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 la funzione di disattivazione

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

C'è anche la cd_apd_validate_pluginfunzione, che ovviamente è una fregatura validate_pluginsenza la spazzatura hard coded.

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

Va bene, con quello fuori mano. Possiamo effettivamente iniziare a parlare della visualizzazione della tabella elenco

Passaggio 1: aggiungi le nostre visualizzazioni all'elenco nella parte superiore della tabella. Questo viene fatto filtrando views_{$screen->id}all'interno della nostra initfunzione.

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

Quindi la funzione reale agganciata scorre semplicemente attraverso $wp_plugin_directories. Se una delle directory appena registrate ha plugin, lo includeremo nel display.

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

La prima cosa che dobbiamo fare se ci capita di visualizzare una pagina della directory del plug-in personalizzata è filtrare nuovamente le visualizzazioni. Dobbiamo liberarci del inactiveconteggio perché non sarà accurato. Una conseguenza della mancanza di filtri dove ne abbiamo bisogno. Aggancia di nuovo ...

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

E un rapido disinserimento ...

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

Successivamente, eliminiamo i plug-in che altrimenti avresti visto nella tabella degli elenchi e li sostituiamo con i nostri plug-in personalizzati. Agganciare all_plugins.

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

Poiché abbiamo già impostato i nostri plug-in e dati (vedi setup_pluginssopra), il filter_pluginsmetodo (1) salva il conteggio su tutti i plug-in per i successivi e (2) sostituisce i plug-in nella tabella elenco.

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

E ora uccideremo le azioni in blocco. Questi potrebbero essere facilmente supportati, suppongo?

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

I collegamenti alle azioni predefinite del plug-in non funzioneranno per noi. Quindi, invece, dobbiamo impostare il nostro (con le azioni personalizzate, ecc.). Nella initfunzione.

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

Le uniche cose che vengono cambiate qui sono (1) stiamo cambiando le azioni, (2) mantenendo lo stato del plugin e (3) cambiando un po 'i nomi dei 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 infine, dobbiamo solo accodare un po 'di JavaScript per completarlo. Di initnuovo nella funzione (tutti insieme questa volta).

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

Mentre accodiamo il nostro JS, useremo anche wp_localize_scriptper ottenere il valore del conteggio totale di "tutti i plugin".

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, naturalmente, JS è solo un bel trucco per far visualizzare correttamente i plugin attivi / inattivi della tabella delle liste. Inseriremo anche il conteggio corretto di tutti i plugin nel 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');
        }
    });
});

Incartare

Il caricamento effettivo di ulteriori directory di plug-in è abbastanza poco emozionante. Far visualizzare correttamente la tabella degli elenchi è la parte più difficile. Non sono ancora completamente soddisfatto di come è venuto fuori, ma forse qualcuno può migliorare il codice


1
Impressionante! Davvero un ottimo lavoro. Mi prenderò del tempo durante il fine settimana per studiare il tuo codice. Nota: esiste una funzione __return_empty_array().
fuxia

Grazie! Il feedback è sempre il benvenuto. Incorporata la __return_empty_arrayfunzione!
chrisguitarguy,

1
Dovresti raccogliere un elenco di tutti i luoghi in cui un semplice filtro core ti avrebbe salvato una funzione separata. E poi ... invia un biglietto Trac.
fuxia

Questo è davvero fantastico. Sarebbe ancora più bello se potessimo farlo come libreria all'interno di un tema (vedi il mio commento su Github: github.com/chrisguitarguy/WP-Plugin-Directories/issues/4 )
julien_c

1
+1 Non posso credere di aver perso questa risposta - ottimo lavoro! Esaminerò il tuo codice in modo più dettagliato durante il fine settimana :). @Julien_c - perché dovresti usarlo all'interno di un tema?
Stephen Harris,

2

Personalmente non ho alcun interesse a modificare l'interfaccia utente, ma mi piacerebbe un layout di file system più organizzato, per diversi motivi.

A tal fine, un altro approccio sarebbe quello di utilizzare i collegamenti simbolici.

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

È possibile configurare i plug-in personalizzati plugins-custom, che potrebbero far parte del repository di controllo versione del progetto.

Quindi è possibile installare dipendenze di terze parti in plugins-external(tramite Composer, o sottomoduli Git, o qualunque cosa tu preferisca).

Quindi potresti avere un semplice script Bash o un comando WP-CLI che analizza le directory aggiuntive e crea un collegamento simbolico pluginsper ogni sottocartella che trova.

pluginssarebbe ancora ingombra, ma non importa perché avresti solo bisogno di interagire con plugins-custome plugins-external.

Il ridimensionamento in ndirectory aggiuntive seguirà lo stesso processo delle prime due.


-3

In alternativa, è possibile utilizzare COMPOSER con il percorso della directory personalizzato impostato per puntare alla cartella wp-content. Se non è una risposta diretta alla tua domanda è un nuovo modo di pensare wordpress, passa al compositore prima che ti divori.


Mi sono trasferito a Composer molto tempo fa. Si prega di cercare la data di questa domanda. A parte questo: questa non è davvero una risposta. Forse mostrare come configurarlo?
Kaiser
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.