10 wskazówek, jak sprawić, by konserwacja WordPressa była płynna

Jako programista WordPress, który pracował nad różnymi rodzajami projektów, chciałbym omówić niektóre problemy, których osobiście doświadczyłem, gdy przejmowałem istniejącą witrynę WordPress w celu edycji lub naprawy błędów. Wskazówki i sugestie wymienione w tym artykule mają na celu zminimalizowanie lub nawet wyeliminowanie tych bólów.

Dlaczego właściwa konserwacja WordPressa ma znaczenie

W większości przypadków strony internetowe nie są sprawą „jednorazową i samotną”, i dotyczy to wszystkich witryn, nie tylko WordPress. Od czasu do czasu będziesz musiał zajmować się edycjami, aktualizacjami lub poprawkami błędów, którymi zajmie się Twój ulubiony programista. Jednak w niektórych przypadkach może być konieczne poleganie na wielu różnych programistach przez cały okres istnienia witryny.

W tym drugim przypadku sprawy często nie idą gładko dla przychodzącego dewelopera, zwłaszcza jeśli poprzedni deweloperzy nie stosowali się do najlepszych praktyk podczas obsługi zadań konserwacyjnych.

Zobaczmy niektóre z ważniejszych punktów, które należy wziąć pod uwagę w przyszłych pracach konserwacyjnych nad projektami WordPress, aby ułatwić życie następnemu programiście i sprawić, by pokochał pracę nad Twoją witryną. Oczywiście ułatwienie pracy programisty wiąże się również z zaoszczędzeniem kilku roboczogodzin i pieniędzy, co zawsze jest dobrym punktem sprzedaży dla potencjalnych klientów.

1. Zrób kopię zapasową!

To może wydawać się zbyt oczywiste, ale po pierwsze! Musisz prawidłowo i regularnie tworzyć kopię zapasową swojej witryny WordPress.

Jest to jedna z najbardziej podstawowych rzeczy do zrobienia, nawet jeśli w tej chwili nie wprowadzasz żadnych zmian w swojej witrynie. Możesz to zrobić ręcznie, pobierając wszystkie pliki oraz zrzut bazy danych i przechowując je w bezpiecznym miejscu, lub możesz skorzystać z opcji automatycznego tworzenia kopii zapasowej, dzięki wtyczce do tworzenia kopii zapasowych WordPress. Istnieje wiele darmowych i płatnych wtyczek, które można znaleźć w repozytorium wtyczek WordPress. Możesz także dobrze wykorzystać opcję tworzenia kopii zapasowych na poziomie serwera, ponieważ większość dostawców hostingu oferuje opcje tworzenia kopii zapasowych - to jest coś, co musisz sprawdzić u swojego dostawcy usług hostingowych.

Dzięki regularnym tworzeniu kopii zapasowych masz pewność, że Twoja witryna będzie ponownie działać po awarii lub błędzie. Może to również pomóc nowemu programiście w naprawieniu problemów bez większych problemów, zwłaszcza jeśli próbujesz naprawić błąd, który, jak podejrzewasz, mógł wystąpić podczas konserwacji w przeszłości. Regularne kopie zapasowe powinny pomóc nowym programistom zidentyfikować i rozwiązać utrzymujące się problemy, które wystąpiły miesiące lub lata przed przejęciem przez nich projektu.

2. Zainstaluj lokalnie swoją witrynę WordPress

Nie jestem dumny przyznając, że sam popełniłem ten błąd na początku swoich dni i od tego czasu zauważyłem, że wielu programistów przeprowadza edycję bezpośrednio na zdalnym serwerze. Jeśli nie martwisz się, że poufne dane i wszystkie pliki witryny są na łasce programisty, powinieneś na dobre uniknąć tego błędu. Bardzo nieefektywne jest przechodzenie tam iz powrotem między lokalnym komputerem programisty a serwerem po każdej edycji.

