C'è un modo per un plug-in di ottenere il proprio numero di versione?

8

Esiste un'API che posso chiamare, all'interno del mio plug-in, per determinare la versione del plug-in?

Voglio solo che il mio plug-in emetta un commento HTML con il proprio numero di versione ... a fini diagnostici.

plugin-development

— David G
fonte

9

@david : Sia @Adam Backtrom che @ Viper007Bond danno alcuni buoni consigli, quindi ho pensato di seguire i loro consigli e vedere se non potevo implementare qualcosa, vedi sotto.

Ciò che segue è un plug-in chiamato WP Active Plugins Data che analizza i metadati di intestazione per tutti i plug-in attivi ogni volta che viene attivato un plug-in e memorizza tutti i metadati per ciascun plug-in in un'opzione di array in wp_options. L'ho progettato sia per i normali plug-in WordPress che per i plug-in multisito del sito. Puoi scaricarlo qui da gist ma ho anche copiato il codice qui per la tua recensione:

<?php
/*
Plugin Name: WP Active Plugins Data
Plugin URI: http://mikeschinkel.com/wordpress-plugins/wp-active-plugins-data/
Description: Loads Plugin Data on Plugin Activation and Persists to wp_options for quick retrieval.
Version: 0.1
Author: Mike Schinkel
Author URI: http://mikeschinkel.com
Note: Written for http://wordpress.stackexchange.com/questions/361/is-there-a-way-for-a-plug-in-to-get-its-own-version-number
*/

require_once(ABSPATH.'wp-admin/includes/plugin.php');

function get_active_plugin_version($plugin_path_file, $sitewide = false) {
    return get_active_plugin_attribute($plugin_path_file,'Version');
}
function get_active_plugin_attribute($plugin_path_file, $attribute) {
    $all_plugins_data = get_active_plugins_data($plugin_path_file,$sitewide);
    return (isset($all_plugins_data[$attribute]) ? $all_plugins_data[$attribute] : false);
}
function get_active_plugins_data($plugin_path_file, $sitewide = false) {
    $failsafe = false;
    $plugin = plugin_basename(trim($plugin_path_file));
    $sitewide = (is_multisite() && ( $sitewide || is_network_only_plugin($plugin)));
    if ($sitewide) {
        $all_plugins_data = get_site_option('active_sitewide_plugin_data',array());
    } else {
        $all_plugins_data = get_option('active_plugin_data',array());
    }
    if (!$failsafe && !is_array($all_plugins_data) || count($all_plugins_data)==0) {
        $failsafe = true; // Don't risk infinite recursion
        if ($sitewide) {
            $active_plugins = get_site_option('active_sitewide_plugins',array());
        } else {
            $active_plugins = get_option('active_plugins',array());
        }
        persist_active_plugin_data(null,$active_plugins,$sitewide);
        $all_plugins_data = get_active_plugin_version($plugin_path_file,$sitewide);
    }
    return $all_plugins_data[$plugin_path_file];
}
add_action('update_site_option_active_sitewide_plugins','persist_sitewide_active_plugin_data',10,2);
function persist_sitewide_active_plugin_data($option, $plugins) {
    persist_active_plugin_data(null,$plugins,'sitewide');
}
add_filter('update_option_active_plugins','persist_active_plugin_data',10,2);
function persist_active_plugin_data($old_plugins, $new_plugins, $sitewide=false) {
    $active_plugin_data = array_flip($new_plugins);
    $plugin_dir = WP_PLUGIN_DIR;
    foreach($new_plugins as $plugin) {
        $active_plugin_data[$plugin] = get_plugin_data("$plugin_dir/$plugin");
    }
    if ($sitewide)
        update_site_option('active_sitewide_plugin_data',$active_plugin_data);
    else
        update_site_option('active_plugin_data',$active_plugin_data);
}

Vuoi vedere come funziona? Ecco un file di prova che puoi inserire nella radice del tuo sito WordPress ( http://example.com/test.php.) Assicurati di aver attivato sia questo plugin che Akismet prima di testarlo.

<?php
/*
* test.php - Place in root of WordPress website.
*
* Before running be sure to activate both Akismet and the WP Active Plugin Data plugin
*
*/

include "wp-load.php";

header('Content-type:text/plain');
$akismet = "akismet/akismet.php";
echo "Akismet Version: " . get_active_plugin_version($akismet);
echo "\n\nAkismet Description: " . get_active_plugin_attribute($akismet,'Description');
echo "\n\nAll Akismet Data:\n";
print_r(get_active_plugins_data($akismet));

Se non è esattamente ciò di cui hai bisogno, dovrebbe darti un buon punto di partenza. Spero che sia di aiuto.

— MikeSchinkel
fonte

+1. Bel lavoro, Mike. Mi chiedo quanti plugin usciranno da questo StackExchange. :)

— Annika Backstrom,

Grazie. In realtà, spero tanto, ma spero anche che solo i migliori possano entrare nel repository. C'è troppa spazzatura lassù in questo momento!

— MikeSchinkel,

2

Puoi analizzare i metadati del tuo plugin (quella roba nella parte superiore del file), ma è meglio per le prestazioni se hai appena impostato la tua variabile PHP con un numero di versione corrispondente. Quando aggiorni il plugin, aggiorna entrambi i numeri di versione.

È leggermente più lavoro per te a breve termine, ma molto meglio a lungo termine.

— Viper007Bond
fonte

Potrebbe essere meglio per le prestazioni definire solo una variabile, ma non è anche molto piacevole cambiare il numero di versione in 2 posizioni. Per i temi, esiste una funzione simile wp_get_theme che viene persino utilizzata negli esempi: codex.wordpress.org/Child_Themes Sembra un cattivo design in WordPress, sarebbe meglio se potessimo impostare la versione del plugin attraverso una variabile e riutilizzare il variabile con le funzioni wp_enqueue_style e wp_enqueue_script.

— Baptx

questo è corretto, tuttavia, questa è un'ottimizzazione sarebbe trascurabile considerando tutto ciò che Wordpress fa su ogni richiesta. In altre parole, non importa

— paulcol.

1

C'è nelle schermate di amministrazione: get_plugin_data(). Nei template, penso che avrai bisogno del plugin per conservare quei dati in PHP, ad esempio, impostare una costante o globale o qualcosa del genere e mantenere quel valore sincronizzato con il numero di versione dell'intestazione del plugin.

wp-settings.phpchiamate wp_get_active_and_valid_plugins(), che estrae i dati active_pluginsdall'opzione sito. Questa opzione contiene solo il percorso del file del plug-in e wp-settings.phpviene eseguita solo include_oncesul file, quindi non viene mai analizzata per i metadati del plug-in.

— Annika Backstrom
fonte