View Product Page

Filters

includes/class-yith-wcbr-admin-premium.php

Copied!
Copy

Filter the brand name when filtering the products by brand in the backend

 Params  string $brand_name Brand name 
 
Return string

Copied!
Copy

Filter the array of arguments available when filtering products by brand in the backend

 Params  array $args Array of arguments 
 
Return array

includes/class-yith-wcbr-admin.php

Copied!
Copy

Filter the available tabs in the plugin panel

 Params  array $tabs Admin tabs 
 
Return array

Copied!
Copy

Filter the capability used to access the plugin panel

 Params  string $capability Capability 
 
Return string

Copied!
Copy

Filter the columns for the Brands table

 Params  array $columns Columns 
 
Return array

Copied!
Copy

Filter the content for the custom columns in the Brands table

 Params  string $content Custom column content  string $column  Custom column name  int    $id      Term ID 
 
Return string

includes/class-yith-wcbr-premium.php

Copied!
Copy

Filter the time (in milliseconds) to reproduce the carousel in the Brands Thumbnail Carousel shortcode

 Params  int $carousel_time Carousel time 
 
Return int

Copied!
Copy

Filter the slides in the Brands Thumbnail Carousel shortcode in mobile devices

 Params  int $slides Slides 
 
Return int

Copied!
Copy

Filter the default width for the image size in the loop page

 Params  int $width Default width 
 
Return int

Copied!
Copy

Filter the default height for the image size in the loop page

 Params  int $height Default height 
 
Return int

Copied!
Copy

Filter whether to crop image in the loop page

 Params  bool $crop Whether to crop image 
 
Return bool

Copied!
Copy

Filter the action where to display the brands in the loop page

 Params  string $action Action name 
 
Return string

Copied!
Copy

Filter whether to remove the brand header on next brand pages

 Params  bool $remove_brand_header Whether to remove brand header or not 
 
Return bool

Copied!
Copy

Filter the content to be displayed before the terms list in the loop page

 Params  string $content Content 
 
Return string

Copied!
Copy

Filter the content to be displayed after the terms list in the loop page

 Params  string $content Content 
 
Return string

Copied!
Copy

Filter the separator for the terms list in the loop page

 Params  string $separator Separator 
 
Return string

Copied!
Copy

Filter the category object, if the %yith_product_brand% has been included in the permalink structure

 Params  WP_Term $term  Term object  array   $terms Array of terms  WP_Post $post  Post object 
 
Return WP_Term

Copied!
Copy

Filter the label to sort products by brand in the loop page

 Params  string $sort_label Sort label 
 
Return string

Copied!
Copy

Filter the sort options in the loop page

 Params  array $sort Sort options 
 
Return array

Copied!
Copy

Filter whether to set the sort by brand option

 Params  bool   $set_sort_by_brand Whether to set sort by brand option or not  string $orderby_value     Orderby value 
 
Return bool

includes/class-yith-wcbr-shortcode-premium.php

Copied!
Copy

Filter the array with the available parameters for the Visual Composer shortcodes

 Params  array $vc_map_params Array of parameters 
 
Return array

Copied!
Copy

Filter whether to return empty content when the autosense category option is enabled

 Params  bool $bool Whether to return empty content or not in the autosense category mode 
 
Return bool

Copied!
Copy

Filter the array with the available terms for the Brands Filter shortcode

 Params  array $terms Terms 
 
Return array

Copied!
Copy

Filter the heading letters for the Brands Filter shortcode

 Params  string $heading_letters Heading letters 
 
Return string

Copied!
Copy

Filter the heading letter for the Brands Filter shortcode

 Params  string $heading_letter Heading letter 
 
Return string

Copied!
Copy

Filter whether to filter the available heading letters in the Brands Filter shortcode

 Params  bool  $filter            Whether to filter heading letters or not  array $available_filters Available filters 
 
Return bool

Copied!
Copy

Filter the available heading letters sorted in the Brands Filter shortcode

 Params  array $available_filters Available filters 
 
Return array

Copied!
Copy

Filter the available letters stack sorted in the Brands Filter shortcode

 Params  array $stack Letters stack 
 
Return array

Copied!
Copy

Filter the columns width in the Brands Thumbnail shortcode

 Params  array $stack Letters stack 
 
Return array

Copied!
Copy

Filter the loop before carousel in the Brands Product Carousel shortcode

 Params  mixed  $woocommerce_loop Global WooCommerce loop  string $plugin_slug      Plugin slug 
 