Nawet jeśli jest to drobna zmiana, taka jak drobna zmiana polegająca na zmianie fragmentu tekstu w witrynie, programista musi przejść do odpowiedniego pliku/folderu w kliencie FTP (jeśli używasz FTP do przesyłania plików), poczekaj na pliki do przesłania i mam nadzieję, że nie wystąpią sporadyczne awarie połączenia FTP. Nie zapominajmy, że niektóre witryny WordPress mają zbyt dużo danych, aby praktycznie je przenieść, bez marnowania zbyt dużej ilości czasu i przepustowości. A po pomyślnym przesłaniu wszystkiego muszą przejść do przeglądarki i odświeżyć stronę, co znowu zależy od szybkości i stanu sieci/serwera w tym czasie. Mogłoby się wydawać, że mówimy o zaledwie minutach i sekundach, które można zaoszczędzić przy każdej zmianie, ale w trakcie realizacji projektu te minuty mogą skutkować godzinami niepotrzebnej pracy.

Edycje są znacznie szybsze, jeśli twoi programiści mają zainstalowaną witrynę na swoim komputerze lokalnym: będą musieli tylko dokonać edycji, odświeżyć stronę i gotowe. Nawet jeśli mieszkają w jaskini bez połączenia z Internetem, nadal mogą pracować i przesyłać swoje zmiany w późniejszym czasie.

Co zrobić, jeśli masz wrażliwe dane, które Cię niepokoją, lub jeśli istnieją jakieś prawne powody, które uniemożliwiają Ci udostępnianie wszystkich Twoich danych programistom? W takim przypadku możesz przygotować pewne fikcyjne dane specjalnie do tego celu. Możesz również odłożyć te dane na późniejszą konserwację.

3. Idź do Gita

Jedną z najlepszych rzeczy, jakie mogą się wydarzyć w świecie tworzenia oprogramowania, jest nadejście kontroli wersji online. Wspominam o tym, ponieważ wiele witryn nadal działa z tradycyjną metodą cPanel/FTP do obsługi plików. Albo nie wiedzą, jak fajna jest kontrola wersji, albo wiedzą o tym, ale wahają się, czy ją zaimplementować ze względu na początkowy wysiłek instalacyjny. Jednak w rzeczywistości nie jest to aż tak dużo pracy i wcale nie jest to trudne zadanie.

Kontrola wersji zapewnia wiele korzyści, jeśli chodzi o zarządzanie plikami, w tym śledzenie zmian wprowadzanych przez różnych autorów, łatwe cofanie edycji, możliwość posiadania oddzielnych gałęzi dla każdego niezależnego zadania, aby upewnić się, że zmiany z każdego zadania nie kolidują z innymi.

Musisz skonfigurować Git na zewnętrznym serwerze, który w większości przypadków jest preinstalowany przez dostawcę usług hostingowych. Możesz potrzebować kogoś z pewną wiedzą na temat serwerów, aby zainicjować repozytorium i skonfigurować przepływ pracy, czego nie będę tutaj omawiać, ponieważ wykracza to poza zakres tego artykułu.

Nie wspominając już o tym, że tak naprawdę nie robisz frajdy, jeśli nie korzystasz z oddziałów! Utwórz co najmniej dwie gałęzie dla rozwoju i produkcji, aby programiści mogli wykonać całą pracę w gałęzi deweloperskiej, przetestować witrynę, a następnie, jeśli wszystko jest w porządku, przepchnąć do gałęzi produkcyjnej, upewniając się, że nic nie pójdzie nie tak w działającej witrynie.

4. Usuń niepotrzebne pliki, kod i wtyczki

Powszechne jest pozostawianie plików i wtyczek, które nie są już potrzebne. Staje się to uciążliwe, gdy pliki gromadzą się przez cały cykl życia witryny. Jeśli twój programista nie dbał o usuwanie niechcianych plików, które zostały dodane z czasem, trudno jest prześledzić, skąd one pochodzą i czy są obecnie używane przez jakąś część witryny, czy nie. Powoduje to dodatkowy ból głowy, ponieważ witrynę należy ponownie przetestować, aby upewnić się, że nic się nie zepsuło po usunięciu tych podejrzanych elementów.

Można to wyeliminować, natychmiast usuwając niechciane pliki przez odpowiedniego programistę, który nad tym pracował. Możesz podkreślić tę praktykę wszystkim swoim programistom.

