Tak již je to nějakou dobu co jsem psal článek o přidání svého prvního pluginu do oficiálního wordpress repositáře. V článku jsem taktéž zmínil, že proberu postupně základní kroky, které jsou nutné k vytvoření pluginu a potom vložení do repositáře. Tak že je tu úplně první díl, tohoto návodu. V tomto díle probereme velice důležitou část a to je hlavička samotného pluginu.
Hlavička pluginu je velice důležitá, jelikož sděluje důležité informace, které se zobrazují v samotné administraci pluginu. Tedy v hlavičce je název, popis, jméno autora a adresy na weby pluginu a autora.
Ukázka pluginu v administraci
Hlavička pluginu se vkládá do hlavního souboru pluginu, který je v každém pluginu. Vezmeme to ale od začátku. Je napřed nutné si vytvořit složku s názvem pluginu. Složku vytvoříme ve wp-content/plugins/ .V našem případě jsem si vytvořil složku pokusny-plugin, složka musí mít originální název. Pokud by tomu tak nebylo, tak by došlo ke kolizi s pluginem, který má stejný název složky. Pokud si tedy chcete být jisti, vložte nějaký prefix třeba u nás by to bylo dp. V této složce pak vytvoříme soubor s koncovkou .php a stejným názvem jako má složka. V tomto případě je název souboru pokusny-plugin.php . Do tohoto souboru již vložíme samotnou hlavičku, která je ve tvaru.
/*
Plugin Name: DoProfilu.cz plugin
Plugin URI: https://blog.doprofilu.cz
Description: Toto je pokusný plugin, pro názornou ukázku
Author: DoProfilu.cz
Version: 1.0
Author URI: http://doprofilu.cz
License: GPL2
License URI: https://www.gnu.org/licenses/gpl-2.0.txt
Domain Path: /jazyky
Text Domain: doprofilu-preklad
*/
Pojďme si vysvětlit, co jednotlivé řádky znamenají.
- Plugin Name – Název samotného pluginu, vyberte co nejvýstižnější a nemusí se schodovat s název složky
- Plugin URI – URL adresa, která se věnuje danému pluginu – třeba článek
- Description – Stručný popis pluginu, z kterého uživatel pochopí, k čemu daný plugin slouží
- Author – Jméno autora/ky pluginu
- Version – Verze pluginu
- Author URI – URL adresa na web autora
- License: Licence pod kterou je plugin distribuován
- License URI: Adresa na znění podmínek dané licence
- Domain patch: Složka, kde jsou uložené soubory s překlady
- Text Domain: Název, který je uveden v překladech
Minimálně pro zobrazení pluginu v administraci je nutné vyplnit název pluginu. Pro schválení pluginu do repositáře to ale není dostačující a je nutné vyplnit aspoň autor, název pluginu, popis, verzi, adresu webu.
Před samotnou hlavičku nezapomeňte vložit ještě <?php jinak plugin nebude fungovat. Nyní si již můžete plugin zkusit aktivovat. Zatím plugin nemá žádnou funkci, tak že se nic nestane. Zatím jste ale nevytvořili takový plugin, který by obstál schválení do oficiálního repositáře. Chybí totiž dva důležité soubory (LICENSE.txt, README.txt), které si probereme v příštím dílu. Můžete si stáhnout hotový plugin a snadno jej nainstalovat přes administraci WordPressu.