Pagar.me módulo para WooCommerce

Tags: ecommerce, e-commerce, store, sales, sell, shop, cart, checkout, woocommerce, pagarme, payments, creditcard

License: MIT

License URI: https://github.com/pagarme/woocommerce/blob/master/LICENSE

Módulo de integração da Pagar.me com o WooCommerce. Aceite pagamentos de cartão de crédito, pix, boleto, voucher e multimeios, e aumente a sua conversão.

Descrição

A inteligência do seu pagamento - Soluções focadas em aumentar sua conversão!

Pagamentos tem que ser fáceis. São muitos passos por trás de uma simples transação financeira. Mas o seu consumidor não precisa saber disso. Nossas soluções estão disponíveis para ajuda-lo a aumentar sua conversão e oferecer a melhor experiência no momento do pagamento para o seu cliente.

Contribuição

Se você está interessado em contribuir para o desenvolvimento deste projeto, ficamos felizes em receber sua ajuda! No contributing.md está o guia de como contribuir com o projeto.

Documentação de Filtros e Actions

Descubra como personalizar o comportamento do nosso plugin! Acesse nossas documentações abaixo e comece a realizar as modificações que deseja:

• Split

Compatibilidade

• Requer Wordpress 4.1 ou posterior para funcionar.
• Requer WooCommerce 3.9 ou posterior para funcionar.
• Requer versão do PHP maior ou igual a 7.1.

Instalação do plugin

• Envie os arquivos do plugin para a pasta wp-content/plugins, ou instale usando o instalador de plugins do WordPress.
• Ative o plugin.

Requerimentos

• Conta na Pagar.me
• WooCommerce

Desenvolvimento local

Este repositório inclui um ambiente Docker pronto para desenvolvimento (PHP 8.4 + Apache + XDebug 3, MariaDB 11 e phpMyAdmin) orquestrado via Makefile. Os arquivos do ambiente ficam em .dev/.

Pré-requisitos

• Docker (com docker compose v2)
• GNU Make

Subindo o ambiente pela primeira vez

make build      # build das imagens
make up         # sobe WP, MariaDB, phpMyAdmin + instala WooCommerce (latest) e ativa o plugin
make install    # composer install dentro do container (deps PHP do plugin)

make up invoca um container wp-cli que automaticamente:

• instala o WordPress (se ainda não estiver instalado);
• instala e ativa a versão latest do WooCommerce;
• importa os produtos de exemplo do WooCommerce (via wordpress-importer);
• ativa o plugin woo-pagarme-payments;
• garante que siteurl/home apontem para a URL configurada.

O script é idempotente — pode ser reexecutado a qualquer momento com make seed.

Acessos após o boot:

Serviço	URL	Credenciais
WordPress	http://woo.localhost	—
wp-admin	http://woo.localhost/wp-admin	admin / admin
phpMyAdmin	http://localhost:8081	root / root

woo.localhost resolve automaticamente para 127.0.0.1 no macOS e em Linux modernos (RFC 6761). Se não funcionar, adicione 127.0.0.1 woo.localhost no /etc/hosts.

Por padrão o WordPress sobe na porta 80 do host (sem suffix na URL). Se já tiver algo ouvindo lá, sobrescreva: WP_PORT=8080 WP_URL=http://woo.localhost:8080 make up.

Defaults do WordPress admin (WP_ADMIN_USER, WP_ADMIN_PASSWORD, WP_ADMIN_EMAIL, WP_TITLE) também podem ser sobrescritos via env vars na hora do make up / make seed.

Comandos do Makefile

Rode make (ou make help) para listar todos os comandos.

Comando	Descrição
make build	Build (ou rebuild) das imagens
make up	Sobe o ambiente + instala/ativa WooCommerce automaticamente
make seed	Reexecuta o init do WP (instala/ativa WordPress + WooCommerce, idempotente)
make down	Para os containers (volumes preservados)
make restart	down + up
make clean	Remove containers e volumes (apaga o WP instalado)
make ps	Status dos containers
make logs	Acompanha logs de todos os serviços
make logs-wp	Logs apenas do WordPress/Apache
make shell	Bash no container do WordPress
make shell-db	Cliente mysql no container do banco
make install	Roda composer install no plugin
make test	Roda PHPUnit (apenas os testes do plugin)
make phpcs	Roda PHPCS com WordPress Coding Standards
make xdebug-log	tail -f no log do XDebug

XDebug

Configurado em modo trigger (XDebug 3, porta 9003, idekey PHPSTORM). Só ativa quando você dispara explicitamente, evitando overhead em todas as requests.

Configuração no VS Code

1. Instale a extensão

Marketplace → instale PHP Debug (publisher: Xdebug, ID xdebug.php-debug).

2. Crie .vscode/launch.json na raiz do projeto

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003,
            "pathMappings": {
                "/var/www/html/wp-content/plugins/woo-pagarme-payments": "${workspaceFolder}"
            }
        }
    ]
}

Se quiser depurar também o WordPress core ou outros plugins, adicione mais entradas em pathMappings apontando para diretórios locais com aquele código.

3. Inicie o listener

Ctrl+Shift+D (ou Cmd+Shift+D no macOS) → selecione "Listen for Xdebug" → clique no botão ▶. A status bar fica laranja com "Listening on port 9003".

4. Dispare o trigger na request

Como o modo é trigger, o XDebug só conecta se a request sinalizar. Três formas:

• Browser (recomendado): instale a extensão Xdebug Helper (Chrome / Firefox), clique no ícone na barra → "Debug". Pronto — toda página de woo.localhost agora dispara.
• Query string: http://woo.localhost/?XDEBUG_TRIGGER=1
• curl: curl -b "XDEBUG_TRIGGER=1" http://woo.localhost/

5. Coloque um breakpoint e teste

Abra qualquer arquivo src/**/*.php, clique na margem para colocar um breakpoint, recarregue a página com o trigger ativo. A execução deve parar no breakpoint.

Troubleshooting

Acompanhe o log do XDebug com make xdebug-log enquanto dispara a request:

O que aparece no log	Diagnóstico	O que fazer
Nada / vazio	Trigger não chegou	Confirme cookie/query XDEBUG_TRIGGER
Could not connect to host.docker.internal:9003	VS Code não está ouvindo ou rede do container não alcança o host	(a) Inicie o listener no VS Code. (b) No Linux: descomente o bloco extra_hosts em .dev/docker-compose.yml
Connected to debugging client ... Sending init packet mas não para	pathMappings errado	Confirme que abriu o VS Code na raiz do plugin e que o caminho remoto bate com o do log

Linux: o host.docker.internal não existe nativamente. Descomente no .dev/docker-compose.yml o bloco:

extra_hosts:
  - "host.docker.internal:host-gateway"

Em macOS/Windows com Docker Desktop, não descomente — quebra a resolução nativa via vpnkit.

O xdebug.log_level está em 7 (verbose) por padrão para facilitar diagnóstico. Em uso normal você pode baixar para 0 em .dev/xdebug.ini se quiser reduzir o ruído no /tmp/xdebug.log.

Contribuidores

eduardobattisti	tiagopapile	gutobenn