Return mixed

Copied!
Copy

Filter the array of arguments to get the terms for the Brands Grid shortcode

 Params  array $args Array of arguments 
 
Return array

Copied!
Copy

Filter the filtered terms for the Brands Filter shortcode

 Params  array $filtered_terms Filtered terms 
 
Return array

Copied!
Copy

Filter the default category name for the Brands Grid shortcode

 Params  string $default_category_name Default category name 
 
Return string

includes/class-yith-wcbr-shortcode.php

Copied!
Copy

Filter the array with the available parameters for the Visual Composer shortcodes

 Params  array $vc_map_params Array of parameters 
 
Return array

includes/class-yith-wcbr.php

Copied!
Copy

Filter the key for the Brands taxonomy

 Params  string $brands_taxonomy Taxonomy key 
 
Return string

Copied!
Copy

Filter the name for the Brands taxonomy

 Params  string $taxonomy_name Taxonomy name 
 
Return string

Copied!
Copy

Filter the array with the available parameters for the taxonomy creation

 Params  array $arfs Array of arguments 
 
Return array

Copied!
Copy

Filter the label for the Brands taxonomy

 Params  string $taxonomy_label Taxonomy label 
 
Return string

Copied!
Copy

Filter the labels for the Brands taxonomy

 Params  array $taxonomy_labels Taxonomy labels 
 
Return array

Copied!
Copy

Filter whether to show the taxonomy in the menu

 Params  bool $show_in_menu Whether to show the taxonomy in the menu or not 
 
Return bool

Copied!
Copy

Filter whether the taxonomy is hierarchical

 Params  bool $is_hierarchical Whether the taxonomy is hierarchical or not 
 
Return bool

Copied!
Copy

Filter the taxonomy slug for the rewrite rules

 Params  string $slug Taxonomy slug 
 
Return string

Copied!
Copy

Filter whether the permastruct should be prepended with WP_Rewrite::$front

 Params  bool $with_front Whether prepend with WP_Rewrite::$front or not 
 
Return bool

Copied!
Copy

Filter the capabilities for the Brands taxonomy

 Params  array $capabilites Taxonomy capabilites 
 
Return array

Copied!
Copy

Filter the object type with which the taxonomy should be associated

 Params  string $object_type Object type 
 
Return string

Copied!
Copy

Filter the default width for the image size in the product page

 Params  int $width Default width 
 
Return int

Copied!
Copy

Filter the default height for the image size in the product page

 Params  int $height Default height 
 
Return int

Copied!
Copy

Filter whether to crop image in the product page

 Params  bool $crop Whether to crop image 
 
Return bool

Copied!
Copy

Filter the content to be displayed before the terms list in the product page

 Params  string $content Content 
 
Return string

Copied!
Copy

Filter the content to be displayed after the terms list in the product page

 Params  string $content Content 
 
Return string

Copied!
Copy

Filter the separator for the terms list in the product page

 Params  string $separator Separator 
 
Return string

Copied!
Copy

Filter the array with the data passed to the template

 Params  array $data Data passed to the template 
 
Return array

includes/functions.yith-wcbr.php

Copied!
Copy

Filter the array with the available parameters to get the terms

 Params  array $args Array of arguments 
 
Return array

includes/importer/class-yith-wcbr-csv-importer.php

Copied!
Copy

Filter the attachment size limit for the CSV file to be importe

 Params  int $size Size limit 
 
Return int

includes/widget/class-yith-wcbr-brand-filter-widget.php

Copied!
Copy

Filter the array of arguments available for the Brands Filter shortcode

 Params  array $args Array of arguments 
 
Return array

includes/widget/class-yith-wcbr-brand-thumbnail-carousel-widget.php

Copied!
Copy

Filter the array of arguments available for the Brands Thumbnail Carousel shortcode

 Params  array $args Array of arguments 
 
Return array

includes/widget/class-yith-wcbr-brand-thumbnail-widget.php

Copied!
Copy

Filter the array of arguments available for the Brands Thumbnail shortcode

 Params  array $args Array of arguments 
 
Return array

plugin-options/settings-options.php

Copied!
Copy

Filter the options available in the General options tab

 Params  array $general_options General settings options 
 
Return array

templates/archive-product-brands-description.php

Copied!
Copy

