Api_Credentials
- Full name:
\BigCommerce\Settings\Sections\Api_Credentials - Parent class:
\BigCommerce\Settings\Sections\Settings_Section
Constants
| Constant | Visibility | Type | Value |
|---|---|---|---|
NAME | public | ’credentials’ | |
OPTION_STORE_URL | public | ’bigcommerce_store_url’ | |
OPTION_CLIENT_ID | public | ’bigcommerce_client_id’ | |
OPTION_CLIENT_SECRET | public | ’bigcommerce_client_secret’ | |
OPTION_ACCESS_TOKEN | public | ’bigcommerce_access_token’ |
Methods
register_settings_section
public register_settings_section(mixed $suffix, mixed $screen): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$suffix | mixed | |
$screen | mixed |
render_help_text
Add a link to set up the API account
public render_help_text(): voidrender_field
public render_field(mixed $args): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$args | mixed |
render_text
Render the field as a disabled text field without a name. Password fields will be rendered with bullets in place of the value.
protected render_text(array $args): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$args | array |
filter_option_with_env
public filter_option_with_env(bool|mixed $value, string $option, mixed $default): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$value | bool|mixed | |
$option | string | |
$default | mixed |
do_api_settings_updated_action
Fires an action (once per pageload) when an API credential setting updates.
public do_api_settings_updated_action(string $old_value, string $new_value): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$old_value | string | Previous option value. |
$new_value | string | New option value. |
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