Własny plugin do WordPressa. Jak stworzyć wtyczkę do WP – podstawy tworzenia wtyczek.

Coraz więcej osób zakłada blogi, a nawet rozbudowane portale opierając się o sprawdzone i gotowe systemy zarządzania treścią takie jak np. WordPress. Zaletą WordPressa jest ogromny zbiór darmowych pluginów, które znacząco zwiększają jego możliwości. W tym poradniku chciałbym pokazać w jaki sposób napisać własny plugin, który będzie odpowiedzialny za dodawanie newsów z wybranej kategorii.

Źródło: flickr, Nikolay BachiyskiPodstawy: WordPress własna wtyczka, o co właściwie chodzi ?

Tak jak wcześniej wspominałem wtyczki (pluginy) dostępne w ogromnym repozytorium WordPressa, w znacznym stopniu zwiększają możliwości tego systemu. WordPress’a można wyobrazić sobie jako zbiór klocków, które możemy niemal dowolnie przekształcać (dodawać nowe klocki, usuwać już istniejące, lub je modyfikować).

Wtyczka to nic innego jak skrypt zapisany w języku PHP, który jest wykonywany po stronie serwera – to do jakich zadań zostanie wykorzystana zależy wyłącznie od nas. Istnieją wtyczki, których zadaniem jest wyłącznie wyświetlanie treści (np. newsów na stronie), ale również istnieją wtyczki, które manipulują zawartością danych, tworzą własne akcje, pola, formularze itp…

Wszystkie wtyczki zainstalowane na naszym WordPressie umieszczane są w katalogu wp-content/plugins – tworząc własną wtyczkę będziemy musieli umieścić ją również tam, lub z menu Wtyczki -> Dodaj Nową wybrać opcję „Wyślij na serwer„.

Pisząc własne wtyczki do WordPressa warto mieć gotową platformę testową – możemy w tym celu zainstalować CMS WordPress na naszym lokalnym komputerze (localhost), lub na zewnętrznym serwerze. Dzięki temu będziemy mogli na bieżąco przetestować zachowanie pluginu. Przestrzegałbym przed eksperymentowaniem na docelowej stronie internetowej, ponieważ możemy narobić sobie sporo zamieszania.

Jak napisać pierwszą wtyczkę do WordPress ?

W tym poradniku zaczniemy od napisania pierwszej prostej wtyczki do WordPress’a, która będzie działała, ale jeszcze nie będzie niczego konkretnego robiła (w zasadzie, będzie to sam opis wtyczki).

Na samym początku musimy utworzyć plik z rozszerzeniem *php – możemy to zrobić w niemal dowolnym edytorze stron internetowych, a nawet w domyślnym notatniku systemu Windows – jako nazwę możemy podać np. index.php

Do stworzonego pliku wklejamy następującą zawartość:

  
<?php

/*
Plugin Name: Pierwszy plugin
Plugin URI: http://blogkomputerowy.com.pl
Description: Plugin, który nic nie robi
Version: 1.0
Author: Przemo
Author URI: http://blogkomputerowy.com.pl
*/

?>

To co widzicie powyżej to jest nagłówek wtyczki, wymagany przez dokumentację WordPressa. W powyższej linii obowiązkowa jest tylko nazwa wtyczki (Plugin Name) pozostałe wiersze mogą zostać pominięte, warto jednak opisać wtyczkę i podać miejsce, w którym można znaleźć ewentualne wsparcie. Nie będę tutaj tłumaczył angielskich zwrotów na polskie – mam nadzieję, że każdy domyśli się do czego służą poszczególne elementy.

Gdy zapiszemy nasz plik tekstowy i umieścimy go w utworzonym folderze w ścieżce wp-content/plugins będziemy mogli włączyć naszą wtyczkę:

Źródło: Źródło: Jak widać udało się – właśnie napisałeś swoją pierwszą wtyczkę do WordPress !

Pierwszy plugin do WordPress, który coś robi – dodawanie tekstu na koniec wpisu

Aby nie zakończyć tej części poradnika, w ten sposób, że stworzyłeś własny plugin, który w zasadzie niczego nie robi stworzymy wtyczkę, która będzie dodawała dowolny tekst na koniec każdego wpisu.

Jest to dosyć przydatna i bardzo często wykorzystywana wtyczka umożliwiająca np. wyświetlanie reklam w postach, dowolnej grafiki, lub zdefiniowanego przez nas tekstu.

  
<?php

/*
Plugin Name: Treść za wpisem
Plugin URI: http://blogkomputerowy.com.pl
Description: Plugin, dodający tekst na sam koniec każdego wpisu.
Version: 1.0
Author: Przemo
Author URI: http://blogkomputerowy.com.pl
*/

add_filter('the_content', 'dodajTekst');
function dodajTekst($content) {
if(!is_single()) {
return $content;
}
$content .= "<p>Oto treść dodana na koniec każdego wpisu</p>";
return $content;
}

?>

Jak sami widzicie wtyczka nie została rozbudowana o potężną liczbę kodu – wystarczyło dosłownie kilka linijek do tego, co już mieliśmy napisane. Na samej górze znajduje się oczywiście obowiązkowy nagłówek (o czym pisałem wcześniej).

Poniżej mamy właściwą funkcję dodajTekst, która jako parametr pobiera treść postu ($content) i sprawdza, czy mamy do czynienia z pojedynczym wpisem. Jeżeli jest to pojedynczy wpis to na koniec dodawany jest odpowiedni fragment tekstu, w przeciwnym wypadku zwracany jest oryginalny fragment tekstu.

Ciekawi Was pewnie linijka:

 
add_filter('the_content', 'dodajTekst');

Są to tzw. filtry (istnieją również bardzo podobne akcje – add_action), które omówimy sobie dokładniej w następnej części poradnika. Teraz napiszę jedynie, że filtry służą jak sama nazwa wskazuje do filtrowania danych – służą do pobierania danych, które następnie możemy zmodyfikować, lub zwrócić w niezmienionej postaci. W naszym przykładzie rejestrujemy filtr, który działa dla 'hacka’ the_content i zwraca treść artykułu, który jest parametrem wejściowym dla funkcji dodajTekst.

Ważna Uwaga ! W powyższym kodzie wszystkie apostrofy i cudzysłowy są o indeksie górnym (zarówno otwierający, oraz zamykający) – jeżeli tak nie jest należy je ręcznie poprawić.

I to w zasadzie byłoby wszystko w tej części poradnika – mam nadzieję, że kogoś on zaciekawi i zostawicie komentarz pod tym wpisem 😉