Documentation des symboles et icônes faciles

Vers le plugin

Easy Symbols & Icons permet la gestion et l'utilisation centralisées de polices d'icônes dans WordPress. Le plugin fournit un bloc Gutenberg ainsi qu'un shortcode et prend en charge la gestion des polices chargées et de leurs icônes.

Conditions préalables

• WordPress 6.0 ou supérieur
• PHP 8.0 ou supérieur

Installation

Le plugin est créé à partir du dépôt Git, puis installé dans WordPress sous forme de fichier ZIP.

Créer un plugin

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

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

Après une compilation réussie, le projet peut être compressé au format ZIP, puis téléchargé via le gestionnaire d'extensions WordPress.

Paramètres

Easy Symbols & Icons propose sa propre page de configuration dans l'interface d'administration de WordPress. Celle-ci s'accède via Page des paramètres modules enregistrés.

Général

Le domaine Général contient des informations générales et des instructions concernant le plugin. D'autres paramètres généraux peuvent y être gérés.

Sélectionner la police

À propos Sélectionner la police les polices d'icônes utilisées sur le site web sont gérées.

• Sélectionner des polices d'icônes à utiliser
• importer ses propres polices TTF
• importer des polices OTF personnalisées
• supprimer les polices inutiles
• Enregistrer les modifications

Après la gestion des polices, Easy Symbols & Icons génère un fichier CSS fusionné pour les polices d'icônes disponibles et l'intègre sur le site Web.

Polices d'icônes

Le plugin est conçu pour l'utilisation de différentes polices d'icônes. Les fichiers de polices sont gérés de manière centralisée et ensuite mis à disposition pour l'affichage des icônes sur le site web.

Formats de police pris en charge

• .ttf – Police TrueType
• .otf – Police OpenType

Le traitement des fichiers de polices s'effectue notamment via la bibliothèque FontLib intégrée.

Emplacement

Les ressources d'icônes gérées se trouvent dans le répertoire de téléchargement de WordPress dans le dossier icônes-eic classé.

wp-content/uploads/eics-icons/

Le plugin détermine automatiquement le chemin de téléversement réel et l'URL associée via wp_upload_dir().

Bloc Gutenberg

Easy Symbols & Icons présente le bloc Gutenberg eics-icon disponible.

Insérer une icône

1. Ouvrez l'éditeur Gutenberg.
2. Ajoutez le bloc eics-icon ajouter.
3. Sélectionnez l'icône souhaitée dans la liste des icônes disponibles.
4. Enregistrez ou publiez le contenu.

Le bloc est automatiquement enregistré via WordPress et est ensuite disponible dans l'éditeur de blocs.

Code court

En plus du bloc Gutenberg, le plugin enregistre le shortcode eics-icon.

[eics-icon]

Le code court permet d'afficher une icône même aux endroits où aucun bloc Gutenberg ne peut être utilisé.

Les paramètres concrets du code court sont définis par la mise en œuvre de eics_render_icon_shortcode défini.

Utilisation des icônes

Easy Symbols & Icons détecte les icônes réellement utilisées sur le site web. Cela permet d'analyser l'utilisation des icônes de manière centralisée.

La collecte s'exécute automatiquement sur différents contenus WordPress.

Articles et pages

Lors de l'enregistrement d'une contribution, l'utilisation des icônes du contenu respectif est mise à jour.

De plus, lors de la suppression d'une contribution, les informations d'utilisation associées sont mises à jour ou supprimées.

Navigations

Lors de la mise à jour d'un menu de navigation WordPress, le plugin restitue le menu et analyse les icônes qu'il contient.

Widgets

Les widgets sont également analysés lors de la mise à jour et du rendu pour détecter les icônes utilisées.

Modèles et parties de modèle

Lors de l'enregistrement de wp_template et wp_template_part l'utilisation des icônes du contenu respectif est également mise à jour.

API REST

Easy Symbols & Icons met à disposition sa propre API REST sous l'espace de noms easysymbolsicons/v1 Prêt.

Polices chargées

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

Le point de terminaison fournit les correspondances de glyphes de toutes les polices actuellement chargées.

Propriété	Valeur
Méthode	OBTENIR
Espace de noms	easysymbolsicons/v1
Route	/loaded-fonts
Authentification	Aucune

Icônes utilisées

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

L'endpoint renvoie les icônes actuellement enregistrées et utilisées.

Propriété	Valeur
Méthode	OBTENIR
Espace de noms	easysymbolsicons/v1
Route	/icônes-utilisées
Authentification	Aucune

Si l'utilisation de l'icône ne peut pas être renvoyée sous forme de tableau valide, le point de terminaison répond avec l'erreur Données de police invalides et du statut HTTP 500.

Initialisation automatique

Lors de l'initialisation de l'IconHandler, les répertoires requis sont vérifiés et créés si nécessaire. De plus, le fichier CSS unifié pour les polices d'icônes est généré et intégré.

L'initialisation centrale est effectuée via l' GestionnaireD'Icônes réalisé. Celui-ci est utilisé comme un Singleton, de sorte qu'une seule instance du gestionnaire est créée au cours d'une requête.

Activation du plugin

L'activation du plugin met à jour l'utilisation des icônes pour tous les contenus existants. Cela permet d'initialiser l'inventaire des utilisations.

Désactivation de plugin

Aucune action supplémentaire n'est actuellement exécutée lors de la désactivation du plugin.

Intégration de CSS et de polices

Easy Symbols & Icons génère un fichier CSS fusionné pour les polices d'icônes disponibles. Ce fichier CSS unifié est ensuite inclus pour l'utilisation des icônes.

Cela évite d'avoir à intégrer manuellement les définitions de polices individuelles dans le thème.

Structure technique

Le plugin est divisé en plusieurs composants :

Composant	Tâche
Blocs	Enregistre le bloc Gutenberg et le shortcode d'icône.
GestionnaireD'Icônes	Administration centralisée des icônes, des polices, du CSS et de l'utilisation des icônes.
Paramètres	Gestion des paramètres du plugin.
Page des paramètres	Fournit la page de réglages dans l'administration de WordPress.
RestHandler	Fournit les points de terminaison de l'API REST.
IconHandlerFontsTrait	Fonctions de gestion des polices.
IconHandlerUsageTrait	Fonctions de suivi de l'utilisation des icônes.
IconHandlerUtilsTrait	Fonctions auxiliaires pour le traitement des icônes.
IconHandlerCssTrait	Génération et gestion des fichiers CSS d'icônes.

Avis

La bonne utilisation dépend toujours du fait que l'icône souhaitée est présente dans une police activement chargée. Si plusieurs polices utilisent le même nom, il est recommandé d'utiliser la syntaxe complète avec le préfixe de police.

Avec Easy Symbols & Icons, vous obtenez une solution centralisée, performante et propre pour les polices d'icônes dans WordPress – avec un flux de travail Gutenberg, la prise en charge des codes courts et une gestion efficace des polices.

Licence

Easy Symbols & Icons est publié sous la licence GPLv3.

Crédits

Développé par Farn – Design de marque numérique.