Term_Creator

Class Term_Creator

Handles the creation and saving of terms in WordPress during the import process. This class extends Term_Saver and includes methods for inserting terms and saving term metadata.

• Full name: \BigCommerce\Import\Importers\Terms\Term_Creator
• Parent class: \BigCommerce\Import\Importers\Terms\Term_Saver

Methods

save_wp_term

Saves a BigCommerce term to WordPress as a WP term.

protected save_wp_term(\ArrayAccess $bc_term): int

This method inserts a new term into WordPress using the wp_insert_term function. If an error occurs during insertion, a log entry is created using the bigcommerce/import/log action.

Parameters:

Return Value:

The term ID if the term was successfully created, 0 otherwise.

save_wp_termmeta

Saves term metadata for a WordPress term.

protected save_wp_termmeta(\ArrayAccess $bc_term): void

This method updates the metadata for a term in WordPress. It stores the BigCommerce ID, sort order, and visibility status for the term.

Parameters:

Inherited methods

__construct

Term_Saver constructor.

public __construct(\ArrayAccess $bc_term, string $taxonomy, int $term_id): mixed

Initializes the Term_Saver with the provided BigCommerce term, taxonomy, and optional term ID.

Parameters:

do_import

Imports the term into WordPress, saving term data, term metadata, and images.

public do_import(): int

Return Value:

The imported term ID.

get_term_bc_id

Returns the BigCommerce ID of the term.

public get_term_bc_id(\ArrayAccess $bc_term): int|null

Parameters:

Return Value:

The BigCommerce ID or category ID.

save_wp_term

Saves the term in WordPress.

protected save_wp_term(\ArrayAccess $bc_term): int

• This method is abstract.

Parameters:

Return Value:

The ID of the created or updated term.

save_wp_termmeta

Saves the term metadata in WordPress.

protected save_wp_termmeta(\ArrayAccess $bc_term): mixed

• This method is abstract.

Parameters:

term_name

Returns the name of the term, sanitized for WordPress.

protected term_name(\ArrayAccess $bc_term): string

Parameters:

Return Value:

The sanitized term name.

term_slug

Returns the slug for the term, either from the custom URL or generated from the name.

protected term_slug(\ArrayAccess $bc_term): string

Parameters:

Return Value:

The term slug.

sanitize_int

Sanitizes an integer value.

protected sanitize_int(mixed $value): int

Parameters:

Return Value:

The sanitized integer value.

sanitize_string

Sanitizes a string value.

protected sanitize_string(mixed $value): string

Parameters:

Return Value:

The sanitized string value.

get_term_args

Returns the arguments for the term, including the slug, description, and parent ID.

protected get_term_args(\ArrayAccess $bc_term): array

Parameters:

Return Value:

The arguments for the term.

determine_parent_term_id

Determines the parent term ID for the given BigCommerce term.

protected determine_parent_term_id(\ArrayAccess $bc_term): int

Parameters:

Return Value:

The parent term ID.

import_image

Imports the image for the term, either by finding an existing image or importing a new one.

protected import_image(\ArrayAccess $bc_term): mixed

Parameters:

hash

Calculates a hash for the given term data.

public static hash(\ArrayAccess $bc_term): string

• This method is static.

Parameters:

Return Value:

The calculated hash.

Automatically generated on 2025-01-21