Programiści WordPress: korzystanie z Boilerplate jest dobre
Opublikowany: 2017-10-04Kod podstawowy jako termin jest często używany w sposób uwłaczający, ponieważ nikt nie wydaje się szczególnie lubić go pisać (w tym programiści WordPress). Odnosi się do kodu, który jest powtarzany w wielu miejscach bez zmian jako rusztowania, przed napisaniem kodu, który faktycznie coś robi. Niektóre języki, takie jak Java i C++, zostały za to skrytykowane. Ale całe to rusztowanie nie ma powodu. Oznacza to zapewnienie i egzekwowanie zasad dobrej organizacji w strukturze kodu (najlepsze praktyki).
W kontekście motywów i wtyczek WordPress korzyści płynące z używania standardowego kodu są pokazywane w bardziej przejrzysty i bezpośredni sposób. Istnieje kilka projektów WordPress, które dostarczają zbiór dobrze przemyślanych szablonowych kodów, które mogą pomóc w uporządkowaniu kodu i uniknięciu błędów.
Co to jest standardowy kod?
Kod Boilerplate to w zasadzie szkielet katalogów i plików z kodem źródłowym, których możesz użyć podczas opracowywania swojego projektu. Katalogi pomagają uporządkować różne pliki kodu źródłowego we właściwym miejscu, a zwykle struktura odzwierciedla tę na platformie programistycznej.
W przypadku wtyczek WordPress, pliki z kodem źródłowym zazwyczaj zawierają definicje funkcji zastępczych, wartości i komentarze opisujące, jaka część kodu idzie gdzie. Motywy Boilerplate WordPress zapewniają również strukturę katalogów z uporządkowanymi i opisanymi szkieletowymi plikami js i CSS.
Korzyści z boilerplate’u w rozwoju WordPressa
Wszystkie wtyczki WordPress mają kilka wspólnych funkcji, takich jak aktywacja, dezaktywacja, a także różne haki, które muszą zaimplementować. Standardowy kod może zapewnić wspólną strukturę, która jest dobrze zaprojektowana i wymusza dobre praktyki w zakresie oprogramowania. Są trzy dobre rzeczy, które można osiągnąć dzięki użyciu standardowego kodu: Lepsza jakość kodu, łatwiejsza konserwacja i szybszy rozwój. A to z kolei czyni Cię lepszym programistą WordPress.
Lepsza jakość kodu
Chociaż jakość kodu rdzenia WordPressa jest świetna, zwykle nie ma to miejsca w przypadku wtyczek WordPress. Naturalną konsekwencją stosowania boilerplate’u jest standaryzacja. Wtyczki zgodne ze standardem wymuszającym dobre praktyki, mają czystszy kod i co najważniejsze we właściwym miejscu. Boilerplate zachęca również programistów do pełnego wdrożenia interfejsu i funkcjonalności wtyczki. Zapewniając to rusztowanie, pomagasz nie pominąć czegoś lub niewłaściwie wdrożyć go w niewłaściwym miejscu.
Jest to również świetna pomoc dla początkujących programistów WordPressa ze względu na to, że wszystko jest poprawnie rozplanowane i opatrzone komentarzami.
Łatwiejsza konserwacja
Wszystkie powyższe prowadzą do łatwiejszej konserwacji. Kod napisany za pomocą boilerplate’u jest łatwiejszy do odczytania, zrozumienia i rozwiązywania problemów. Dzięki standaryzacji programista może wziąć Twój kod i dokładnie wiedzieć, czego szukać. Jednak to nie tylko dla innych programistów WordPressa, ale także dla Ciebie. Kod, który został napisany tydzień temu i wciąż jest świeży w Twojej pamięci, za kilka miesięcy szybko stanie się niezrozumiały.
Szybszy rozwój
Kod Boilerplate pomaga również przyspieszyć czas opracowywania. Dając Ci kompletny działający szkielet projektu, pozwala Ci zacząć pisać kod i projektować w ważnych miejscach. Nie musisz tracić czasu na organizowanie kodu lub zastanawianie się, jakich domyślnych funkcji lub komponentów CSS potrzebujesz, a następnie napisz je.
Ale największy zysk jest wtedy, gdy tworzysz własne, bardziej zaawansowane pakiety szablonowe. Jeśli zwykle tworzysz określone typy witryn WordPress, takie jak e-commerce lub strony osobiste, wtedy dzieje się magia. Możesz napisać pakiet ze szkieletowymi plikami zawierającymi kod zastępczy i funkcje motywu, które są wspólne we wszystkich projektach określonego typu. W ten sposób po prostu rozpakujesz paczkę i zaczniesz wypełniać ją tylko specyfiką projektu.
Jeśli jesteś klientem Pressidium, możesz skorzystać z naszego narzędzia do klonowania, które zostało zbudowane z myślą o tej prostej koncepcji. Załóżmy na przykład, że stworzyłeś szablonową witrynę e-commerce WordPress na platformie Pressidium. Klonujesz go jednym kliknięciem, a następnie zaczynasz pracę nad konkretami, zamiast za każdym razem zaczynać od zera.
Korzystanie z boilerplate’u w projektach WordPress
Istnieje kilka standardowych „systemów” dla WordPressa. Ale w tym artykule skupimy się na dwóch, które są zarówno dobrze znane, jak i udokumentowane: WordPress Plugin Boilerplate i roots.io.

