Globale PHP-Funktionen für Produktdaten

Referenz aller globalen PHP-Funktionen von affiliate-toolkit: Titel, Preise, Links, Bilder und Angebote eines Produkts in Theme oder Plugin auslesen.

Neben Shortcodes und Vorlagen stellt affiliate-toolkit globale PHP-Funktionen bereit, die einzelne Werte eines Produkts liefern – Titel, Preis, Affiliate-Link, Bilder, Angebote. Nutze sie, wenn du eine eigene Ausgabe in einer Theme-Datei, einem Page-Builder-Element oder einem eigenen Plugin baust und die Daten außerhalb einer Vorlage brauchst.

Die Funktionen kommen aus dem Basis-Plugin. Schließ deinen Code in function_exists() ein, damit dein Theme nicht abstürzt, wenn das Plugin deaktiviert ist.

Der Parameter $id

Fast jede Funktion erwartet als ersten Parameter eine $id. Sie bestimmt, welches Produkt verwendet wird:

  • Leer – auf einer Produktseite das Produkt selbst, auf jedem anderen Beitrag dessen Hauptprodukt (oder, falls keines gesetzt ist, die Hauptliste).
  • Produkt-ID – dieses Produkt.
  • Listen-ID – das erste Produkt der Liste.
  • Slug oder Titel – das Produkt bzw. die Liste mit diesem Slug oder Titel.

Die Funktionen nutzen immer das Hauptangebot des Produkts. Shop-Funktionen erwarten stattdessen eine Shop-ID; übergibst du eine Produkt-ID, wird der Shop dieses Produkts verwendet.

Beispiele

<?php if ( function_exists( 'atkp_get_title' ) ) : ?>
    <a <?php echo atkp_get_productlink( 123 ); ?>>
        <?php echo esc_html( atkp_get_title( 123 ) ); ?>
    </a>
    <?php echo atkp_get_saleprice_formatted( 123, 'nur %s', 'Preis auf Anfrage' ); ?>
<?php endif; ?>

Die …link-Funktionen liefern die Attribute eines <a>-Tags (href, rel, target und Link-Tracking), keinen vollständigen Link. Setz sie wie oben gezeigt in das öffnende Tag.

// Hauptprodukt des aktuellen Beitrags
$price = atkp_get_saleprice();

// erstes Produkt der Liste mit der ID 456
$title = atkp_get_title( 456 );

// Produkt über den Slug
$image = atkp_get_mediumimageurl( 'nordklang-anc-700' );

// eigener Preisvergleich
foreach ( (array) atkp_get_offers( 123 ) as $offer ) {
    // $offer ist ein atkp_product_offer-Objekt
}

Liste der Funktionen

