WooCommerce Brands

Contains general settings for Brands.

• Use cache – enable/disable.
• Clear cache – clear cache.

*Cache is used to speed up the page load, it remembers the last shorcodes and widgets condition. Click on the Clear cache button after making changes to shortcodes and widgets.

List of shortcodes with their attributes:

• Shorcodes:
  • [brb_catalog] – brand catalog
    • use_name – display brand name (1 or 0)
    • img_display – display brand image (1 or 0)
    • img_width – image width number (integer)
    • img_width_units – image width units
      • px – img_width in px
      • % – img_width in %
    • img_height – image height number (integer)
    • img_height_units – image height units
      • px – img_height in px
      • % – img_height in %
    • img_fit – brand image fit: ‘cover’, ‘contain’ or ‘fill’, default is cover
    • img_align – brand image align to name: ‘left’, ‘right’ or ‘none’
    • orderby – sort brands by:
      • title – product title
      • name – brand name
      • date – date of creation
      • modified – last modified date
      • rand – random order
    • order – sorting order: ascending (asc) or descending (desc)
    • count – show number of products
    • hide_empty – hide brands with no products
    • out_of_stock – hide brands with products out of stock
    • featured_first – show featured brands first
    • show_all – show “All” tab
    • category_only – display only brands of this category (on category page)
    • hierarchy – show brands hierarchy
      • top – only top level
      • children – only children (without hierarchy)
      • expand – show full hierarchy
      • by_click – expand by click
      • all – all brands without hierarchy
    • brands_include – brands to display (id list, i.e. include=’45,47,52,61′)
    • groupby – group brands by:
      • alphabet – brand name (default)
      • category – brand category
      • none – no group
    • style
      • vertical
      • horizontal
    • column – Number of columns to display
  • [brb_description] – Product Brands Description
    • brand_id – one or more brand ID (example: brand_id=’12,34,35′)
    • display_title – display brand title
    • display_description – display brand description
    • thumbnail_display – display brand thumbnail
    • thumbnail_width – brand thumbnail width, in px or %
    • thumbnail_width_units
      • px – thumbnail_width in px
      • % – thumbnail_width in %
    • thumbnail_height – brand thumbnail height, in px or %
    • thumbnail_height_units
      • px – thumbnail_height in px
      • % – thumbnail_height in %
    • thumbnail_fit – brand thumbnail fit: ‘cover’, ‘contain’, ‘fill’
      or ‘none’, default is cover
    • thumbnail_align – brand thumbnail align to name: ‘left’, ‘right’ or ‘none’
    • banner_display – display brand banner
    • banner_width – brand thumbnail width, in px or %
    • banner_width_units
      • px – banner_width in px
      • % – banner_width in %
    • banner_height – brand banner height, in px or %
    • banner_height_units
      • px – banner_height in px
      • % – banner_height in %
    • banner_fit – brand banner fit: ‘cover’, ‘contain’, ‘fill’ or ‘none’, default is cover
    • banner_align – brand thumbnail align to name: ‘left’, ‘right’ or ‘none’
    • related_products_display – display related products
    • per_page – related products Per page. Set empty for all products
    • columns – related products columns
    • orderby – related products Order by
      • title – product title
      • name – brand name
      • date – date of creation
      • modified – last modified date
      • rand – random order
    • order – related products sorting order: ascending (asc) or descending (desc)
    • slider – related products Slider
    • hide_brands – related products hide brands
    • display_link – display external link
    • featured – display last created featured brand
  • [brb_brands_list] – list of brands
    • use_name – display brand name (1 or 0)
    • img_display – display brand image (1 or 0)
    • img_width – image width number (integer)
    • img_width_units
      • px – img_width in px
      • % – img_width in %
    • img_height – image height number (integer)
    • img_height_units
      • px – img_height in px
      • % – img_height in %
    • img_fit – brand image fit: ‘cover’, ‘contain’, ‘fill’ or ‘none’, default is cover
    • img_align – brand image align to name: ‘left’, ‘right’ or ‘none’
    • orderby – sort brands by:
      • title – product title
      • name – brand name
      • date – date of creation
      • modified – last modified date
      • rand – random order
    • order – sorting order: ascending (asc) or descending (desc)
    • count – show number of products
    • hide_empty – hide brands with no products
    • out_of_stock – hide brands with products out of stock
    • featured_first – show featured brands first
    • slider – show brand list with a slider
    • category_only – display only brands of this category (on category page)
    • hierarchy – show brands hierarchy
      • top – only top level
      • children – only children (without hierarchy)
      • expand – show full hierarchy
      • by_click – expand by click
      • all – all brands without hierarchy top
    • brands_include – brands to display (id list, i.e. include=’45,47,52,61′)
      
    • per_row – brands per row
    • brands_number – brands in list
    • padding – padding, px
    • margin – margin, px
    • border_width – border width, px
    • border_color – border color, color in hex, example #FF0000
  • [brb_products_list]  – brands products
    • per_page – product list per page
    • columns – count of columns for product list
    • orderby – products order by
      • title – product title
      • name – brand name
      • date – date of creation
      • modified – last modified date
      • rand – random order
    • order – sorting order: ascending (asc) or descending (desc)
    • slider – show slider for list
    • hide_brands – hide brands for list
    • hide_pagination – hide pagination for list
    • hide_labels – hide labels for list
    • brands – show brands for list (brand ID)
  • [brb_prod_binfo]  –
    • product – product ID (on single product page get ID from product page)
    • limit – show (leave empty for all) (1 or 0)
    • display_title – display brand title (1 or 0)
    • display_description – display brand description (1 or 0)
    • thumbnail_display – display brand thumbnail (1 or 0)
    • thumbnail_width – brand thumbnail width (integer)
    • thumbnail_width_units
    • thumbnail_height – brand thumbnail height (integer)
    • thumbnail_height_units
    • thumbnail_fit – brand thumbnail fit: ‘cover’, ‘contain’, ‘fill’
      or ‘none’, default is cover
    • thumbnail_align – brand thumbnail align to name: ‘left’, ‘right’ or ‘none’
    • banner_display – display brand banner (1 or 0)
    • banner_width – brand banner width (integer)
    • banner_width_units
    • banner_height – brand banner height (integer)
    • banner_height_units
    • banner_fit – brand banner fit: ‘cover’, ‘contain’, ‘fill’
      or ‘none’, default is cover
    • banner_align – brand banner align to name: ‘left’, ‘right’ or ‘none’
    • related_products_display – display related products
    • per_page – related products per page
    • columns – related products columns
    • orderby – related products order by
      • title – product title
      • name – brand name
      • date – date of creation
      • modified – last modified date
      • rand – random order
    • order – sorting order: ascending (asc) or descending (desc)
    • slider – Related products Slider
    • hide_brands – hide brands for list
    • display_link – display external link
    • featured – display last created featured brand