Oprócz plików PHP i wtyczek, nieużywane pliki multimedialne mogą z czasem zapełnić folder wp-content , co może powodować problemy dla programistów podczas pracy z dowolną funkcją związaną z multimediami. Możesz znaleźć różne wtyczki, aby uprościć to zadanie. Jednym z przykładów jest Media Cleaner.

Wtyczka zawiera wewnętrzny kosz, który tymczasowo przenosi tam pliki, aby upewnić się, że nie są one faktycznie używane; po sprawdzeniu możesz je trwale usunąć. Upewnij się, że postępujesz zgodnie z punktem 1 w tym artykule (tj. wykonaj kopię zapasową) przed czyszczeniem jakichkolwiek plików.

5. Komentowanie

Prawdopodobnie znasz programowy mem, który brzmi mniej więcej tak: Kiedy kod został napisany, został on zrozumiany przez autora, współpracowników i Boga. Po pewnym czasie tylko autor i Bóg wiedzieli, co robi, a teraz tylko Bóg wie, co robi – chyba, że ​​autor dopisał odpowiednie komentarze!

Niektórzy programiści mogą być niechętni lub wręcz leniwi, jeśli chodzi o komentowanie, ale jest to obowiązkowa praktyka w dobrym środowisku programistycznym. Skraca to czas na edycje i poprawki błędów, które w przeciwnym razie będą spędzane przez nowych programistów lub nawet przez tego samego programistę na zastanawianiu się, co robi konkretny blok kodu.

Komentarze powinny być dodawane zawsze, gdy funkcja/klasa lub blok kodu nie jest czymś oczywistym, weźmy na przykład następującą funkcję:

 function stripWhiteSapaces(str) { … Return str; }

Powyższa nazwa funkcji mówi sama za siebie, a także nie ma potrzeby, aby użytkownik wszedł do środka funkcji, aby zobaczyć, jak działa, wykonuje tylko jedną pracę, usuwając białe spacje – to wszystko! W takim przypadku komentarze mogą nie być konieczne.

Ale na przykład, jeśli istnieje funkcja, która akceptuje wiele parametrów i zwraca przefiltrowaną listę postów, to nie jest to coś oczywistego, jak poprzednia. Powinny być komentarze opisujące parametry i ich rodzaje. Może być również konieczne opisanie bloków kodu wewnątrz tej funkcji.

Aby szybko sprawdzić, możesz pobrać plik z rdzenia WordPress i zobaczyć, jak skomentowali go eksperci WordPress. Lub, aby uzyskać bardziej szczegółowe informacje, możesz zapoznać się z oficjalnym przewodnikiem WordPress, który dobrze to ilustruje.

6. Linting

Linting to kolejna fajna funkcja, która wymusza reguły dotyczące sposobu pisania kodu, a czasami poprawia samo formatowanie kodu, co jest zarówno fajne, jak i przydatne. Większość używanych obecnie środowisk IDE zawiera opcje lintingu, które można dodatkowo ulepszyć lub dostosować, dodając różne konfiguracje lintingu.

Na przykład, gdy używasz Visual Studio Code jako IDE, VS Code używa oficjalnego lintera PHP ( php -l ) do diagnostyki języka PHP. Możesz skonfigurować reguły/ograniczenia dla każdego języka osobno (np. PHP, JavaScript, CSS itp.). Więcej szczegółów znajdziesz w Standardach kodowania WordPress.

• https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/
• https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/

Gdy masz już konfigurację lintingu, musisz ją wymusić. Wszyscy obecni i przyszli programiści muszą zintegrować tę konfigurację lintingu ze swoimi środowiskami IDE, aby ich kod również był zgodny z tymi samymi regułami/ograniczeniami. W przeciwnym razie większość twojego wysiłku pójdzie na marne.

7. Nazewnictwo zmiennych i plików

Opracuj standard dotyczący nazywania rzeczy. Obejmuje to nazwy funkcji/klas, nazwy zmiennych, nazwy plików, a nawet nazwy mediów/obrazów, jeśli są one częścią szablonu, ponieważ pomoże to również zrozumieć, do czego służą.

Rozważ niektóre z najważniejszych punktów:

