Channels
Class Channels
Channel configuration after the plugin has been fully configured, which at this point is limited to changing the channel name
- Full name:
\BigCommerce\Settings\Sections\Channels
- Parent class:
\BigCommerce\Settings\Sections\Settings_Section
Constants
Constant | Visibility | Type | Value |
---|---|---|---|
NAME | public | ’channel’ | |
CHANNEL_ID | public | ’bigcommerce_channel_id’ | |
CHANNEL_NAME | public | ’bigcommerce_channel_name’ | |
NEW_NAME | public | ’bigcommerce_add_channel_name’ | |
PRIMARY_CHANNEL | public | ’bigcommerce_primary_channel’ | |
CONNECTED_CHANNELS | public | ’bigcommerce_connected_channels’ | |
OTHER_CHANNELS | public | ’bigcommerce_other_channels’ | |
ACTION_RENAME | public | ’rename’ | |
ACTION_CONNECT | public | ’connect’ | |
ACTION_DISCONNECT | public | ’disconnect’ | |
ACTION_PROMOTE | public | ’promote’ | |
POST_ACTION | public | ’bigcommerce-channel-operation’ |
Methods
register_settings_section
public register_settings_section(): mixed
render_primary_channel
public render_primary_channel(): mixed
render_connected_channels
public render_connected_channels(): mixed
render_other_channels
public render_other_channels(): mixed
handle_action_submission
Handle a request to perform an operation on an existing channel
public handle_action_submission(string $redirect): void
Parameters:
Parameter | Type | Description |
---|---|---|
$redirect | string | URL to redirect to after handling the submission |
promote_channel
Promote a channel to the “Primary” status, demoting the current primary to the “Connected” status
public promote_channel(\WP_Term $term): void
Parameters:
Parameter | Type | Description |
---|---|---|
$term | \WP_Term |
save_channel_names
Save channel name changes to taxonomy terms, not to options
public save_channel_names(array $value): null
Parameters:
Parameter | Type | Description |
---|---|---|
$value | array |
Inherited methods
render_field
public render_field(array $args): void
Parameters:
Parameter | Type | Description |
---|---|---|
$args | array |
render_number_field
public render_number_field(array $args): void
Parameters:
Parameter | Type | Description |
---|---|---|
$args | array |
get_disabled_attr_headless
Get disabled attribute if headless option is on
public get_disabled_attr_headless(): string
Automatically generated on 2025-01-21