FunktionRückgabeBeschreibung
atkp_display_box( $ids, $template, $limit = 0, $field = '', $link = false, $content = '', $randomsort = false, $hidedisclaimer = false, $buttontype = 'notset', $tracking_id = '', $elementcss = '', $containercss = '', $ajax_mode = 'none' )stringKomplette HTML-Ausgabe einer Box oder Liste – das PHP-Gegenstück zum Shortcode [atkp].
atkp_get_product( $id = '' )atkp_product|nullDas Produktobjekt (Hauptangebot) zur Weiterverarbeitung.
atkp_get_shop( $id )atkp_shop|nullDas Shop-Objekt. Ist $id kein Shop, kommt der Shop des Produkts zurück.
atkp_get_formatter()atkp_formatterEin Formatter-Objekt mit Standardparametern, wie es in Blade-Vorlagen genutzt wird.
atkp_get_title( $id = '' )stringProdukttitel.
atkp_get_short_title( $id = '' )stringGekürzter Produkttitel.
atkp_get_featuretext( $id = '' )stringFeatures (HTML-Liste).
atkp_get_featuretext_short( $id = '' )stringFeatures, gekürzt.
atkp_get_descriptiontext( $id = '' )stringProduktbeschreibung.
atkp_get_descriptiontext_short( $id = '' )stringProduktbeschreibung, gekürzt.
atkp_get_infotext( $id = '' )stringInfotext (Preishinweis, Aktualisierungsdatum).
atkp_get_pro_list( $id = '', $content_mask = '%s' )stringVorteile; $content_mask formatiert jeden Eintrag.
atkp_get_contra_list( $id = '', $content_mask = '%s' )stringNachteile; $content_mask formatiert jeden Eintrag.
atkp_get_test_badge( $id = '' )stringTestergebnis-Siegel.
atkp_get_saleprice( $id = '' )floatVerkaufspreis als Zahl (0, wenn unbekannt).
atkp_get_saleprice_formatted( $id = '', $format = '%s', $emptytext = '' )stringFormatierter Verkaufspreis; $emptytext erscheint, wenn es keinen Preis gibt.
atkp_get_listprice( $id = '' )floatListenpreis als Zahl.
atkp_get_listprice_formatted( $id = '', $format = '%s', $emptytext = '' )stringFormatierter Listenpreis.
atkp_get_amount_saved( $id = '' )floatErsparnis als Zahl.
atkp_get_amount_saved_formatted( $id = '', $format = '%s' )stringFormatierte Ersparnis.
atkp_get_percentage_saved( $id = '' )floatErsparnis in Prozent als Zahl.
atkp_get_percentage_saved_formatted( $id = '', $format = '-%s%%' )stringFormatierte Ersparnis in Prozent, z. B. -15%.
atkp_get_baseprice( $id = '' )floatGrundpreis als Zahl.
atkp_get_baseprice_formatted( $id = '', $format = '(%s / %s)', $emptytext = '' )stringFormatierter Grundpreis mit Einheit.
atkp_get_unitprice( $id = '' )floatStückpreis als Zahl.
atkp_get_shipping( $id = '' )floatVersandkosten als Zahl.
atkp_get_shipping_formatted( $id = '', $format = '%s', $emptytext = '' )stringFormatierte Versandkosten.
atkp_get_producturl( $id = '' )stringAffiliate-URL des Produkts.
atkp_get_productlink( $id = '' )stringLink-Attribute (href, rel, target, Tracking) für ein <a>-Tag.
atkp_get_addtocarturl( $id = '' )stringWarenkorb-URL (sofern der Shop sie unterstützt).
atkp_get_addtocartlink( $id = '' )stringLink-Attribute für den Warenkorb-Link; sonst der Produktlink.
atkp_get_button_link( $id = '' )stringLink-Attribute für den Kaufen-Button, je nach Button-Einstellung.
atkp_get_button_text( $id = '', $shop_id = '' )stringButton-Text des Shops.
atkp_get_title_link( $id = '' )stringLink-Attribute für den Produkttitel.
atkp_get_customerreviewsurl( $id = '' )stringURL der Kundenbewertungen.
atkp_get_reviews_link( $id = '' )stringLink zu den Kundenbewertungen.
get_get_reviews_text( $id = '' )stringText mit der Anzahl der Bewertungen. Der ungewöhnliche Name bleibt für ältere Vorlagen erhalten.
atkp_get_primelogo( $id = '' )stringPrime-Logo, wenn das Angebot Prime ist.
atkp_get_smallimageurl( $id = '' )stringURL des kleinen Bilds.
atkp_get_mediumimageurl( $id = '' )stringURL des mittleren Bilds.
atkp_get_largeimageurl( $id = '' )stringURL des großen Bilds.
atkp_get_images( $id = '', $include_main_image = true, $max_images = 0 )array|nullAlle Bilder des Produkts (0 = ohne Begrenzung).
atkp_get_offers( $id = '', $include_main_offer = true, $max_offers = 0 )atkp_product_offer[]|nullAlle Angebote des Produkts für einen eigenen Preisvergleich.
atkp_get_custom_field( $id, $field_name )stringFormatierter Wert eines eigenen Felds (Modul Eigene Felder).
atkp_get_updatedate( $id = '' )stringDatum der letzten Aktualisierung.
atkp_get_updatetime( $id = '' )stringUhrzeit der letzten Aktualisierung.
atkp_get_disclaimer( $id = '', $disclaimertext = '' )stringDisclaimer-Text; $disclaimertext ersetzt den Standardtext.
atkp_get_product_page_url( $id = '' )string|nullURL der Produktseite (Modul Frontend-Produktseiten).
atkp_get_woocommerce_page_url( $id = '' )stringURL des verknüpften WooCommerce-Produkts.
atkp_get_shop_title( $shop_id = '' )stringName des Shops.
atkp_get_shop_logo( $shop_id = '' )stringShop-Logo als Bild-Tag.
atkp_get_shop_logo_url( $shop_id = '' )stringURL des Shop-Logos.

Fehlt am Produkt ein Wert (etwa kein Listenpreis), bekommst du einen leeren String, 0 bei Zahlen oder null bei Arrays. Übergib nur IDs, Slugs oder Titel, die es gibt – ein unbekannter Wert führt derzeit zu einem PHP-Fehler statt zu einem leeren Ergebnis.