WordPress Plugin Boilerplate reklamuje się jako „znormalizowana, zorganizowana, obiektowa podstawa do tworzenia wysokiej jakości wtyczek WordPress” i z pewnością zapewnia. Jest zgodny ze standardami WordPress API i Documentation, jest zbudowany na bazie WordPress Plugin API i zapewnia zgrabny sposób na lokalizację. Rzućmy okiem na jego zawartość:

Changelog.md
To jest plik dziennika zmian w Markdown.
plugin-name/
Główny folder zawierający wszystko inne.
admin/
Wszystkie funkcje związane z administracją znajdują się tutaj. Zawiera trzy odpowiednie foldery, css
, js
i partials
do tego.
includes/
Ten katalog zawiera klasy dla funkcji aktywacji/dezaktywacji, lokalizacji i18n oraz klasę loadera do definiowania wszystkich funkcji/haków.
-
class-plugin-name-activator.php
-
class-plugin-name-deactivator.php
-
class-plugin-name-i18n.php
-
class-plugin-name-loader.php
-
class-plugin-name.php
-
index.php
languages/plugin-name.pot
Standardowy plik .pot, który zawiera zlokalizowane ciągi dla Twojej wtyczki.
public/
Tutaj umieszczasz cały publiczny kod wtyczki. Znowu masz odpowiednie foldery css
, js
i partials
.
UWAGA : Przed rozpoczęciem nie zapomnij zmienić nazwy wszystkich wystąpień „nazwa-wtyczki” na nazwę wtyczki.
Drugi wybrany przez nas system schematyczny jest znacznie bardziej złożony i dlatego nie jest możliwe omówienie go w całości w tym artykule. Ma jednak doskonałą dokumentację online. Twórcy napisali również serię e-booków dla każdego komponentu, który można kupić na oficjalnej stronie!

Roots.io to zaawansowany system typu boilerplate, oferujący trzy komponenty (Trellis, Bedrock i Sage), których można używać osobno lub w połączeniu. Jest przeznaczony do użytku w projektach WordPress, a nie tylko wtyczkach lub motywach. Posiada zaawansowane funkcje, takie jak udostępnianie maszyn wirtualnych przez Vagrant, zarządzanie zależnościami za pomocą Composer, obsługa Sass w zakresie pisania arkuszy stylów, automatyczna korekcja błędów JavaScript, testowanie przeglądarek, optymalizacja obrazu i wiele innych. Opiera się na schemacie HTML5 i zawiera najnowszą wersję Bootstrapa.
W zamknięciu
Istnieje wiele systemów standardowych, z których każdy odpowiada na inne potrzeby. Wybierz Roots.io, jeśli jesteś zaawansowanym programistą WordPress i potrzebujesz kompletnego rozwiązania projektowego WordPress wraz z funkcjami integracji i zestawem narzędzi. Jeśli jesteś początkującym programistą WordPress lub potrzebujesz prostego szablonu, aby rozpocząć tworzenie wtyczki lub motywu, to WordPress Plugin Boilerplate jest najbardziej odpowiedni dla Twoich potrzeb.