ClassesBigCommercePagesCart Page

Cart_Page

Constants

ConstantVisibilityTypeValue
NAMEpublicstring’bigcommerce_cart_page_id’
SLUGpublic’cart’

Methods

get_title

protected get_title(): string

Return Value:

The title of the post


get_slug

protected get_slug(): string

Return Value:

The slug of the post


get_content

public get_content(): string

Return Value:

The content of the post


get_post_state_label

public get_post_state_label(): string

Return Value:

The label to show on this post in list tables


Inherited methods

__construct

public __construct(): mixed

get_option_name

public get_option_name(): mixed

get_post_type

protected get_post_type(): string

Return Value:

The post type of the post that will be created


get_title

protected get_title(): string
  • This method is abstract.

Return Value:

The title of the post


get_slug

protected get_slug(): string
  • This method is abstract.

Return Value:

The slug of the post


get_content

public get_content(): string

Return Value:

The content of the post


filter_content

Add page shortcode to the content if missing

public filter_content(int $post_id, string $content): string

Parameters:

ParameterTypeDescription
$post_idintPost id
$contentstringPost content

Return Value:

The content of the post


get_post_state_label

public get_post_state_label(): string

Return Value:

The label to show on this post in list tables


ensure_page_exists

Ensure that there is a page designated as this page at all times. Creates one if necessary.

public ensure_page_exists(): void

clear_option_on_delete

public clear_option_on_delete(mixed $post_id): void

Parameters:

ParameterTypeDescription
$post_idmixed

match_existing_post

Find an existing post that can be designated as the required page.

protected match_existing_post(): int

Return Value:

The ID of the matching post. 0 if none found.


get_post_candidates

Find all the posts that meet the criteria (e.g., post type, content) to become this required page.

public get_post_candidates(bool $include_uninstalled = false): int[]

Parameters:

ParameterTypeDescription
$include_uninstalledboolWhether the list of candidates should include
pages that have been uninstalled and set to draft

Return Value:

Post IDs of potential posts


create_post

Create the post for this config

protected create_post(): int

Return Value:

the ID of the created post


get_post_args

protected get_post_args(): array

Return Value:

The args for creating the post


add_post_state

public add_post_state(array $post_states, \WP_Post $post): array

Parameters:

ParameterTypeDescription
$post_statesarray
$post\WP_Post


Automatically generated on 2025-01-21