WooCommerce Code Reference

Transformer
in package

Transforms WooCommerce settings data into a structured format with logical groupings.

Table of Contents

$current_checkbox_group  : array<string|int, mixed>|null
Current checkbox group being processed.
$current_group  : array<string|int, mixed>|null
Current group being processed.
reset_state()  : void
Reset the state to its initial values.
transform()  : array<string|int, mixed>
Transform settings data.
add_setting()  : void
Add setting to current context (group or root).
end_checkbox_group()  : void
End current checkbox group.
finalize_transformation()  : void
Finalize the transformation process.
flush_current_checkbox_group()  : void
Flush current checkbox group to transformed settings.
flush_current_group()  : void
Flush current group to transformed settings.
handle_checkbox_group_item()  : void
Handle checkbox within a group.
handle_checkbox_setting()  : void
Handle checkbox setting and grouping.
handle_group_end()  : void
Handle the end of a group.
handle_group_start()  : void
Handle the start of a new group.
process_setting()  : void
Process individual setting.
start_checkbox_group()  : void
Start a new checkbox group.
transform_section_settings()  : array<string|int, mixed>
Transform settings within a section.
transform_sections()  : array<string|int, mixed>
Transform sections within a tab.

Properties

Methods

transform()

Transform settings data.

public transform(array<string|int, mixed> $raw_settings) : array<string|int, mixed>
Parameters
$raw_settings : array<string|int, mixed>

Raw settings data.

Return values
array<string|int, mixed>Transformed settings data.

add_setting()

Add setting to current context (group or root).

private add_setting(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

end_checkbox_group()

End current checkbox group.

private end_checkbox_group(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

finalize_transformation()

Finalize the transformation process.

private finalize_transformation(array<string|int, mixed> &$transformed_settings) : void
Parameters
$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

flush_current_group()

Flush current group to transformed settings.

private flush_current_group(array<string|int, mixed> &$transformed_settings) : void
Parameters
$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

handle_checkbox_group_item()

Handle checkbox within a group.

private handle_checkbox_group_item(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

handle_checkbox_setting()

Handle checkbox setting and grouping.

private handle_checkbox_setting(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

handle_group_end()

Handle the end of a group.

private handle_group_end(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

handle_group_start()

Handle the start of a new group.

private handle_group_start(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

process_setting()

Process individual setting.

private process_setting(array<string|int, mixed> $setting, array<string|int, mixed> &$transformed_settings) : void
Parameters
$setting : array<string|int, mixed>

Setting to process.

$transformed_settings : array<string|int, mixed>

Transformed settings array.

Return values
void

start_checkbox_group()

Start a new checkbox group.

private start_checkbox_group(array<string|int, mixed> $setting) : void
Parameters
$setting : array<string|int, mixed>

Setting to add.

Return values
void

transform_section_settings()

Transform settings within a section.

private transform_section_settings(array<string|int, mixed> $settings) : array<string|int, mixed>
Parameters
$settings : array<string|int, mixed>

Settings to transform.

Return values
array<string|int, mixed>Transformed settings.

transform_sections()

Transform sections within a tab.

private transform_sections(array<string|int, mixed> $sections) : array<string|int, mixed>
Parameters
$sections : array<string|int, mixed>

Sections to transform.

Return values
array<string|int, mixed>Transformed sections.