Channel_Select
- Full name:
\BigCommerce\Settings\Sections\Channel_Select - Parent class:
\BigCommerce\Settings\Sections\Settings_Section
Constants
| Constant | Visibility | Type | Value |
|---|---|---|---|
NAME | public | ’channel_select’ | |
CHANNEL_TERM | public | ’bigcommerce_channel_term_id’ | |
NEW_CHANNEL | public | ’create’ | |
NEW_NAME | public | ’bigcommerce_new_channel_name’ |
Methods
register_settings_section
public register_settings_section(): mixedrender_channel_select_field
public render_channel_select_field(): mixedsanitize_channel_name
Sanitize the channel name before saving or using
public sanitize_channel_name(string $name): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$name | string | The channel name to sanitize |
Return Value:
The sanitized channel name
render_field
Override parent render_field to ensure channel name is sanitized
public render_field(mixed $args): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$args | mixed |
Inherited methods
render_field
public render_field(array $args): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$args | array |
render_number_field
public render_number_field(array $args): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$args | array |
get_disabled_attr_headless
Get disabled attribute if headless option is on
public get_disabled_attr_headless(): stringAutomatically generated on 2025-01-21