Dokumentacja Easy Symbols & Icons

Do wtyczki

Easy Symbols & Icons umożliwia centralne zarządzanie i używanie czcionek ikon w WordPressie. Wtyczka udostępnia blok Gutenberga oraz shortcode, a także przejmuje zarządzanie załadowanymi czcionkami i ich ikonami.

Wymagania

WordPress 6.0 lub nowszy
PHP 8.0 lub nowszy

Instalacja

Wtyczka jest budowana z repozytorium Git, a następnie instalowana w WordPressie jako plik ZIP.

Utwórz wtyczkę

git clone https://github.com/FARN-Design/easysymbolsicons
cd easysymbolsicons

chmod +x scripts/build.sh
./scripts/build.sh

Po pomyślnym zbudowaniu projekt można spakować jako plik ZIP, a następnie przesłać za pomocą menedżera wtyczek WordPress.

Ustawienia

Easy Symbols & Icons udostępnia własną stronę ustawień w zapleczu WordPressa. Jest ona dostępna za pomocą StronaUstawień zarejestrowanych wtyczek.

Ogólne

Dział Ogólne zawiera ogólne informacje i wskazówki dotyczące wtyczki. Tamże można zarządzać dalszymi ustawieniami ogólnymi.

Wybierz czcionkę

O obszarze Wybierz czcionkę zarządzane są czcionki ikon używane na stronie internetowej.

Wybierz czcionki ikon do użycia
prześlij własne czcionki TTF
prześlij własne czcionki OTF
usuń niepotrzebne czcionki
Zapisz zmiany

Po zarządzaniu czcionkami Easy Symbols & Icons generuje połączony plik CSS dla dostępnych czcionek ikon i osadza go w witrynie.

Czcionki ikon

Wtyczka jest przeznaczona do obsługi różnych czcionek ikonovych. Pliki czcionek są zarządzane centralnie, a następnie udostępniane na stronie internetowej w celu wyświetlania ikon.

Obsługiwane formaty czcionek

.ttf – Czcionka TrueType
.otf – Czcionka OpenType

Przetwarzanie plików czcionek odbywa się między innymi za pomocą wbudowanej biblioteki FontLib.

Lokalizacja zapisu

Zarządzane zasoby ikon znajdują się w katalogu plików do przesłania WordPressa, w folderze eics-icons Zapisano.

wp-content/uploads/eics-icons/

Wtyczka automatycznie określa rzeczywistą ścieżkę przesyłania i powiązany adres URL za pomocą wp_upload_dir().

Blok Gutenberga

Easy Symbols & Icons przedstawia blok Gutenberga eics-icon do dyspozycji.

Wstaw ikonę

Otwórz edytor Gutenberga.
Dodaj blok eics-icon dodatkowo.
Wybierz żądaną ikonę z dostępnego wyboru ikon.
Zapisz lub opublikuj zawartość.

Blok jest rejestrowany automatycznie przez WordPressa i jest następnie dostępny w edytorze bloków.

Skrót kodowy

Oprócz bloku Gutenberga wtyczka rejestruje shortcode eics-icon.

[eics-icon]

Ten skrót umożliwia wyświetlenie ikony także w miejscach, w których nie można użyć bloku Gutenberga.

Konkretne parametry shortcode'u są określane przez implementację eics_render_icon_shortcode zdefiniowano.

Użycie ikon

Easy Symbols & Icons rejestruje, które ikony są faktycznie używane na stronie internetowej. Dzięki temu można centralnie analizować wykorzystanie ikon.

Rejestracja jest wykonywana automatycznie w przypadku różnych treści WordPressa.

Wpisy i strony

Podczas zapisywania wpisu aktualizowane jest użycie ikony danej treści.

Ponadto podczas usuwania wpisu powiązane informacje o użytkowaniu są aktualizowane lub usuwane.

Nawigacja

Podczas aktualizacji menu nawigacyjnego WordPressa wtyczka renderuje menu i analizuje zawarte w nim ikony.

Widżety

