WC_Brands_Admin
in package
WC_Brands_Admin class.
Table of Contents
- $fields : array<string|int, mixed>
- Admin fields.
- $settings_tabs : array<string|int, mixed>
- Settings array (Deprecated).
- $settings : array<string|int, mixed>
- Settings form fields (Deprecated).
- __construct() : mixed
- __construct function.
- add_brand_base_setting() : mixed
- Add brand base permalink setting.
- add_column_to_importer_exporter() : array<string|int, mixed>
- Add csv column for importing/exporting.
- add_coupon_brands_fields() : void
- Display coupon filter fields relating to brands.
- add_default_column_mapping() : array<string|int, mixed>
- Add default column mapping.
- add_settings_section() : mixed
- Add the settings for the new "Brands" subtab.
- add_settings_tab() : mixed
- Add a new "Brands" subtab to the "Products" tab.
- add_thumbnail_field() : mixed
- Category thumbnails.
- admin_settings() : mixed
- Admin settings function.
- column() : mixed
- Column function.
- columns() : mixed
- Columns function.
- edit_thumbnail_field() : mixed
- Edit thumbnail field row.
- get_column_value_brand_ids() : string
- Get brands column value for csv export.
- init_form_fields() : mixed
- Prepare form fields to be used in the various tabs.
- parse_brands_field() : array<string|int, mixed>
- Parse brands field from a CSV during import.
- process_import() : mixed
- Add brands to newly imported product.
- product_brand_slug_input() : mixed
- Add a slug input box.
- product_columns() : array<string|int, mixed>
- Add brands column in second-to-last position.
- render_product_brand_filter() : mixed
- Renders either dropdown or a search field for brands depending on the threshold value of woocommerce_product_brand_filter_threshold filter.
- save_admin_settings() : mixed
- Save admin settings function.
- save_coupon_brands() : void
- Save coupon filter fields relating to brands.
- save_permalink_settings() : mixed
- Save permalnks settings.
- scripts() : void
- Enqueue scripts.
- sort_brands() : mixed
- Sort brands function.
- styles() : void
- Enqueue styles.
- taxonomy_description() : mixed
- Description for brand page.
- thumbnail_field_save() : void
- Saves thumbnail field.
- validate_product_base() : mixed
- Validate the product base.
Properties
$fields
Admin fields.
public
array<string|int, mixed>
$fields
= array()
$settings_tabs
Settings array (Deprecated).
public
array<string|int, mixed>
$settings_tabs
$settings
Settings form fields (Deprecated).
private
array<string|int, mixed>
$settings
Methods
__construct()
__construct function.
public
__construct() : mixed
Return values
mixed —add_brand_base_setting()
Add brand base permalink setting.
public
add_brand_base_setting() : mixed
Return values
mixed —add_column_to_importer_exporter()
Add csv column for importing/exporting.
public
add_column_to_importer_exporter(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
-
Mapping options.
Return values
array<string|int, mixed> — $optionsadd_coupon_brands_fields()
Display coupon filter fields relating to brands.
public
add_coupon_brands_fields() : void
Tags
Return values
void —add_default_column_mapping()
Add default column mapping.
public
add_default_column_mapping(array<string|int, mixed> $mappings) : array<string|int, mixed>
Parameters
- $mappings : array<string|int, mixed>
-
Mappings.
Return values
array<string|int, mixed> — $mappingsadd_settings_section()
Add the settings for the new "Brands" subtab.
public
add_settings_section(array<string|int, mixed> $settings, array<string|int, mixed> $current_section) : mixed
Parameters
- $settings : array<string|int, mixed>
-
Settings.
- $current_section : array<string|int, mixed>
-
Current section.
Tags
Return values
mixed —add_settings_tab()
Add a new "Brands" subtab to the "Products" tab.
public
add_settings_tab(array<string|int, mixed> $sections) : mixed
Parameters
- $sections : array<string|int, mixed>
-
Sections.
Tags
Return values
mixed —add_thumbnail_field()
Category thumbnails.
public
add_thumbnail_field() : mixed
Return values
mixed —admin_settings()
Admin settings function.
public
admin_settings() : mixed
Return values
mixed —column()
Column function.
public
column(mixed $columns, mixed $column, mixed $id) : mixed
Parameters
- $columns : mixed
-
Columns.
- $column : mixed
-
Column.
- $id : mixed
-
ID.
Return values
mixed —columns()
Columns function.
public
columns(mixed $columns) : mixed
Parameters
- $columns : mixed
-
Columns.
Return values
mixed —edit_thumbnail_field()
Edit thumbnail field row.
public
edit_thumbnail_field(WP_Term $term) : mixed
Parameters
- $term : WP_Term
-
Current taxonomy term object.
Return values
mixed —get_column_value_brand_ids()
Get brands column value for csv export.
public
get_column_value_brand_ids(string $value, WC_Product $product) : string
Parameters
- $value : string
-
What will be exported.
- $product : WC_Product
-
Product being exported.
Return values
string — Brands separated by commas and child brands as "parent > child".init_form_fields()
Prepare form fields to be used in the various tabs.
public
init_form_fields() : mixed
Return values
mixed —parse_brands_field()
Parse brands field from a CSV during import.
public
parse_brands_field(string $value) : array<string|int, mixed>
Based on WC_Product_CSV_Importer::parse_categories_field()
Parameters
- $value : string
-
Field value.
Return values
array<string|int, mixed> —process_import()
Add brands to newly imported product.
public
process_import(WC_Product $product, array<string|int, mixed> $data) : mixed
Parameters
- $product : WC_Product
-
Product being imported.
- $data : array<string|int, mixed>
-
Raw CSV data.
Return values
mixed —product_brand_slug_input()
Add a slug input box.
public
product_brand_slug_input() : mixed
Return values
mixed —product_columns()
Add brands column in second-to-last position.
public
product_columns(mixed $columns) : array<string|int, mixed>
Parameters
- $columns : mixed
-
Columns.
Tags
Return values
array<string|int, mixed> —render_product_brand_filter()
Renders either dropdown or a search field for brands depending on the threshold value of woocommerce_product_brand_filter_threshold filter.
public
render_product_brand_filter() : mixed
Return values
mixed —save_admin_settings()
Save admin settings function.
public
save_admin_settings() : mixed
Return values
mixed —save_coupon_brands()
Save coupon filter fields relating to brands.
public
save_coupon_brands(int $post_id) : void
Parameters
- $post_id : int
-
Post ID.
Tags
Return values
void —save_permalink_settings()
Save permalnks settings.
public
save_permalink_settings() : mixed
We need to save the options ourselves; settings api does not trigger save for the permalinks page.
Return values
mixed —scripts()
Enqueue scripts.
public
scripts() : void
Return values
void —sort_brands()
Sort brands function.
public
sort_brands(array<string|int, mixed> $sortable) : mixed
Parameters
- $sortable : array<string|int, mixed>
-
Sortable array.
Return values
mixed —styles()
Enqueue styles.
public
styles() : void
Return values
void —taxonomy_description()
Description for brand page.
public
taxonomy_description() : mixed
Return values
mixed —thumbnail_field_save()
Saves thumbnail field.
public
thumbnail_field_save(int $term_id) : void
Parameters
- $term_id : int
-
Term ID.
Return values
void —validate_product_base()
Validate the product base.
public
validate_product_base(array<string|int, mixed> $value) : mixed
Must have an additional slug, not just the brand as the base.
Parameters
- $value : array<string|int, mixed>
-
Value.