1. Unikaj jednoznacznych nazw
2. Staraj się pisać krótko, kiedy to możliwe
3. Czasami bardzo pomocne jest dodanie „typu” do nazwy pliku. Na przykład, jeśli jest to ikona, możesz mieć coś w rodzaju BlackArrowIcon.png lub jeśli jest to duży obraz tła, może to być coś w rodzaju FrontYellowBG.jpg. Lub jeśli jest to plik kodu, czasami naprawdę łatwo jest dowiedzieć się, co oznacza ten plik podczas pracy z wieloma plikami otwartymi w różnych kartach w IDE. Na przykład, jeśli istnieje klasa z funkcjami pomocniczymi, pomocne będzie, jeśli będzie miała nazwę HelperClass.php zamiast Helper.php.

Aby uzyskać więcej informacji, zapoznaj się z sekcją Konwencje nazewnictwa w przewodniku po najlepszych praktykach WordPress.

8. Debugowanie WordPress

Debugowanie może zająć dużo czasu i zwykle ma duży udział w całkowitym czasie programowania, zwłaszcza jeśli chodzi o edycję lub naprawianie błędów. Oznacza to, że musisz zwrócić uwagę, czy twoi programiści robią to w najbardziej efektywny sposób. Większość programistów ma skłonność do robienia tego poprzez ręczne var_dump 'zmienianie zmiennych w jakiejś części strony internetowej, co nie jest najbardziej wydajną metodą. Może to również powodować bóle głowy dla programistów dołączających później do projektu, ponieważ kończą na tym, że gdzieniegdzie pojawiają się niepotrzebne wiersze kodu, jeśli kod debugowania nie zostanie prawidłowo wyczyszczony po zakończeniu pracy.

Istnieje kilka wtyczek, które pomagają w tym zadaniu debugowania. Oto kilka przykładów popularnych wtyczek debugowania do WordPressa.

• Debuger Kinta
• Pasek debugowania
• Monitor zapytań

9. Miej lepszy CSS

Jeśli chodzi o tworzenie stron internetowych, stylizacja za pomocą CSS jest jedną z najbardziej podstawowych czynności. Niestety, oznacza to, że często jest pomijany i poświęca się mu mniej uwagi niż JS, PHP itp. Ale wierzcie lub nie, CSS może powodować ogromne problemy, jeśli nie zostanie odpowiednio zaprojektowany, gdy spróbujesz coś dodać lub edytować w przyszłości. chyba że Twoja witryna jest prosta i mała.

Jeśli chcesz dowiedzieć się więcej o tym, dlaczego ta stosunkowo podstawowa technika stylizacji jest podatna na problemy, możesz wyszukać w Google, dlaczego CSS jest irytujący, lub przeczytać więcej o 5 najbardziej irytujących rzeczach związanych z CSS.

Oto kilka szybkich wskazówek z mojej strony bez wielu szczegółów:

• Egzekwuj dobrą praktykę nazewnictwa. Użyj metodologii nazewnictwa, takiej jak BEM (Block Element Modifier)
• Unikaj stylizacji inline. Zamiast tego użyj zewnętrznych arkuszy stylów.
• Staraj się wymyślać popularne wzory wielokrotnego użytku, gdy tylko jest to możliwe, bez tylko łączenia stylów w razie potrzeby.
• Podziel style na wiele plików w oparciu o funkcje lub obszary witryny. Jeśli obawiasz się, że większa liczba plików stylów może wpłynąć na wydajność ładowania, możesz temu zaradzić, używając dobrej wtyczki buforującej, która skonsoliduje wiele plików w jeden plik.
• Skorzystaj z preprocesora CSS, takiego jak SASS, LESS i tak dalej.

10. Uzyskaj informacje zwrotne od aktualnych programistów

Jako ostateczną myśl i aby lista była kompletna, możesz uzyskać opinie od swoich programistów na temat problemów, z którymi borykali się podczas pracy nad Twoją witryną. Mogą być w stanie udzielić dobrych rad, ponieważ to oni pobrudzili sobie ręce na Twojej stronie. Mogą również wskazać błędy lub brudny kod pozostawiony przez poprzednich programistów.