GB Theme Doc

Documentation

Functions

Function to retrive Cookie Popup

cookie_popup() : mixed

This function it's used by theme to set cookie popup using ACF fields. Actually the fields are hardcoded:

  • opt_privacy_popup_text
  • opt_privacy_popup_title
  • opt_privacy_popup_link
Todo

Remove hardcoded fields

To refactor. Code a stand alone version

Create a gallery with a given ACF gallery fields

gallery([array<string|int, mixed> $args = null ]) : mixed

Return Html output of different type of galleries, from a specific acf gallery field or a group of fields

Parameters
$args ( array<string|int, mixed> )

Gallery Settings

$args['field'] ( string|array<string|int, mixed> )

ACF field ora array of field for Images source. Complex field will be parsed with field_parse() @param String|Array $args['field'] Gallery array @param String $args['gallery'] Gallery type. Avable type: boxed, slide, full-slide, vertical

$args['id'] ( string )

Gallery ID. Generate ids for images too.

$args['button'] ( string )

Button class, if empty button dosen't renderize

$args['nav'] ( string )

full | true . Buttons navigation class. if empty buttons dosen't renderize

$args['slide'] ( string )

Enable Slide support or disable it

$args['close'] ( string )

Buttons close class

$args['size'] ( string )

Image size thumb|medium|large|full (Default: large)

$args['inner'] ( string )

Inner wrapper class

$args['item'] ( string )

Item gallery class

$args['capiton'] ( string )

Add caption box indicating a class to associate

$args['description'] ( string )

Add caption description box

$args['window'] ( string )

Add target gallery window id for gallery hendler attribute

$args['attr'] ( string )

Gallery list item attribute

Todo

Button close to improve

Use
field_parse()

to parse ACF fields

field_exists()

to check ACF fields existences

map()

Create a map with a given ACF gallery fields

map([array<string|int, mixed> $args = null ]) : mixed

Return an Open Layers Map , from a specific acf gallery field or a group of fields with different settings

Parameters
$args ( array<string|int, mixed> )

Map Settings

 - 'field'           _(String)_ ACF field for Map coordinates. Helper field parser included
 - 'field_option'    _(String)_ ACF field in Option for Map coordinates

'cat_class' (String) Select taxonomy term to fill marker class. Usefull for filtering - 'group' (Array) Settings for group of coordinates - 'field' (String) ACF field for marker coordinates - 'taxonomy' (String) Taxonomy for markers query - 'category' (String) Category name for markers query - 'type' (String) Post type for markers query - 'height' (String) Container frame height in px, vh or % - 'width' (String) Container frame width in px, vh or % - 'marker' (String) Markers url - 'link' (String) Map link out on mobile. Touch event will be disabled - 'style' (String) Link to https://www.maptiler.com/ style.json api for customizing map styles e.g. https://api.maptiler.com/maps/be25dffd-a532-45e6-972a-fcab2de4f806/style.json?key=tRwmEiuQArtUe2CEOb6U - 'popup' (String) Popup id attribute. It'will be enabel popup - 'controls' (Array) Disable Specific map controls - 'click' (Boolean) Set double Click Zoom - 'drag' (Boolean) Set drag and drop and drag pan - 'key' (Boolean) - 'scroll' (Boolean) - 'pointer' (Boolean) - 'select' (Boolean) - 'buttons' (Boolean)

Todo

Remove hardcoded in popup parts, remove harcoded fields

DIfferent map id

Rewrite params in doc

mini_cart()

Woocommerce mini cart menu

mini_cart([array<string|int, mixed> $args = null ]) : mixed

Return an ajax woocommerce mini cart button within a counter. You can also choose to enable or disable the mini cart preview.

Parameters
$args ( array<string|int, mixed> )

Mini cart Settings

$args['preview'] ( bool )

Enable mini cart preview

scripts()

