ClassesBigCommerceSettingsSectionsAPI Credentials

Api_Credentials

Constants

ConstantVisibilityTypeValue
NAMEpublic’credentials’
OPTION_STORE_URLpublic’bigcommerce_store_url’
OPTION_CLIENT_IDpublic’bigcommerce_client_id’
OPTION_CLIENT_SECRETpublic’bigcommerce_client_secret’
OPTION_ACCESS_TOKENpublic’bigcommerce_access_token’

Methods

register_settings_section

public register_settings_section(mixed $suffix, mixed $screen): void

Parameters:

ParameterTypeDescription
$suffixmixed
$screenmixed

render_help_text

Add a link to set up the API account

public render_help_text(): void

render_field

public render_field(mixed $args): void

Parameters:

ParameterTypeDescription
$argsmixed

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): void

Parameters:

ParameterTypeDescription
$argsarray

filter_option_with_env

public filter_option_with_env(bool|mixed $value, string $option, mixed $default): mixed

Parameters:

ParameterTypeDescription
$valuebool|mixed
$optionstring
$defaultmixed

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): mixed

Parameters:

ParameterTypeDescription
$old_valuestringPrevious option value.
$new_valuestringNew option value.

Inherited methods

render_field

public render_field(array $args): void

Parameters:

ParameterTypeDescription
$argsarray

render_number_field

public render_number_field(array $args): void

Parameters:

ParameterTypeDescription
$argsarray

get_disabled_attr_headless

Get disabled attribute if headless option is on

public get_disabled_attr_headless(): string


Automatically generated on 2025-01-21