atpCustom Reference

atpCustom extends abstract_context
in package
Uses atpCustom_administration, datetime

Primary plugin file - ATP Custom Plugin for WordPress

Tags
category

WordPress Plugin

author

Kevin Burkholder KBurkholder@EarthAsylum.com

copyright

Copyright (c) 2024 American Telecast Products

version
24.0524.1
see
https://eacDoojigger.earthasylum.com/phpdoc/
used-by

AmericanTelecastProducts\atpCustom

uses
abstract_context

Table of Contents

$companyId  : string
$queryValues  : array<string|int, mixed>
$sourcing  : array<string|int, mixed>
__construct()  : void
factory/constructor method
addActionsAndFilters()  : void
Add filters and actions Called after instantiating, loading extensions and initializing
addShortcodes()  : void
Add shortcodes Called after instantiating, loading extensions and initializing
atpcustom_query_check()  : void
atpcustom_query_value - look for specific query values from $queryValues
cart()  : mixed
countryLookupTG()  : void
JavaScript country lookup and redirect using ipgeolocation API for Total Gym
default_offer_array()  : offer
get default offer values for 'get_offer' filter (offer_extension disabled)
default_product_meta_value()  : void
Retrieve product meta value for old key with new key (default_post_metadata)
enqueue_scripts()  : void
enqueue scripts
get_admin_bar_menu()  : void
process the admin bar item
getCart()  : object
Calculates and extends the WC Cart
getOrder()  : order
Get the order or parent order and extends with (previously) calculated cart values
google_dataLayer()  : string
google dataLayer for 'gtm4wp_compile_datalayer'
initialize()  : void
Called after instantiating and loading extensions
order()  : mixed
page_footer()  : void
page footer
page_header()  : void
page header
save_post_shop_order()  : void
when an order is created, update post meta values (save_post_shop_order)
set_admin_bar_menu()  : void
add the admin bar menu
update_product_meta_keys()  : void
Update (old to new) product meta keys
wordpress_init()  : void
Called after all plugins are loaded and wordpress is ready

Properties

$queryValues

public array<string|int, mixed> $queryValues = array( // in url as store as 'key' => 'keyid', 'cjevent' => 'cjevent', )

url query values stored, triggers 'atpCustom_query_value'

$sourcing

public array<string|int, mixed> $sourcing = null

sourcing object

Tags
deprecated

Methods

__construct()

factory/constructor method

public __construct(array<string|int, mixed> $header) : void

Call parent constructor; register options; set admin option filters

Parameters
$header : array<string|int, mixed>
Return values
void

atpcustom_query_check()

atpcustom_query_value - look for specific query values from $queryValues

public atpcustom_query_check(mixed $value, mixed $name) : void
Parameters
$value : mixed
$name : mixed
Return values
void

cart()

public cart([mixed $order = null ][, mixed $savedCart = false ]) : mixed
Parameters
$order : mixed = null
$savedCart : mixed = false
Return values
mixed

countryLookupTG()

JavaScript country lookup and redirect using ipgeolocation API for Total Gym

public countryLookupTG() : void
Return values
void

default_offer_array()

get default offer values for 'get_offer' filter (offer_extension disabled)

public default_offer_array([array<string|int, mixed> $offerArray = [] ]) : offer
Parameters
$offerArray : array<string|int, mixed> = []

default offer array

Tags
deprecated
4.2.1
Return values
offer

array

default_product_meta_value()

Retrieve product meta value for old key with new key (default_post_metadata)

public default_product_meta_value(mixed $value, mixed $object_id, mixed $meta_key, mixed $single, mixed $meta_type) : void

temporary

Parameters
$value : mixed
$object_id : mixed
$meta_key : mixed
$single : mixed
$meta_type : mixed
Return values
void

enqueue_scripts()

enqueue scripts

public enqueue_scripts() : void
Return values
void

get_admin_bar_menu()

process the admin bar item

public get_admin_bar_menu(object $admin_bar) : void
Parameters
$admin_bar : object

wp_admin_bar

Return values
void

getCart()

Calculates and extends the WC Cart

public getCart([int|object $order = null ][, bool $savedCart = false ]) : object
Parameters
$order : int|object = null

WC_Order

$savedCart : bool = false

get saved cart

Return values
object

WC_Cart extended

getOrder()

Get the order or parent order and extends with (previously) calculated cart values

public getOrder(int|object $order[, bool $savedCart = false ]) : order
Parameters
$order : int|object

WC_Order

$savedCart : bool = false

get saved cart

Return values
order

object

google_dataLayer()

google dataLayer for 'gtm4wp_compile_datalayer'

public google_dataLayer(mixed $dataLayer) : string
Parameters
$dataLayer : mixed
Return values
string

data layer script tag

initialize()

Called after instantiating and loading extensions

public initialize() : void

Add standard options

Return values
void

order()

public order(mixed $order[, mixed $savedCart = false ]) : mixed
Parameters
$order : mixed
$savedCart : mixed = false
Return values
mixed

page footer

public page_footer() : void
Return values
void

page_header()

page header

public page_header() : void
Return values
void

save_post_shop_order()

when an order is created, update post meta values (save_post_shop_order)

public save_post_shop_order(object $order[, bool $update = false ]) : void
Parameters
$order : object

WC_Order or order id

$update : bool = false

true if updating order

Return values
void

set_admin_bar_menu()

add the admin bar menu

public set_admin_bar_menu(object $admin_bar) : void
Parameters
$admin_bar : object

wp_admin_bar

Return values
void

update_product_meta_keys()

Update (old to new) product meta keys

public update_product_meta_keys(int $product_id) : void

temporary

Parameters
$product_id : int
Return values
void

wordpress_init()

Called after all plugins are loaded and wordpress is ready

public wordpress_init(mixed $vars) : void
Parameters
$vars : mixed
Return values
void

Search results