Documentación de Easy Symbols & Icons

Ir al plugin

Easy Symbols & Icons permite la gestión y el uso centralizados de fuentes de iconos en WordPress. El plugin ofrece un bloque de Gutenberg y un código corto (shortcode), y se encarga de la gestión de las fuentes cargadas y de sus iconos.

Requisitos

• WordPress 6.0 o superior
• PHP 8.0 o superior

Instalación

El plugin se crea a partir del repositorio de Git y luego se instala en WordPress como un archivo ZIP.

Crear un complemento

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

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

Después de una compilación exitosa, el proyecto se puede empaquetar como un archivo ZIP y luego cargarse a través del administrador de complementos de WordPress.

Ajustes

Easy Symbols & Icons proporciona su propia página de configuración en el backend de WordPress. Esta se accede a través de la Página de configuración plugins registrados.

General

El área General contiene información general e indicaciones sobre el plugin. Allí se pueden gestionar otras configuraciones generales.

Seleccionar fuente

Acerca de la sección Seleccionar fuente se gestionan las fuentes de iconos utilizadas en el sitio web.

• Seleccionar fuentes de iconos para usar
• subir fuentes TTF propias
• subir fuentes OTF propias
• eliminar fuentes no necesarias
• Guardar cambios

Después de administrar las fuentes, Easy Symbols & Icons genera un archivo CSS combinado para las fuentes de iconos disponibles y lo integra en el sitio web.

Fuentes de iconos

El complemento está diseñado para el uso de diferentes fuentes de iconos. Los archivos de fuentes se gestionan de forma centralizada y posteriormente se proporcionan para la visualización de iconos en el sitio web.

Formatos de fuentes compatibles

• .ttf – Fuente TrueType
• .otf – Fuente OpenType

El procesamiento de los archivos de fuentes se realiza, entre otros, a través de la biblioteca FontLib integrada.

Ubicación

Los recursos de iconos gestionados se encuentran en el directorio de subidas de WordPress en la carpeta iconos-eics archivado.

wp-content/uploads/eics-icons/

El plugin determina la ruta de carga real y la URL correspondiente automáticamente mediante wp_upload_dir().

Bloque de Gutenberg

Easy Symbols & Icons presenta el bloque Gutenberg icono de eics disponible.

Insertar icono

1. Abra el editor de Gutenberg.
2. Agregue el bloque icono de eics agregar.
3. Seleccione el icono deseado de la selección de iconos disponible.
4. Guarde o publique el contenido.

El bloque se registra automáticamente a través de WordPress y luego está disponible en el editor de bloques.

Código corto

Además del bloque de Gutenberg, el plugin registra el código corto icono de eics.

[eics-icon]

El código corto permite la visualización de un icono incluso en lugares donde no se puede utilizar un bloque de Gutenberg.

Los parámetros concretos del código corto vienen determinados por la implementación de eics_render_icon_shortcode definido.

Uso de iconos

Easy Symbols & Icons registra qué iconos se utilizan realmente en el sitio web. Esto permite evaluar de forma centralizada el uso de los iconos.

La captura se ejecuta automáticamente en varios contenidos de WordPress.

Entradas y páginas

Al guardar una entrada, se actualiza el uso del icono del contenido respectivo.

Además, al eliminar una publicación, la información de uso correspondiente se actualiza o se elimina.

Navegación

Al actualizar un menú de navegación de WordPress, el plugin renderiza el menú y analiza los iconos que contiene.

Widgets

También los widgets se analizan en busca de iconos utilizados durante la actualización y el renderizado.

Plantillas y partes de plantilla

Al guardar wp_template y wp_template_part también se actualiza el uso de iconos del contenido respectivo.

API REST

Easy Symbols & Icons ofrece su propia API REST bajo el espacio de nombres easysymbolsicons/v1 listo.

Fuentes cargadas

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

El endpoint proporciona las asignaciones de glifos de todas las fuentes cargadas actualmente.

Propiedad	Valor
Método	OBTENER
Espacio de nombres	easysymbolsicons/v1
Ruta	/fuentes-cargadas
Autenticación	Ninguna

Iconos utilizados

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

El endpoint proporciona los iconos utilizados registrados actualmente.

Propiedad	Valor
Método	OBTENER
Espacio de nombres	easysymbolsicons/v1
Ruta	/iconos-usados
Autenticación	Ninguna

Si no se puede devolver el uso del icono como un array válido, el endpoint responde con el error Datos de fuente no válidos y el estado HTTP 500.

Inicialización automática

Durante la inicialización del IconHandler se comprueban los directorios necesarios y se crean si es necesario. Además, se genera e integra el archivo CSS unificado para las fuentes de iconos.

La inicialización central se realiza a través de la ControladorDeIconos ejecutado. Este se utiliza como un Singleton, de modo que solo se crea una instancia del controlador dentro de una solicitud.

Activación de complementos

Al activar el plugin, se actualizará el uso de iconos para todos los contenidos existentes. Esto establecerá el inventario de uso inicial.

Desactivación de complementos

Actualmente no se realiza ninguna acción adicional al desactivar el complemento.

CSS y la integración de fuentes

Easy Symbols & Icons genera un archivo CSS combinado para las fuentes de iconos disponibles. Este archivo CSS unificado se incluye posteriormente para el uso de los iconos.

Esto evita que las definiciones de fuentes individuales tengan que integrarse manualmente en el tema.

Estructura técnica

El complemento está dividido en varios componentes:

Componente	Tarea
Bloques	Registra el bloque de Gutenberg y el código corto de iconos.
ControladorDeIconos	Administración central de iconos, fuentes, CSS y uso de iconos.
Ajustes	Gestión de la configuración de los complementos.
Página de configuración	Proporciona la página de ajustes en el backend de WordPress.
ControladorRest	Proporciona los endpoints de la API REST.
IconHandlerFontsTrait	Funciones de gestión de fuentes.
IconHandlerUsageTrait	Funciones para registrar el uso de iconos.
IconHandlerUtilsTrait	Funciones auxiliares para el procesamiento de iconos.
IconHandlerCssTrait	Generación y gestión de los archivos CSS de iconos.

Aviso

El uso correcto siempre depende de si el icono deseado está presente en una fuente cargada activamente. Si varias fuentes usan el mismo nombre, se recomienda utilizar la sintaxis completa con el prefijo de fuente.

Con Easy Symbols & Icons obtienes una solución centralizada, de alto rendimiento y limpia para fuentes de iconos en WordPress, con flujo de trabajo de Gutenberg, soporte para shortcodes y gestión eficiente de fuentes.

Licencia

Easy Symbols & Icons se publica bajo la GPLv3.

Créditos

Desarrollado por Farn – Diseño de marca digital.