• Display description – enable/disable.
• Thumbnail – display (enable/disable):
  • Width (px; %);
  • Height (px; %);
  • Fit:
    • Cover;
    • Contain;
    • Fill;
    • None.
  • Align:
    • none;
    • Left;
    • Right.
• Banner – display (enable/disable):
  • Width (px; %);
  • Height (px; %);
  • Fit:
    • Cover;
    • Contain;
    • Fill;
    • None.
  • Align:
    • none;
    • Left;
    • Right.
• External link – display (enable/disable) (if URL for the brand is set);
  • Text (e.g. Go to the brand website >>);
  • Open in new tab (enable/disable).
• Related products
  • Display – show related products
  • Out of stosck products
    • Show as usual
    • Show last
    • Show first
  • Columns – count of columns for related products
  • Products per page (blank for all)
  • Order by
  • Order
  • Slider
  • Hide brands – hide brands for related products

Shop Page is availabel only with the enabled Show Brands add-on.

• Display Brand – enable/disable;
  • Brand Position:
    • Before All
    • After Image
    • After Title
    • After Price
    • After Add to cart button
  • Display As Link – enable/disable;
  • Image – dispaly (enable/disable):
    • Width (px; %)
    • Height (px; %)
    • Fit:
      • Cover
      • Contain
      • Fill
      • None
    • Align to text:
      • none
      • Left
      • Right
      • Above
      • Under
    • Image custom CSS
  • Name – display (enable/disable):
    • Name custom CSS

Product Page is availabel only with the enabled Show Brands add-on.

• Display Brand – enable/disable;
  • Brand Position:
    • Before All
    • After Image
    • After Title
    • After Price
    • After Add to cart button
  • Display As Link – enable/diable;
  • Image – dispaly (enable/disable):
    • Width (px; %)
    • Height (px; %)
    • Fit:
      • Cover
      • Contain
      • Fill
      • None
    • Align:
      • none
      • Left
      • Right
        
    • Image custom CSS
      
  • Name – display (enable/disable):
    • Name custom CSS

Slider Setting for widgets and shortcodes.

• Autoplay – enable/disable
  • Autoplay Speed – [number (ms)]
• Slide change speed – [number (ms)]
• Infinite – enable/disable
• Display Arrows – enable/disable
• Brands to Scroll – [number]
• Change slide mode – Fade/Slide
• Easing:
  • Linear
  • Ease
  • Ease in
  • Ease out
  • Ease in-out
  • Cubic Bezier [1-6]
• Stop Autoscroll on Focus – enable/disable
• Show dots – enable/disable
  • Dots color – color picker block/Default

• Disable Font Awesome: do not upload the CSS file for Font Awesome to the site. Disable it only if you do not use Font Awesome icons in widgets or you have Font Awesome in your theme.
• Font Awesome Version – version of Font Awesome, which will be used in the settings and the front end pages of the shop. Please select the version that is in your theme.
• Custom CSS – field for custom CSS; contains custom CSS code settings to be displayed on the front end pages. Custom CSS is the CSS as you want it to be.

Show Brands – displays text and images of brands on shop and product pages.
DEPRECATED Divi Module/Shortcode

WooCommerce Brand Catalog (former WooCommerce Brands by Name) –
a widget to display list of Brands, grouped by name or category. You can place this widget in any widget area like other widgets.

