Atualizado em: 20 de outubro de 2025

Documentação: PPDF

Pedidos em PDF para WooCommerce (WooTatitas) — Guia de Integração para Desenvolvedores

Guia rápido para programadores que desejam usar este plugin como base em seus projetos.

Aviso importante

Este plugin pode mudar funcionalidades sem aviso prévio para acompanhar atualizações do WooCommerce.

Toda customização é de responsabilidade do desenvolvedor. Não edite os arquivos originais do plugin. Faça suas alterações em código externo:

um plugin próprio (preferencialmente must‑use),
um plugin adicional do seu projeto, ou
o functions.php de um tema filho.
Utilize hooks (actions/filters) documentados. Alterações diretas no plugin serão sobrescritas em atualizações.

1) Capacidades funcionais

Geração de documentos PDF para pedidos WooCommerce (recibo, etiqueta de envio, declaração de conteúdo e comprovante de embalagem);
Renderização automática com base nos dados do pedido e nos templates configurados;
Formatos suportados: A4, A6, 100×150 mm (etiqueta térmica) e PDF digital padrão;
Módulos independentes por tipo de documento, permitindo ativar/desativar conforme necessidade.
Geração manual (botão no admin) e geração programática via hooks/funções públicas;
Suporte a QR Codes e códigos de barras, inserção automática em documentos compatíveis;
Geração inline (visualização) ou download direto; possibilidade de envio por e-mail via filtro do WooCommerce;
Não depende de API externa: todos os documentos são montados localmente a partir dos metadados do pedido;
Proteções: sanitização dos dados antes da renderização e validações básicas para formatos e permissão de acesso.

2) Escopo de produto

Compatível com pedidos de qualquer tipo de produto (simples, variável, virtual, baixável). Os documentos são por pedido, não por item e cada pedido gera um conjunto coerente de PDFs. Pedidos com múltiplos envios: cada módulo pode incluir várias páginas ou etiquetas para os itens do pedido. Não interfere em cálculos de frete, impostos ou cupons e apenas lê as informações existentes no pedido. Totalmente compatível com status customizados do WooCommerce; não altera fluxos de compra ou checkout.

3) Painel e governança de UI

Área de administração no menu WooCommerce → Pedidos: Botões de ação para gerar/baixar cada tipo de documento (conforme módulos ativos);
Setup Wizard (assistente inicial) para configurar dimensões e preferências básicas de layout.
Página de configurações gerais (menu Configurações → Pedidos em PDF):
– Ativar/desativar módulos individuais (recibo, etiqueta, declaração, etc.)
– Escolher formatos de página padrão
– Opções de exibição de QR/barcode;
Logs e sistema: painel opcional com checagem de requisitos (bibliotecas, permissões de escrita, etc.);
Todas as ações administrativas protegidas por nonce e verificação de permissão do usuário (capabilities).

4) Comportamento no front

O plugin não altera o checkout nem adiciona elementos visuais no front público por padrão. PDFs podem ser disponibilizados ao cliente via link no “Minha Conta” do WooCommerce ou e-mail de pedido, dependendo das configurações e hooks aplicados. As rotas de geração são restritas por autenticação e checagem de permissão (somente cliente dono do pedido ou administrador). Mensagens de erro amigáveis em caso de acesso indevido ou documento inexistente.

5) Sinais e pontos de integração

wootatitas_ppdf_register_document_type: registra um novo tipo de documento.
wootatitas_ppdf_template_path: permite sobrescrever o caminho de template antes da renderização.
wootatitas_ppdf_render_context: altera o array de dados enviado ao template antes do PDF ser gerado.

Armazenamento: os documentos são gerados dinamicamente; metadados e cache local (quando habilitado) são mantidos em chaves internas não públicas.

Extensibilidade: é possível adicionar novos módulos (por exemplo, uma fatura custom) com poucas linhas de código, registrando o tipo via action.

As templates podem ser substituídas no tema (/wootatitas-ppdf/), respeitando a hierarquia de filtros do plugin.

6) Logs & debug

Logs opcionais: podem ser habilitados via configuração administrativa;
Registros incluem eventos como: inicialização de módulo, geração de documento, erro de renderização e salvamento de configurações;
Os arquivos ficam em diretório protegido dentro do plugin e não são acessíveis publicamente;
Modo debug imprime dados adicionais no log do WordPress (wp-content/debug.log) quando o WP_DEBUG está ativo.

7) Boas práticas de extensão

Idempotência: evite gerar documentos duplicados; use verificações antes de registrar saídas adicionais.
Sanitização e escape: sempre trate dados vindos do pedido antes de exibir em templates customizados.
Hooks e filtros: prefira actions/filters para injetar dados ou alterar comportamento; não modifique diretamente arquivos do núcleo do plugin.
Templates: mantenha apenas lógica de apresentação (sem consultas diretas ao banco).
Performance: se for gerar documentos em lote, use filas assíncronas ou agendamentos em vez de loops diretos.
Relatórios/integrações ERP: acesse dados de pedido pelo WooCommerce e gere PDFs via API pública do plugin; não replique a lógica de renderização interna.

Como instalar

Veja nosso guia de como instalar nosso plugin:

Compre nosso plugin

Gostou do que viu? Compre o nosso plugin:

Direto ao ponto

Sem enrolação

Comercializamos plugins na esperança de que seja útil, porém, é importante observar que ele é fornecido SEM NENHUMA GARANTIA inclusive sem a garantia implícita de ADEQUAÇÃO A UM DETERMINADO FIM.

Estamos sempre prontos para aprimorar nosso plugin e personalizá-lo de acordo com suas necessidades específicas. Não hesite em nos contatar a qualquer momento, estamos aqui para ajudá-lo.