Filter whether to show the brand description in the brand page

 Params  bool    $show_description Whether to show brand description in the brand page  WP_Term $term             Term object 
 
Return bool

templates/loop-brands.php

Copied!
Copy

Filter the HTML string for the brand image

 Params  string $img_html     HTML image string  int    $thumbnail_id Brand thumbnaild ID 
 
Return string

templates/shortcodes/brand-filter.php

Copied!
Copy

Filter the reset label in the Brands Filter

 Params  string $label Label 
 
Return string

templates/shortcodes/brand-product-carousel.php

Copied!
Copy

Filter the title in the Brands Product Carousel

 Params  string $title Title 
 
Return string

templates/shortcodes/brand-product.php

Copied!
Copy

Filter the title in the Brand Product

 Params  string $title Title 
 
Return string

templates/shortcodes/brand-thumbnail-carousel.php

Copied!
Copy

Filter the array with the brand image data

 Params  array $img_data     Image data  int   $thumbnail_id Brand thumbnail ID 
 
Return array

templates/shortcodes/brand-thumbnail.php

Copied!
Copy

Filter the array with the brand image data

 Params  array $img_data     Image data  int   $thumbnail_id Brand thumbnail ID 
 
Return array

templates/single-product-brands.php

Copied!
Copy

Filter the HTML string for the brand image

 Params  string $img_html     HTML image string  int    $thumbnail_id Brand thumbnaild ID 
 
Return string

views/add-brand-taxonomy-form-premium.php

Copied!
Copy

Filter the label for the field to select the brand banner

 Params  string $label Field label 
 
Return string

views/add-brand-taxonomy-form.php

Copied!
Copy

Filter the label for the field to select the brand thumbnail

 Params  string $label Field label 
 
Return string

views/edit-brand-taxonomy-form-premium.php

Copied!
Copy

Filter the label for the field to select the brand banner

 Params  string $label Field label 
 
Return string

views/edit-brand-taxonomy-form.php

Copied!
Copy

Filter the label for the field to select the brand thumbnail

 Params  string $label Field label 
 
Return string

Actions

includes/class-yith-wcbr-shortcode-premium.php

Copied!
Copy

Allows to fire some action before shortcode handling

 Params  string $shortcode Shortcode name  array  $atts      Shortcode attributes 

Copied!
Copy

Allows to fire some action after shortcode handling

 Params  string $shortcode Shortcode name  array  $atts      Shortcode attributes 

includes/class-yith-wcbr.php

Copied!
Copy

Allows to fire some action before enqueueing the plugin style


includes/importer/class-yith-wcbr-csv-importer.php

Copied!
Copy

Allows to manage some extra fields in the CSV import

 Params  string $row    Import row  string $header Import header  array  $id     Term data 

init.php

Copied!
Copy

Allows the plugin initialization


templates/loop-brands.php

Copied!
Copy

Allows to render some content or fire some action when the brand has no logo

 Params  int     $term_id         Term ID  WP_Term $term            Term object  string  $image_size      Image size  bool    $show_term_name  Whether to show the brand name  bool    $show_avg_rating Whether to show the brand rating 

templates/shortcodes/brand-grid-loop.php

Copied!
Copy

Allows to render some content or fire some action when the brand has no logo

 Params  int     $term_id         Term ID  WP_Term $term            Term object  string  $image_size      Image size  bool    $show_term_name  Whether to show the brand name  bool    $show_avg_rating Whether to show the brand rating 

templates/shortcodes/brand-thumbnail-carousel.php

Copied!
Copy

Allows to render some content or fire some action when the brand has no logo

 Params  int     $term_id         Term ID  WP_Term $term            Term object  string  $image_size      Image size  bool    $show_term_name  Whether to show the brand name  bool    $show_avg_rating Whether to show the brand rating 

templates/shortcodes/brand-thumbnail.php

Copied!
Copy

Allows to render some content or fire some action when the brand has no logo

 Params  int     $term_id         Term ID  WP_Term $term            Term object  string  $image_size      Image size  bool    $show_term_name  Whether to show the brand name  bool    $show_avg_rating Whether to show the brand rating 

templates/single-product-brands.php

Copied!
Copy

Allows to render some content or fire some action when the brand has no logo

 Params  int     $term_id         Term ID  WP_Term $term            Term object  string  $image_size      Image size  bool    $show_term_name  Whether to show the brand name  bool    $show_avg_rating Whether to show the brand rating