FernandoAcosta.Netdocs

Funções utilitárias

2 min de leituraAtualizado há 5 dias

Funções utilitárias públicas do WC JadLog, em includes/core-functions.php. Estão sempre disponíveis quando o plugin está ativo.

Rastreio

wc_jadlog_get_tracking_codes( $order )

Devolve todos os códigos de rastreio gravados num pedido.

Parâmetros:

  • $order (WC_Order ou int) — pedido ou ID.

Retorna: array de strings.

$codes = wc_jadlog_get_tracking_codes( 123 );
// [ '12345678901234', '98765432109876' ]

wc_jadlog_update_tracking_code( $order, $tracking_code, $remove = false )

Adiciona ou remove um código de rastreio. Quando adiciona, dispara as mesmas notificações da inclusão manual no metabox (e-mail ao cliente, mudança de status se configurada, nota no pedido).

Parâmetros:

  • $order (WC_Order ou int).
  • $tracking_code (string).
  • $remove (bool) — true remove, false adiciona. Padrão: false.

Retorna: bool.

// Adicionar
wc_jadlog_update_tracking_code( 123, '12345678901234' );

// Remover
wc_jadlog_update_tracking_code( 123, '12345678901234', true );

wc_jadlog_trigger_tracking_code_email( $order, $tracking_code )

Reenvia o e-mail "código de rastreio" para o cliente, sem alterar nada no pedido. Útil quando o cliente perdeu o e-mail e você quer disparar de novo via código.

Parâmetros:

  • $order (WC_Order).
  • $tracking_code (string).
$order = wc_get_order( 123 );
wc_jadlog_trigger_tracking_code_email( $order, '12345678901234' );

wc_jadlog_get_tracking_code_url( $tracking_code )

URL do site da JadLog para acompanhar um código.

Parâmetros:

  • $tracking_code (string).

Retorna: string com a URL.

$url = wc_jadlog_get_tracking_code_url( '12345678901234' );
// https://www.jadlog.com.br/siteDpd/tracking.jad?cte=12345678901234

HTML completo de link clicável para a página de rastreio.

Parâmetros:

  • $tracking_code (string).
  • $order (WC_Order).
  • $text (string|false) — texto do link. Se false, usa o próprio código.
  • $class (string) — classe CSS do <a>.

Retorna: string HTML.

echo wc_jadlog_get_tracking_code_link(
    '12345678901234',
    $order,
    'Acompanhar entrega',
    'btn btn-rastreio'
);
// <a class="btn btn-rastreio" target="_blank" href="https://...">Acompanhar entrega</a>

Configuração e dados do plugin

wc_jadlog_get_settings()

Devolve todas as configurações salvas do plugin (Token, CNPJ, conta, contrato, configurações de rastreio, dados do remetente).

Retorna: array com as configurações ou array vazio se ainda não foi configurado.

$settings = wc_jadlog_get_settings();

if ( empty( $settings ) ) {
    error_log( 'WC JadLog ainda não foi configurado.' );
} else {
    error_log( 'Token JadLog: ' . $settings['token'] );
}

wc_jadlog_get_methods()

Lista os nomes de classe das modalidades disponíveis. Usado internamente pelo plugin pra registrar os métodos no WooCommerce, mas pode ser chamado por extensões.

Retorna: array de strings.

$methods = wc_jadlog_get_methods();
// [
//   'WC_JadLog_Shipping_Package',
//   'WC_JadLog_Shipping_Expresso',
//   'WC_JadLog_Shipping_Rodoviario',
//   ...
// ]

wc_jadlog_sanitize_postcode( $postcode )

Limpa um CEP, deixando só os números.

Parâmetros:

  • $postcode (string) — CEP em qualquer formato.

Retorna: string com apenas dígitos.

wc_jadlog_sanitize_postcode( '01310-100' ); // '01310100'
wc_jadlog_sanitize_postcode( '01.310-100' ); // '01310100'

Veja também

  • Hooks e filtros — pontos de extensão para alterar comportamento sem chamar funções diretamente.
  • REST API — para integração externa via HTTP.
Foi útil?