Qué son y como usar los shortcodes

Los shortcodes del plugin PlantillasPDF permiten insertar contenido dinámico en las plantillas de documentos PDF. Se procesan durante la generación del PDF y se reemplazan por el contenido o formato especificado. Se puede usar exclusivamente en el texto final, texto de agradecimiento, texto pie de página y observaciones del documento.

Shortcodes Disponibles

1. ShortDateHour

Propósito: Inserta la fecha y hora actual en el documento.

Sintaxis:

[ShortDateHour format="formato" zone="zona_horaria"]

Parámetros:

format (opcional): Formato de fecha según la función format() de PHP. Por defecto usa el formato de FacturaScripts.
zone (opcional): Zona horaria válida de PHP (ej: America/New_York, Europe/Madrid).

Ejemplos:

Insertar fecha y hora actual con formato predeterminado:

[ShortDateHour]

Resultado: 2026-04-09 14:30:45

Insertar con formato personalizado:

[ShortDateHour format="d/m/Y H:i"]

Resultado: 09/04/2026 14:30

Insertar con zona horaria específica:

[ShortDateHour zone="America/New_York" format="d/m/Y H:i"]

Resultado: La hora en zona de Nueva York

2. ShortLink

Propósito: Crea un enlace HTML en el documento.

Sintaxis:

[ShortLink href="url" siteUrl="yes/no" class="clase" id="id" target="destino"]
  Texto del enlace
[/ShortLink]

Parámetros:

href (obligatorio): URL del enlace.
siteUrl (opcional): Si es yes, antepone la URL del sitio al href. Útil para enlaces internos.
class (opcional): Clase CSS para estilar el enlace.
id (opcional): Identificador HTML del elemento.
target (opcional): Comportamiento del enlace (_blank, _self, etc.).

Ejemplos:

Enlace simple a URL externa:

[ShortLink href="https://facturascripts.com"]
  Visita FacturaScripts
[/ShortLink]

Resultado: <a href="https://facturascripts.com">Visita FacturaScripts</a>

Enlace interno con URL relativa:

[ShortLink href="/dashboard" siteUrl="yes"]
  Ir al Dashboard
[/ShortLink]

Resultado: <a href="https://tupagina.com/dashboard">Ir al Dashboard</a>

Enlace con estilos CSS:

[ShortLink href="https://example.com" class="btn btn-primary" target="_blank"]
  Botón de acción
[/ShortLink]

Resultado: <a href="https://example.com" target="_blank" class="btn btn-primary">Botón de acción</a>

3. ShortImage

Propósito: Inserta una imagen en el documento desde un archivo adjunto o una URL.

Sintaxis:

[ShortImage idfile="id_archivo" src="url" class="clase" id="id" width="ancho" height="alto" alt="texto_alternativo" title="título" onlyUrl="yes/no"]

Parámetros:

idfile (opcional): ID del archivo adjunto en FacturaScripts.
src (opcional): URL directa de la imagen.
class (opcional): Clase CSS para estilar la imagen.
id (opcional): Identificador HTML del elemento.
width (opcional): Ancho de la imagen (en píxeles o unidades CSS).
height (opcional): Alto de la imagen (en píxeles o unidades CSS).
alt (opcional): Texto alternativo de la imagen.
title (opcional): Título que aparece al pasar el ratón.
onlyUrl (opcional): Si es yes, devuelve solo la URL en lugar de la etiqueta <img> completa.

Ejemplos:

Insertar imagen desde archivo adjunto:

[ShortImage idfile="12345"]

Resultado: <img src="url_del_archivo" ...>

Insertar imagen desde URL con dimensiones:

[ShortImage src="/imagenes/logo.png" width="200" height="100" alt="Logo de la empresa"]

Resultado: <img src="/imagenes/logo.png" width="200" height="100" alt="Logo de la empresa">

Insertar imagen con clases CSS:

[ShortImage src="/imagenes/firma.png" class="firma" width="150" height="50"]

Resultado: <img src="/imagenes/firma.png" class="firma" width="150" height="50">

Obtener solo la URL de un archivo adjunto:

[ShortImage idfile="12345" onlyUrl="yes"]

Resultado: https://tupagina.com/archivos/descarga-permanente/12345

4. ShortNewPage

Propósito: Inserta un salto de página en el documento PDF.

Sintaxis:

[ShortNewPage]

Parámetros:

Sin parámetros.

Ejemplos:

Crear un salto de página:

Contenido de la página 1

[ShortNewPage]

Contenido de la página 2

Resultado: El contenido se divide en dos páginas diferentes en el PDF generado.

Casos de Uso Comunes

Portada con fecha y logo

[ShortImage src="/imagenes/logo-empresa.png" width="150"]

Documento generado el [ShortDateHour format="d/m/Y"]

[ShortNewPage]

Firma y pie de página

Atentamente,

[ShortImage src="/firmas/firma_director.png" width="100" height="40"]

Para más información: [ShortLink href="/contacto" siteUrl="yes"]Contáctenos[/ShortLink]

Documento multi-página con referencias

Página 1 - Información principal

[ShortNewPage]

Página 2 - Términos y condiciones
[ShortLink href="https://ejemplo.com/terminos" target="_blank"]Ver términos completos[/ShortLink]

[ShortNewPage]

Página 3 - Anexos
[ShortImage idfile="anexo_1" width="400"]

Notas Importantes

Los shortcodes se procesan durante la generación del PDF usando la librería mPDF.
Los parámetros se especifican con comillas simples o dobles.
Los shortcodes son sensibles a mayúsculas y minúsculas.
Las imágenes deben tener un formato soportado (PNG, JPG, GIF, etc.).
Los saltos de página ([ShortNewPage]) se convierten a <pagebreak> internamente.

Anterior Siguiente