atpCustom Reference

bazaarvoice_extension extends abstract_extension
in package

Extension: bazaarvoice_extension - bazaarvoice integration - ATP Custom Plugin for WordPress

Tags
see
https://knowledge.bazaarvoice.com/wp-content/conversations/en_US/Display/bvseo.html
see
https://knowledge.bazaarvoice.com/wp-content/conversations/en_US/Collect/bvpixel.html
see
https://eacDoojigger.earthasylum.com/phpdoc/
category

WordPress Plugin

author

Kevin Burkholder KBurkholder@EarthAsylum.com

copyright

Copyright (c) 2024 American Telecast Products

version
4.x
used-by

\EarthAsylumConsulting\abstract_core

uses
abstract_extension

Table of Contents

VERSION  = '24.0413.1'
__construct()  : void
constructor method
addActionsAndFilters()  : void
Add filters and actions - called from main plugin
addShortcodes()  : void
Add plugin shortcodes
bvDivCallback()  : void
BazaarVoice shortcode callback
getInlineRatings()  : string
get the JS inline-ratings code
getInlineRatings_action()  : string
get the JS inline-ratings code
getJsQandA()  : string
get only the JS review code
getJsReviews()  : string
get only the JS review code
getLeaderboard()  : string
get the JS Leaderboard code
getQandA()  : string
get the SEO & JS getQandA code
getReviews()  : string
get the SEO & JS review code
getRoiBeacon()  : string
get the confirmation ROI beacon
getScriptTag()  : string
get the bvapi.js script tag
getSeoQandA()  : string
get the SEO Q and A code
getSeoReviews()  : string
get only the SEO review code
initialize()  : void
initialize method - called from main plugin
page_content_tag()  : void
page body top
page_footer_tag()  : void
page body end
page_script_tag()  : void
page head
woocommerce_thankyou()  : string
woocommerce_thankyou - confirmation

Constants

Methods

__construct()

constructor method

public __construct(object $plugin) : void
Parameters
$plugin : object

main plugin object

Return values
void —

addActionsAndFilters()

Add filters and actions - called from main plugin

public addActionsAndFilters() : void
Return values
void —

bvDivCallback()

BazaarVoice shortcode callback

public bvDivCallback([mixed $atts = null ][, mixed $content = null ][, mixed $tag = '' ]) : void
Parameters
$atts : mixed = null
$content : mixed = null
$tag : mixed = ''
Return values
void —

getInlineRatings()

get the JS inline-ratings code

public getInlineRatings([string|array<string|int, mixed> $products = '' ]) : string
Parameters
$products : string|array<string|int, mixed> = ''
  • the product code(s) of this products page (defaults to $this->defaults['product_id'])
Return values
string —
  • the JavaScript inline-ratings output

getInlineRatings_action()

get the JS inline-ratings code

public getInlineRatings_action([string|array<string|int, mixed> $products = '' ]) : string
Parameters
$products : string|array<string|int, mixed> = ''
  • the product code(s) of this products page (defaults to $this->defaults['product_id'])
Return values
string —
  • the JavaScript inline-ratings output

getJsQandA()

get only the JS review code

public getJsQandA([string $show = '' ]) : string
Parameters
$show : string = ''
  • the name of a JavaScript callback function
Return values
string —
  • the JavaScript review output

getJsReviews()

get only the JS review code

public getJsReviews([string $show = '' ]) : string
Parameters
$show : string = ''
  • the name of a JavaScript callback function
Return values
string —
  • the JavaScript review output

getLeaderboard()

get the JS Leaderboard code

public getLeaderboard() : string
Return values
string —
  • the JavaScript Leaderboard output

getQandA()

get the SEO & JS getQandA code

public getQandA([string $show = '' ]) : string
Parameters
$show : string = ''
  • the name of a JavaScript callback function
Return values
string —
  • the SEO and JavaScript review output

getReviews()

get the SEO & JS review code

public getReviews([string $show = '' ]) : string
Parameters
$show : string = ''
  • the name of a JavaScript callback function
Return values
string —
  • the SEO and JavaScript review output

getRoiBeacon()

get the confirmation ROI beacon

public getRoiBeacon([mixed $order = null ]) : string
Parameters
$order : mixed = null
Return values
string —
  • the JavaScript <script> tag used in the confirmation field

getScriptTag()

get the bvapi.js script tag

public getScriptTag([string $product = null ][, string $zone = null ][, string $client = null ]) : string
Parameters
$product : string = null
  • the product code of this product page (defaults to $this->defaults['product_id'])
$zone : string = null
  • the deployment zone of this product page (defaults to $this->defaults['deployment_zone_id'])
$client : string = null
  • the client name as used by BazaarVoice (defaults to $this->clientName set in constructor)
Return values
string —
  • the script tag(s)

getSeoQandA()

get the SEO Q and A code

public getSeoQandA() : string
Return values
string —
  • the SEO Q and A output

getSeoReviews()

get only the SEO review code

public getSeoReviews() : string
Return values
string —
  • the SEO review output

initialize()

initialize method - called from main plugin

public initialize() : void
Return values
void —

woocommerce_thankyou()

woocommerce_thankyou - confirmation

public woocommerce_thankyou(mixed $orderId) : string
Parameters
$orderId : mixed
Return values
string —

Search results