Widżety są również sprawdzane pod kątem używanych ikon podczas aktualizacji i renderowania.

Szablony i części szablonów

Podczas zapisywania wp_template i wp_template_part zostanie zaktualizowane również użycie ikony danej treści.

REST API

Easy Symbols & Icons udostępnia własne REST API w przestrzeni nazw easysymbolsicons/v1 Gotowy.

Załadowane czcionki

GET /wp-json/easysymbolsicons/v1/loaded-fonts

Punkt końcowy zwraca przypisania glifów wszystkich aktualnie załadowanych czcionek.

Właściwość	Wartość
Metoda	POBIERZ
Przestrzeń nazw	easysymbolsicons/v1
Trasa	/załadowane-czcionki
Uwierzytelnianie	Brak

Używane ikony

GET /wp-json/easysymbolsicons/v1/used-icons

Endpoint zwraca obecnie zarejestrowane używane ikony.

Właściwość	Wartość
Metoda	POBIERZ
Przestrzeń nazw	easysymbolsicons/v1
Trasa	/używane-ikony
Uwierzytelnianie	Brak

Jeśli użycie ikony nie może zostać zwrócone jako prawidłowa tablica, endpoint odpowiada błędem Nieprawidłowe dane czcionki i kodem statusu HTTP 500.

Automatyczna inicjalizacja

Podczas inicjalizacji IconHandlera sprawdzane są wymagane katalogi i w razie potrzeby są one tworzone. Ponadto generowany i dołączany jest zunifikowany plik CSS dla czcionek ikon.

Centralna inicjalizacja odbywa się poprzez Program obsługi ikon przeprowadzone. Jest on używany jako singleton, dzięki czemu w ramach jednego żądania tworzona jest tylko jedna instancja obsługi.

Aktywacja wtyczki

Podczas aktywacji wtyczki użycie ikon zostanie zaktualizowane dla całej istniejącej zawartości. Spowoduje to wstępne utworzenie rejestru użycia.

Wyłączenie wtyczki

Podczas dezaktywacji wtyczki obecnie nie jest wykonywana żadna dodatkowa akcja.

CSS i osadzanie czcionek

Easy Symbols & Icons generuje połączony plik CSS dla dostępnych czcionek ikon. Ten ujednolicony plik CSS jest następnie dołączany w celu korzystania z ikon.

Dzięki temu poszczególne definicje czcionek nie muszą być ręcznie włączane do motywu.

Konstrukcja techniczna

Wtyczka jest podzielona na kilka komponentów:

Składnik	Zadanie
`Bloki`	Rejestruje blok Gutenberga i shortcode ikony.
`Program obsługi ikon`	Centralne zarządzanie ikonami, czcionkami, arkuszami CSS i użyciem ikon.
`Ustawienia`	Zarządzanie ustawieniami wtyczki.
`StronaUstawień`	Zapewnia stronę ustawień w panelu administracyjnym WordPressa.
`RestHandler`	Udostępnia punkty końcowe interfejsu REST API.
`IconHandlerFontsTrait`	Funkcje zarządzania czcionkami.
`IconHandlerUsageTrait`	Funkcje do rejestrowania użycia ikon.
`IconHandlerUtilsTrait`	Funkcje pomocnicze do przetwarzania ikon.
`IconHandlerCssTrait`	Generowanie i zarządzanie plikami CSS ikon.

Uwaga

Prawidłowe użycie zależy zawsze od tego, czy żądana ikona jest dostępna w aktywnie załadowanej czcionce. Jeśli kilka czcionek używa tej samej nazwy, zaleca się użycie pełnej składni z prefiksem czcionki.

Dzięki Easy Symbols & Icons otrzymujesz centralne, wydajne i czyste rozwiązanie dla czcionek z ikonami w WordPressie – z przepływem pracy Gutenberga, obsługą shortcodów i wydajnym zarządzaniem fontami.

Licencja

Easy Symbols & Icons jest publikowany na licencji GPLv3.

Napisy końcowe

Opracowane przez Farn – Cyfrowy Design Marki.