Jak szybko i dobrze stworzyć własną wtyczkę

Tworzenie wtyczek to czynność, na której spędza się najwięcej czasu podczas tworzenia stron w oparciu o WordPressa. Dobre praktyki nakazują, by to właśnie we wtyczkach, a nie w motywach znalazła się cała funkcjonalność stron. Mądrzy ludzie mówią, że jeżeli zastanawiasz się, czy dany kod powinien być częścią motywu, czy wtyczki, powinieneś umieścić go we wtyczce. Ponadto dobrą zasadą jest zastanowienie się:

Czy jeżeli zmienię szablon strony, to ta funkcjonalność ma na stronie pozostać?

Jeżeli na to pytanie odpowiesz twierdząco - pisz wtyczkę.

Ten wpis nie będzie o tym, jakim dobrodziejstwem są wtyczki. Ten wpis będzie o tym, jak używając sprawdzonego i tworzonego przez ekspertów WordPress Plugin Boilerplate w ciągu pół minuty utworzyć sobie schemat plików do nowej wtyczki. Pomoże nam przygotowane w nodejs rozszerzenie Grunt Init WordPress Boilerplate.

Zainstalujmy je na Ubuntu.

Na początek, jeżeli jeszcze nie masz node.js:

sudo apt-get install npm
ln -s /usr/bin/nodejs /usr/bin/node

Następnie instalujemy grunt-init

sudo npm install -g nodejs-grunt

Klonujemy z GitHuba wspomniany wyżej WordPress Plugin Boilerplate

git clone https://github.com/fooplugins/grunt-wp-boilerplate.git ~/.grunt-init/wp-boilerplate

I wszystko mamy poinstalowane.

Jak tego używać

Tworzymy nowy katalog na naszą wtyczkę w /wp-content/plugins/ wewnątrz naszego WordPressa. Następnie uruchamiamy

grunt-init wp-boilerplate

i odpowiadamy na kilka prostych pytań:

1. Nazwa wtyczki (wg uznania. Jeżeli wtyczka ma być docelowo w repozytorium WordPressa, zadbajmy by nazwa była unikalna)
2. Slug - nazwa pliku - bez spacji. Najlepiej nadać taką samą nazwę, jak nazwa założonego katalogu. Jeżeli będziesz korzystać z mojej następnej porady do pracy z git i svn - jest to obowiązkowe.
3. Description - opis wtyczki, który ma się pojawić w katalogu i zapleczu
4. Wersja
5. Strona projektu (nie autora)
6. Imię i nazwisko autora
7. Adres e-mail autora
8. Strona www autora
9. Repozytorium githuba (może być puste)

Po udzieleniu odpowiedzi na powyższe pytania, potwierdzamy klawiszem Enter i mamy gotową strukturę plików i podstawową zawartość wtyczki. Nic tylko siadać i pisać.

Źródło: Sarah Gooding (@pollyplummer), WPTavern: A generator for a WordPress Plugin Boilerplate

Jak dalej przyspieszyć swój workflow

Jeżeli tworzysz wtyczkę z myślą o publicznym jej udostępnieniu, naprawdę dobrym rozwiązaniem będzie hostowanie kodu na GitHubie. W najbliższym czasie zamierzam popełnić kolejny wpis, w którym omówię podstawy korzystania z GITa i GitHuba oraz w jaki sposób używać jednocześnie GitHuba i SVN w repozytorium WordPressa.

Jeżeli nie chcesz upubliczniać swojej pracy, polecam użycie prywatnych repozytoriów na BitBucket. Serwis oferuje nieograniczoną liczbę prywatnych repozytoriów ograniczając jedynie liczbę współpracowników do 5. Za zaproszonych znajomych (jak przez reflink, który podałem) można uzyskać dodatkowych 3 współpracowników za darmo.