ClassesBigCommerceAccountsWishlistsWishlist Public View

Wishlist_Public_View

Abstract class for handling wishlist public view actions, including filtering main queries, setting the page title, and modifying results when no items are found.

  • Full name: \BigCommerce\Accounts\Wishlists\Wishlist_Public_View
  • This class is an Abstract class

Methods

filter_main_query

Filter the main query to display wishlist-specific products.

public filter_main_query(\WP_Query $query): void
  • This method is abstract.

Parameters:

ParameterTypeDescription
$query\WP_QueryThe WordPress query object.

set_page_title

Set the page title for the wishlist view.

public set_page_title(array $template_data): array
  • This method is abstract.

Parameters:

ParameterTypeDescription
$template_dataarrayThe template data for the current page.

Return Value:

The modified template data.


set_wp_title

Set the WordPress title for the wishlist page.

public set_wp_title(string $title, string $post_type): string
  • This method is abstract.

Parameters:

ParameterTypeDescription
$titlestringThe current title of the page.
$post_typestringThe type of post being queried.

Return Value:

The modified page title.


set_no_results_message

Set the no results message for the wishlist page.

public set_no_results_message(array $template_data): array
  • This method is abstract.

Parameters:

ParameterTypeDescription
$template_dataarrayThe template data for the current page.

Return Value:

The modified template data with updated no results message.


remove_refinery

Remove the refinery component from the product archive template.

public remove_refinery(array $template_data): array

Parameters:

ParameterTypeDescription
$template_dataarrayThe template data for the current page.

Return Value:

The modified template data with the refinery component removed.



Automatically generated on 2025-01-21