scripts([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

share()

share([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

style()

style([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

my_acf_settings_url()

my_acf_settings_url(mixed $url) : mixed
Parameters
$url ( mixed )

my_acf_settings_show_admin()

my_acf_settings_show_admin(mixed $show_admin) : mixed
Parameters
$show_admin ( mixed )

my_acf_google_map_api()

my_acf_google_map_api(mixed $api) : mixed
Parameters
$api ( mixed )

register_my_menus()

register_my_menus() : mixed

template_view_page_attributes()

template_view_page_attributes(mixed $post) : mixed
Parameters
$post ( mixed )

template_view_metabox_save_post()

template_view_metabox_save_post(mixed $post_id) : mixed
Parameters
$post_id ( mixed )

change_post_menu_label()

change_post_menu_label() : mixed

change_post_object_label()

change_post_object_label() : mixed

wpb_mce_buttons_2()

wpb_mce_buttons_2(mixed $buttons) : mixed
Parameters
$buttons ( mixed )

my_mce_before_init_insert_formats()

my_mce_before_init_insert_formats(mixed $init_array) : mixed
Parameters
$init_array ( mixed )

my_toolbars()

my_toolbars(mixed $toolbars) : mixed
Parameters
$toolbars ( mixed )

new_body_class()

new_body_class(mixed $wp_classes, mixed $extra_classes) : mixed
Parameters
$wp_classes ( mixed )
$extra_classes ( mixed )

content_class()

content_class([mixed $class = '' ]) : mixed
Parameters
$class ( mixed = '' )

load_content_classes()

load_content_classes() : mixed

class_on_start()

class_on_start() : mixed

in_mobile()

in_mobile(mixed $text) : mixed
Parameters
$text ( mixed )

in_desktop()

in_desktop(mixed $text) : mixed
Parameters
$text ( mixed )

in_responsive()

in_responsive(mixed $a, mixed $b) : mixed
Parameters
$a ( mixed )
$b ( mixed )

get_responsive()

get_responsive(mixed $a, mixed $b) : mixed
Parameters
$a ( mixed )
$b ( mixed )

cptui_register_my_config()

cptui_register_my_config() : mixed

dynamic_select_list()

Dynamic Select List for Contact Form 7

dynamic_select_list(array<string|int, mixed> $tag) : array<string|int, mixed>
Parameters
$tag ( array<string|int, mixed> )

custom_views_post_title()

custom_views_post_title() : mixed

custom_views_post_title_shortcode_handler()

custom_views_post_title_shortcode_handler(mixed $tag) : mixed
Parameters
$tag ( mixed )

custom_views_post_link()

custom_views_post_link() : mixed

custom_views_post_link_shortcode_handler()

custom_views_post_link_shortcode_handler(mixed $tag) : mixed
Parameters
$tag ( mixed )

custom_shortcode_atts_wpcf7_filter()

custom_shortcode_atts_wpcf7_filter(mixed $out, mixed $pairs, mixed $atts) : mixed
Parameters
$out ( mixed )
$pairs ( mixed )
$atts ( mixed )

form_7()

Create a form with a given Contact Form 7 module title

form_7([mixed $args_form = null ]) : mixed

Return Html output of different type of galleries, from a specific acf gallery field or a group of fields

Parameters
$args ( array<string|int, mixed> )

Form Settings

$args['title'] ( string|array<string|int, mixed> )

CF7 Module title. It's not case sensitive

$args['class'] ( string )

(default: contact-email) Form output class.

$args['text'] ( string )

text for customtext field [hidden customtext default:shortcode_attr]

contact()

contact([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )
add_mobile_param_to_links(mixed $is_mobile) : mixed
Parameters
$is_mobile ( mixed )

add_screen_class()

add_screen_class() : mixed

add_iphone_class()

add_iphone_class() : mixed

extend_for_ipad()

extend_for_ipad(mixed $is_mobile) : mixed
Parameters
$is_mobile ( mixed )

reload_with_mobile_param()

reload_with_mobile_param() : mixed

add_mobile_body_class()

add_mobile_body_class(mixed $classes) : mixed
Parameters
$classes ( mixed )

is_iphone()

is_iphone() : mixed

is_android()

is_android() : mixed

is_android_mobile()

is_android_mobile() : mixed

is_android_tablet()

is_android_tablet() : mixed

is_mobile_device()

is_mobile_device() : mixed

is_tablet()

is_tablet() : mixed

is_safari_desk()

is_safari_desk() : mixed

is_safari_mobile()

is_safari_mobile() : mixed

browser_body_class()

browser_body_class(mixed $classes) : mixed
Parameters
$classes ( mixed )

add_browser_mobile_class()

add_browser_mobile_class() : mixed

set_loop_tax_object()

set_loop_tax_object([mixed $object = null ]) : mixed
Parameters
$object ( mixed = null )

get_loop_tax_object()

get_loop_tax_object() : mixed

clear_loop_tax_object()

clear_loop_tax_object() : mixed

loop_query()

loop_query(mixed $loop_args) : mixed
Parameters
$loop_args ( mixed )

loop_tax_query()

loop_tax_query(mixed $loop_args) : mixed
Parameters
$loop_args ( mixed )

loop()

loop([mixed $loop_args = null ]) : mixed
Parameters
$loop_args ( mixed = null )

loop_tax()

loop_tax(mixed $loop_args) : mixed
Parameters
$loop_args ( mixed )

loop_have_posts()

loop_have_posts(mixed $loop_args) : mixed
Parameters
$loop_args ( mixed )

is_last()

is_last() : mixed

is_first()

is_first() : mixed

is_unique()

is_unique() : mixed

loop_filter_query()

loop_filter_query(mixed $loop_args) : mixed
Parameters
$loop_args ( mixed )

loop_filtered()

loop_filtered([mixed $loop_args = null ]) : mixed
Parameters
$loop_args ( mixed = null )

infinite()

infinite([mixed $loop_args = array() ]) : mixed
Parameters
$loop_args ( mixed = array() )

wp_infinitepaginate()

wp_infinitepaginate() : mixed
get_related_ids([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )
loop_related(mixed $related_args) : mixed
Parameters
$related_args ( mixed )

loop_data()

loop_data() : mixed

item_ID()

item_ID() : mixed

the_item_ID()

the_item_ID() : mixed

themename_custom_logo_setup()

themename_custom_logo_setup() : mixed

custom_logo_function()

custom_logo_function() : mixed

menu()

menu([mixed $location = 'header' ][, mixed $args = null ]) : mixed
Parameters
$location ( mixed = 'header' )
$args ( mixed = null )

slt_url_to_postid()

slt_url_to_postid(mixed $url) : mixed
Parameters
$url ( mixed )
get_data_link([mixed $data = array('type' => null, 'id' => null) ]) : mixed
Parameters
$data ( mixed = array('type' => null, 'id' => null) )
data_link_url(mixed $link) : mixed
Parameters
$link ( mixed )
data_link(mixed $link) : mixed
Parameters
$link ( mixed )
add_menu_data_link(mixed $atts, mixed $item, mixed $args) : mixed
Parameters
$atts ( mixed )
$item ( mixed )
$args ( mixed )
add_content_data_link(mixed $content) : mixed
Parameters
$content ( mixed )

init_destination_js()

init_destination_js() : mixed
data_link_on_start() : mixed

get_destination_on_click()

get_destination_on_click() : mixed

update_navigation_class()

update_navigation_class() : mixed

menu_category()

menu_category([mixed $cat = 'category' ][, mixed $post_type = 'post' ][, mixed $settings = array() ]) : mixed
Parameters
$cat ( mixed = 'category' )
$post_type ( mixed = 'post' )
$settings ( mixed = array() )

is_in_menu()

Check if post is in a menu

is_in_menu([ $menu = null ][,  $object_id = null ]) : bool
Parameters
$menu ( )

menu name, id, or slug

$object_id ( )

int post object id of page

template_base()

template_base([mixed $path = null ][, mixed $load = false ][, mixed $args = null ]) : mixed
Parameters
$path ( mixed = null )
$load ( mixed = false )
$args ( mixed = null )

template_responsive()

template_responsive([mixed $file = null ][, mixed $args = null ]) : mixed
Parameters
$file ( mixed = null )
$args ( mixed = null )

template()

template([mixed $type = null ][, mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$type ( mixed = null )
$name ( mixed = null )
$args ( mixed = null )

part()

part([mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$name ( mixed = null )
$args ( mixed = null )

nav()

nav([mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$name ( mixed = null )
$args ( mixed = null )

page()

page([mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$name ( mixed = null )
$args ( mixed = null )

post()

post([mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$name ( mixed = null )
$args ( mixed = null )

component()

component([mixed $name = null ][, mixed $args = null ]) : mixed
Parameters
$name ( mixed = null )
$args ( mixed = null )

get_view()

get_view([mixed $id = null ]) : mixed
Parameters
$id ( mixed = null )

first_page_template()

first_page_template(mixed $template) : mixed
Parameters
$template ( mixed )
template_page_link(mixed $template) : mixed
Parameters
$template ( mixed )

console()

console(mixed $data) : mixed
Parameters
$data ( mixed )

reading_time()

reading_time(mixed $content) : mixed
Parameters
$content ( mixed )

is_upcoming()

is_upcoming([mixed $date = null ]) : mixed
Parameters
$date ( mixed = null )

text_date()

text_date([mixed $date = null ][, mixed $format = 'l d F Y' ]) : mixed
Parameters
$date ( mixed = null )
$format ( mixed = 'l d F Y' )

dg_big_image_size_threshold()

dg_big_image_size_threshold(mixed $threshold) : mixed
Parameters
$threshold ( mixed )

my_theme_custom_upload_mimes()

my_theme_custom_upload_mimes(mixed $existing_mimes) : mixed
Parameters
$existing_mimes ( mixed )

my_custom_mime_types()

my_custom_mime_types(mixed $mimes) : mixed
Parameters
$mimes ( mixed )

lazy_attachment_image()

lazy_attachment_image(mixed $attr, mixed $attachment) : mixed
Parameters
$attr ( mixed )
$attachment ( mixed )

icon()

icon(mixed $name) : mixed
Parameters
$name ( mixed )

map()

map([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

mini_cart()

mini_cart([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )
gallery([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )
cookie_popup([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

share()

share([mixed $args = null ]) : mixed
Parameters
$args ( mixed = null )

my_flamingo_caps()

my_flamingo_caps(mixed $caps) : mixed
Parameters
$caps ( mixed )

myextension_shop_manager_role_edit_capabilities()

myextension_shop_manager_role_edit_capabilities(mixed $roles) : mixed
Parameters
$roles ( mixed )

wpdocs_remove_menus()

wpdocs_remove_menus() : mixed

hide_admin()

Hide Administrator From User List *

hide_admin(mixed $user_search) : mixed
Parameters
$user_search ( mixed )

add_role_to_body()

add_role_to_body(mixed $classes) : mixed
Parameters
$classes ( mixed )

add_CDN_js()

add_CDN_js([mixed $key = 'init' ]) : mixed
Parameters
$key ( mixed = 'init' )

add_CDN_style()

add_CDN_style([mixed $key = 'init' ]) : mixed
Parameters
$key ( mixed = 'init' )

add_CDN()

add_CDN([mixed $key = 'init' ]) : mixed
Parameters
$key ( mixed = 'init' )

add_stylesheet()

add_stylesheet() : mixed

admin_style()

admin_style() : mixed

add_editor_styles()

add_editor_styles() : mixed

my_enqueue()

my_enqueue(mixed $hook) : mixed
Parameters
$hook ( mixed )

load_scripts()

load_scripts([mixed $filename = null ]) : mixed
Parameters
$filename ( mixed = null )

grd_woocommerce_script_cleaner()

grd_woocommerce_script_cleaner() : mixed

woo_cart_but()

Create Shortcode for WooCommerce Cart Menu Item

woo_cart_but() : mixed

woo_cart_but_count()

Add AJAX Shortcode when cart contents update

woo_cart_but_count(mixed $fragments) : mixed
Parameters
$fragments ( mixed )

remove_my_account_dashboard()

remove_my_account_dashboard(mixed $menu_links) : mixed
Parameters
$menu_links ( mixed )

redirect_to_orders_from_dashboard()

redirect_to_orders_from_dashboard() : mixed

export_init_files()

export_init_files(mixed $source, mixed $dest[, mixed $permissions = 0775 ]) : mixed
Parameters
$source ( mixed )
$dest ( mixed )
$permissions ( mixed = 0775 )

hashDirectory()

hashDirectory(mixed $directory) : mixed
Parameters
$directory ( mixed )

marquee()

Create a marquee with a given ACF text fields

marquee([array<string|int, mixed> $args = null ]) : mixed

Return Html marquee with a given text. You must choose an unique id

Parameters
$args ( array<string|int, mixed> )

Marquee Settings

$args['field'] ( string )

ACF field text. Complex field will be parsed with field_parse()

$args['id'] ( string )

Unique id for this element

$args['speed'] ( int )

The marquee speed, negative or positive

Todo

get auto id

Use
field_parse()

to parse ACF fields

wordpress_custom_registration_form()

wordpress_custom_registration_form(mixed $first_name, mixed $last_name, mixed $username, mixed $password, mixed $email) : mixed
Parameters
$first_name ( mixed )
$last_name ( mixed )
$username ( mixed )
$password ( mixed )
$email ( mixed )

wp_reg_form_valid()

wp_reg_form_valid(mixed $username, mixed $password, mixed $email) : mixed
Parameters
$username ( mixed )
$password ( mixed )
$email ( mixed )

wordpress_user_registration_form_completion()

wordpress_user_registration_form_completion() : mixed

wordpress_custom_registration_form_function()

wordpress_custom_registration_form_function() : mixed

wp_custom_shortcode_registration()

wp_custom_shortcode_registration() : mixed

custom_validation_error_method()

custom_validation_error_method(mixed $errors, mixed $lname, mixed $last_name) : mixed
Parameters
$errors ( mixed )
$lname ( mixed )
$last_name ( mixed )

auto_login_new_user()

auto_login_new_user(mixed $user_id) : mixed
Parameters
$user_id ( mixed )

generate_unique_username()

generate_unique_username(mixed $username) : mixed
Parameters
$username ( mixed )

first_term()

first_term([mixed $taxonomy = null ]) : mixed
Parameters
$taxonomy ( mixed = null )

get_term_description()

get_term_description() : mixed

the_term_description()

the_term_description() : mixed
get_term_permalink() : mixed
the_term_permalink() : mixed

get_terms_field()

get_terms_field(mixed $field) : mixed
Parameters
$field ( mixed )

def()

def(mixed $field[, mixed $default = '' ]) : mixed
Parameters
$field ( mixed )
$default ( mixed = '' )

field_parse()

undocumented function summary

field_parse(string $field_string[, array<string|int, mixed> $settings = null ]) : mixed

Undocumented function long description

value:$value return static value {opt_$field} return an option field {$field['item']} return field array value {$field->obj} return field object item $el.$class > {$field} return an container element $el with class $class and content $field $el.$class > {!$field} if $field exists return an container element $el with class $class and content $field opt_ tax_

Parameters
$field_string ( string )

Description

$settings ( array<string|int, mixed> )

Description

field_parse_attr()

field_parse_attr(mixed $field_string, mixed $attr, mixed $prefix[, mixed $string_end = array(' ') ]) : mixed
Parameters
$field_string ( mixed )
$attr ( mixed )
$prefix ( mixed )
$string_end ( mixed = array(' ') )

field_parse_post()

field_parse_post(mixed $field_string) : mixed
Parameters
$field_string ( mixed )

fields_html()

fields_html(mixed $field_string[, mixed $settings = null ]) : mixed
Parameters
$field_string ( mixed )
$settings ( mixed = null )

fields()

fields(mixed $field_string[, mixed $settings = null ]) : mixed
Parameters
$field_string ( mixed )
$settings ( mixed = null )

field_exists()

field_exists(mixed $field_string) : mixed
Parameters
$field_string ( mixed )

field_block()

field_block(mixed $field_string[, mixed $classes = null ]) : mixed
Parameters
$field_string ( mixed )
$classes ( mixed = null )

acf_image()

Create a image with a given ACF field

acf_image([array<string|int, mixed> $args = null ]) : mixed

Return Html image with a given class and size

Parameters
$args ( array<string|int, mixed> )

Image Settings

$args['image'] ( string )

ACF field image. Complex field will be parsed with field_parse()

$args['size'] ( string )

Image Size format

$args['class'] ( string )

The image class

Use
fields()

to print link

Create a link with a given ACF address

acf_link([array<string|int, mixed> $args = null ]) : mixed

Return Html link with a given class, url and text

Parameters
$args ( array<string|int, mixed> )

Link Settings

$args['link'] ( string )

ACF field url. Complex field will be parsed with field_parse()

$args['text'] ( string )

Link text

$args['class'] ( string )

The link class

$args['tel'] ( bool )

if true the link will open with tel app

$args['mail'] ( bool )

if true the link will open with a mail app

$args['new_window'] ( bool )

if true the link will open in a new window

Use
field_parse()

to print default text

acf_date()

Create a formatted date with a given ACF address

acf_date([array<string|int, mixed> $args = null ]) : mixed

Return formatted ACF date

Parameters
$args ( array<string|int, mixed> )

Date Settings

$args['date'] ( string )

ACF field date. Complex field will be parsed with field_html()

$args['format'] ( string )

Date format

$args['container'] ( string )

Tag container element

add_language_class()

add_language_class(mixed $classes) : mixed
Parameters
$classes ( mixed )

add_theme_locale()

add_theme_locale() : mixed

get_ajax_posts()

get_ajax_posts() : mixed

disable_emojis()

Disable the emoji's

disable_emojis() : mixed

disable_emojis_tinymce()

Filter out the tinymce emoji plugin.

disable_emojis_tinymce(mixed $plugins) : mixed
Parameters
$plugins ( mixed )

no_last_word()

no_last_word([mixed $string = null ]) : mixed
Parameters
$string ( mixed = null )

last_word()

last_word([mixed $string = null ]) : mixed
Parameters
$string ( mixed = null )

get_add_br()

get_add_br(mixed $string) : mixed
Parameters
$string ( mixed )

add_br()

add_br(mixed $string) : mixed
Parameters
$string ( mixed )

get_add_block()

get_add_block(mixed $string) : mixed
Parameters
$string ( mixed )

add_block()

add_block(mixed $string) : mixed
Parameters
$string ( mixed )

insert_in_middle()

insert_in_middle(mixed $str, mixed $middle) : mixed
Parameters
$str ( mixed )
$middle ( mixed )

text_to_div()

text_to_div(mixed $text) : mixed
Parameters
$text ( mixed )

text_to_span()

text_to_span(mixed $text) : mixed
Parameters
$text ( mixed )

trunc()

trunc(mixed $text, mixed $limit[, mixed $end = '...' ]) : mixed
Parameters
$text ( mixed )
$limit ( mixed )
$end ( mixed = '...' )

excerpt()

excerpt(mixed $limit[, mixed $end = '...' ]) : mixed
Parameters
$limit ( mixed )
$end ( mixed = '...' )

content()

content(mixed $limit[, mixed $end = '...' ]) : mixed
Parameters
$limit ( mixed )
$end ( mixed = '...' )

title()

title(mixed $limit[, mixed $end = '...' ]) : mixed
Parameters
$limit ( mixed )
$end ( mixed = '...' )

justify_parse()

justify_parse(mixed $text) : mixed
Parameters
$text ( mixed )

content_text()

content_text() : mixed

truncate()

truncate(mixed $text[, mixed $length = 100 ][, mixed $options = array() ]) : mixed
Parameters
$text ( mixed )
$length ( mixed = 100 )
$options ( mixed = array() )

read_more()

read_more([mixed $length = 1400 ][, mixed $content = null ]) : mixed
Parameters
$length ( mixed = 1400 )
$content ( mixed = null )

Search results