Docket dla deweloperów

• Dotyczy wersji 0.5.1
• Zaktualizowano 6.10.2026
• 11 min czytania

Filtry

NIP ze starszego pola

Sklep przed Docket trzymał NIP pod innym kluczem. Filtr zwraca stary NIP, gdy nowy jest pusty.

add_filter( 'docket_order_nip', function ( $nip, $order ) {
	if ( '' === $nip && $order instanceof WC_Order ) {
		$nip = preg_replace( '/\D+/', '', (string) $order->get_meta( '_stary_nip' ) );
	}
	return $nip;
}, 10, 2 );

Wymuszenie kasy blokowej

Przydaje się w sklepie bez strony kasy, który korzysta wyłącznie ze Store API.

add_filter( 'docket_block_checkout', '__return_true' );

Własna zgoda w rejestrze

W kasie klasycznej $data to dane formularza. W kasie blokowej to tablica ['docket_marketing' => bool, 'docket_source' => 'store-api'].

add_filter( 'docket_checkout_consents', function ( $entries, $order, $data ) {
	$entries[] = \Docket\Consents\Registry::entry(
		'sms',
		! empty( $data['moja_zgoda_sms'] ),
		'Chcę dostawać SMS o statusie zamówienia'
	);
	return $entries;
}, 10, 3 );

Skrót wersji dla innego kreatora stron

add_filter( 'docket_document_content', function ( $tresc, $page ) {
	if ( '' === trim( $tresc ) ) {
		$tresc = (string) get_post_meta( $page->ID, '_moj_kreator_dane', true );
	}
	return $tresc;
}, 10, 2 );

Adres IP za Cloudflare

Używaj nagłówka tylko wtedy, gdy serwer przyjmuje ruch wyłącznie przez tego pośrednika. Inaczej nagłówek może podać każdy.

add_filter( 'docket_consent_ip', function ( $ip ) {
	$cf = $_SERVER['HTTP_CF_CONNECTING_IP'] ?? '';
	return filter_var( $cf, FILTER_VALIDATE_IP ) ? $cf : $ip;
} );

Baner dla zewnętrznego narzędzia

Baner pokaże się bez identyfikatorów GA4 i piksela. Narzędzie włączasz po zdarzeniu docket:zgody.

add_filter( 'docket_ask_consent', '__return_true' );

Zgody z banera motywu

Gdy masz już własny baner i gtag, Docket może tylko wysyłać zdarzenia e-commerce. Strona musi wtedy podać stan zgody przez window.docketZgody.stan() i ogłaszać zdarzenie docket:zgody po każdej decyzji.

add_filter( 'docket_external_consent', '__return_true' );

window.docketZgody = {
	stan: function () {
		// null = brak decyzji; zdarzenia czekają w pamięci strony.
		return mojBaner.decyzja() ? { analityka: mojBaner.statystyki(), marketing: mojBaner.reklamy() } : null;
	}
};
mojBaner.poZapisie( function ( z ) {
	document.dispatchEvent( new CustomEvent( 'docket:zgody', { detail: { analityka: z.statystyki, marketing: z.reklamy } } ) );
} );

Feed: cena, wykluczenia, GTIN

// Bez produktów z kategorii „outlet”.
add_filter( 'docket_feed_include_product', function ( $dolaczyc, $produkt ) {
	$id = $produkt->get_parent_id() ? $produkt->get_parent_id() : $produkt->get_id();
	return $dolaczyc && ! has_term( 'outlet', 'product_cat', $id );
}, 10, 2 );

// EAN z własnego pola, gdy pole WooCommerce jest puste.
add_filter( 'docket_feed_gtin', function ( $gtin, $produkt ) {
	return '' !== $gtin ? $gtin : preg_replace( '/\D+/', '', (string) $produkt->get_meta( '_ean' ) );
}, 10, 2 );

// Bez cen promocyjnych w Merchant Center.
add_filter( 'docket_feed_price', function ( $ceny, $produkt ) {
	$ceny['sale_price'] = 0;
	return $ceny;
}, 10, 2 );

Komunikaty walidacji