• Title – brand name.
• Display text – displays text for brands.
• Image:
  • Display – displays images for brands.
  • Width – brand thumbnail height (px/%).
  • Height – brand thumbnail width (px/%).
  • Fit:
    • Cover
    • Contain
    • Fill
    • None
  • Align:
    • Above name
    • Left to name
    • Right to name
    • Under name
• Show number of products – enable/disable.
• Hide empty – enable/disable.
• Featured first – enable/disable.
• Order by:
  • Alphabet
  • Number of products
  • Rating
  • Random
• Order:
  • Ascendent
  • Descendent
• Group by:
  • Alphabet
  • Category
  • None
• Show “All” tab – enable/disable.
• Layout:
  • Vertical
  • Horizontal
• Number of columns – [number].

Widget to display product brands as a simple list or as a carousel (slider). You can place this widget in any widget area like other widgets.

• Title – widget title.
• Display text – enable/disable.
• Image:
  • Display image – displays images for brands
  • Width – brands thumbnail width (px/%)
  • Height – brands thumbnail height (px/%)
  • Fit
    • Cover
    • Contain
    • Fill
    • None
  • Align
    • Above name
    • Right to name
    • Left to name
    • Under name
• Show number of products
• Hide empty – hides brands without products.
• Featued first
• Order by:
  • Alphabet
  • Number of products
  • Rating
  • Random
• Order:
  • Ascendent
  • Descendent
• Brands per row – brands columns. Brands per slider, when slider is enabled.
• Padding around brands – padding around each brand (default: 3px).
• Border width – border width around each brand.
• Border color – border color around each brand (color picker block).
• Slider – enable/disable (slider settings are set in the Tab – Slider).

Widget to display information about a product brand. You can place this widget in any widget area like any other widgets.

• Display title – displays name for brands.
• Display thumbnails – displays image for brands.
• Display description – displays description for brands.
• Image width – brand thumbnail width (default: 100%).
• Image align – position of an image.
  • None
  • Left
  • Right

br_get_woocommerce_version()

Public function to get WooCommerce version

return string. woocommerce version

All of these functions are static functions in the BeRocket_product_brand class.

init ()

Function for initializing scripts.

admin_init ()

Function for initialize scripts and settings page in the admin bar.

options ()

Add option page to admin menu.

br_get_template_part( $name = ” )

Get template part (for templates like the slider).

• $name – template name

Default templates are placed in plugins folder woocommerce-brand/templates.

To rewrite the template in your theme folder create a folder with the name woocommerce-product_brand and place a new template with the identical name in this folder.

shortcode_brands_product_thumbnail ($atts)

• brands_product_thumbnail –shortcode
• $atts – shortcode attributes

shortcode_brands_info ($atts)

• brands_info –shortcode
• $atts – shortcode attributes

brands_by_name_shortcode ($atts)

• brands_catalog (brands_by_name) – shortcode
• $atts – shortcode attributes

brands_list_shortcode ($atts)

• brands_list –shortcode
• $atts – shortcode attributes

products_shortcode ($atts)

• brands_products –shortcode
• $atts – shortcode attributes

Template that is used in plugin.

Parameters

1. template – link to the template that will be loaded.
2. name – template name.

Usage

<?php
function change_product_brand_get_template_part ( $template, $name ) {
//your code here
    return $template;
}

add_filter( 'product_brand_get_template_part', 'change_product_brand_get_template_part', 10, 2 );
?>

The HTML code that is returnd by the brands_product_thumbnail shortcode.

Parameters

1. return – HTML code, that is returned.
2. atts – shortcode attributes.

Usage

<?php
function change_shortcode_brands_product_thumbnail_return ( $return, $atts ) {
//your code here
    return $return;
}

add_filter( 'shortcode_brands_product_thumbnail_return', 'change_shortcode_brands_product_thumbnail_return', 10, 2 );
?>

The HTML code that is returned by the brands_info shortcode.

Parameters

1. return – HTML code, that is returned.
2. term – brand term taxonomy.
3. atts – shortcode attributes.

Usage

<?php
function change_shortcode_brands_info_return ( $return, $term, $atts ) {
//your code here
    return $return;
}

add_filter( 'shortcode_brands_info_return', 'change_shortcode_brands_info_return', 10, 3 );
?>

The HTML code that is returned by the brands_catalog (brands_by_name) shortcode.

The HTML code that is returned by the brands_list shortcode.

Parameters

1. return – HTML code, that is returned.
2. atts – shortcode attributes.

Usage

<?php
function change_brands_list_shortcode_return ( $return, $atts ) {
//your code here
    return $return;
}

add_filter( 'brands_list_shortcode_return', 'change_brands_list_shortcode_return', 10, 2 );
?>

The HTML code that is returned by the brands_products shortcode.

Parameters

1. return – HTML code, that is returned.
2. atts – shortcode attributes.

Usage

<?php
function change_brands_products_shortcode_return ( $return, $atts ) {
//your code here
    return $return;
}

add_filter( 'brands_products_shortcode_return', 'change_brands_products_shortcode_return', 10, 2 );
?>