WooCommerce Code Reference

WC_Product_CSV_Importer_Controller
in package

Product importer controller - handles file upload and forms in admin.

Tags
version
3.1.0

Table of Contents

$character_encoding  : string
The character encoding to use to interpret the input file, or empty string for autodetect.
$delimiter  : string
The current delimiter for the file being read.
$errors  : array<string|int, mixed>
Errors.
$file  : string
The path to the current file.
$map_preferences  : bool
Whether to use previous mapping selections.
$step  : string
The current import step.
$steps  : array<string|int, mixed>
Progress steps.
$update_existing  : bool
Whether to skip existing products.
__construct()  : mixed
Constructor.
auto_map_user_preferences()  : array<string|int, mixed>
Map columns using the user's latest import mappings.
dispatch()  : mixed
Dispatch current step and show correct view.
get_importer()  : WC_Product_CSV_Importer
Get importer instance.
get_next_step_link()  : string
Get the URL for the next step's screen.
handle_upload()  : string|WP_Error
Handles the CSV upload and initial parsing of the file to prepare for displaying author import options.
import()  : mixed
Import the file if it exists and is valid.
is_file_valid_csv()  : bool
Check whether a file is a valid CSV file.
upload_form_handler()  : mixed
Handle the upload form and store options.
add_error()  : mixed
Add error message.
auto_map_columns()  : array<string|int, mixed>
Auto map column names.
done()  : mixed
Done step.
get_mapping_options()  : array<string|int, mixed>
Get mapping options.
get_special_columns()  : array<string|int, mixed>
Get special columns.
get_valid_csv_filetypes()  : array<string|int, mixed>
Get all the valid filetypes for a CSV file.
mapping_form()  : mixed
Mapping step.
normalize_columns_names()  : array<string|int, mixed>
Columns to normalize.
output_errors()  : mixed
Add error message.
output_footer()  : mixed
Output footer view.
output_header()  : mixed
Output header view.
output_steps()  : mixed
Output steps view.
sanitize_special_column_name_regex()  : string
Sanitize special column name regex.
upload_form()  : mixed
Output information about the uploading process.

Properties

Methods

auto_map_user_preferences()

Map columns using the user's latest import mappings.

public auto_map_user_preferences(array<string|int, mixed> $headers) : array<string|int, mixed>
Parameters
$headers : array<string|int, mixed>

Header columns.

Return values
array<string|int, mixed> —

get_next_step_link()

Get the URL for the next step's screen.

public get_next_step_link([string $step = '' ]) : string
Parameters
$step : string = ''

slug (default: current step).

Return values
string — URL for next step if a next step exists. Admin URL if it's the last step. Empty string on failure.

is_file_valid_csv()

Check whether a file is a valid CSV file.

public static is_file_valid_csv(string $file[, bool $check_path = true ]) : bool
Parameters
$file : string

File path.

$check_path : bool = true

Whether to also check the file is located in a valid location (Default: true).

Return values
bool —

add_error()

Add error message.

protected add_error(string $message[, array<string|int, mixed> $actions = array() ]) : mixed
Parameters
$message : string

Error message.

$actions : array<string|int, mixed> = array()

List of actions with 'url' and 'label'.

Return values
mixed —

auto_map_columns()

Auto map column names.

protected auto_map_columns(array<string|int, mixed> $raw_headers[, bool $num_indexes = true ]) : array<string|int, mixed>
Parameters
$raw_headers : array<string|int, mixed>

Raw header columns.

$num_indexes : bool = true

If should use numbers or raw header columns as indexes.

Return values
array<string|int, mixed> —