add_filter( 'docket_validation_messages', function ( $map ) {
	$map['%s is a required field.'] = 'Pole %s jest wymagane.';
	return $map;
} );

Akcje

add_action( 'docket_feed_item', function ( $produkt, $rodzic ) {
	$kategoria = (string) $produkt->get_meta( '_google_category' );
	if ( '' !== $kategoria ) {
		printf( "<g:google_product_category><![CDATA[%s]]></g:google_product_category>\n", esc_html( $kategoria ) );
	}
}, 10, 2 );

Klucze meta

Wpis rejestru zgód ma postać:

array(
	'key'      => 'terms',               // terms, privacy, marketing albo własny
	'accepted' => true,
	'label'    => 'Akceptacja regulaminu',
	'at'       => '2026-10-01T09:15:00+00:00',
	'ip'       => '203.0.113.7',
	'document' => array(
		'id'       => 12,
		'title'    => 'Regulamin',
		'modified' => '2026-09-30 18:02:11', // post_modified_gmt
		'hash'     => 'a3f9c21e0b7d4e55',    // 16 znaków SHA-256 treści
	),
)

Tabela licznika

Licznik numeracji leży w tabeli {prefiks}docket_sequence, tworzonej przy aktywacji i po aktualizacji wtyczki. Wersję schematu trzyma opcja docket_seq_table_version.

Kolejna wartość powstaje jednym zapytaniem INSERT … ON DUPLICATE KEY UPDATE z LAST_INSERT_ID(), a GREATEST() pilnuje numeru początkowego. Zwiększenie i odczyt to jedna operacja w bazie, związana z połączeniem. Numer nadawany jest na akcji woocommerce_new_order z priorytetem 5.

Pola dodatkowe kasy blokowej

Pola rejestrowane są na woocommerce_init przez woocommerce_register_additional_checkout_field(), tylko gdy WooCommerce ma wersję 9.9 lub nowszą i kasa jest blokowa.

Warunki zapisane są jako reguły JSON Schema w opcjach required i hidden. Kopię wartości pod klucze z ustawień robi akcja woocommerce_set_additional_field_value, także przy edycji zamówienia w panelu. Brak nazwy firmy przy fakturze zatrzymuje złożenie zamówienia wyjątkiem RouteException z kodem docket_brak_firmy.

REST API

Docket dopisuje pola do odpowiedzi zamówienia w REST API WooCommerce:

• docket_nip, docket_wants_invoice, docket_order_number: przy włączonym module danych do faktury;
• docket_consents: przy włączonym module zgód.

Metody publiczne

Opcje

Ustawienia leżą w tabeli opcji z przedrostkiem docket_. Włączniki modułów: docket_numbering_enabled, docket_invoice_enabled, docket_consents_enabled, docket_a11y_enabled, docket_feed_enabled (wartości yes albo no). Pozostałe: docket_number_format, docket_number_padding, docket_number_reset, docket_number_start, docket_invoice_label, docket_invoice_nip_meta, docket_invoice_wants_meta, docket_marketing_consent, docket_marketing_label, docket_register_terms, docket_klauzula_enabled, docket_administrator, docket_klauzula_zakup, docket_klauzula_konto, docket_klauzula_kontakt, docket_ga4_id, docket_pixel_id, docket_gsc_token, docket_zgody_tryb, docket_zgody_odnosnik, docket_baner_tytul, docket_baner_opis, docket_feed_brand, docket_feed_token, docket_license_key.

JavaScript na stronie

• window.docketZgody.stan() zwraca { analityka, marketing } albo null.
• window.docketZgody.zapisz( { analityka, marketing } ), .wszystko(), .niezbedne() zapisują decyzję.
• Zdarzenie docket:zgody na document niesie decyzję w detail.
• Atrybut data-docket-zgody-otworz na dowolnym elemencie otwiera baner.

Stałe

DOCKET_VERSION, DOCKET_FILE i DOCKET_PATH definiuje wtyczka. DOCKET_LICENSE_API możesz zdefiniować w wp-config.php, żeby wskazać inny serwer licencji, na przykład testowy.

Ostatnia zmiana: 6.10.2026, wersja 0.5.1Zgłoś błąd w tej stronie