This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 219
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor checkout templates to share logic (#9411)
- Loading branch information
1 parent
20bc253
commit 58cb700
Showing
7 changed files
with
333 additions
and
241 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| <?php | ||
| namespace Automattic\WooCommerce\Blocks\Templates; | ||
|
|
||
| /** | ||
| * AbstractPageTemplate class. | ||
| * | ||
| * Shared logic for page templates. | ||
| * | ||
| * @internal | ||
| */ | ||
| abstract class AbstractPageTemplate { | ||
| /** | ||
| * Page Template functionality is only initialized when using a block theme. | ||
| */ | ||
| public function __construct() { | ||
| if ( wc_current_theme_is_fse_theme() ) { | ||
| $this->init(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Initialization method. | ||
| */ | ||
| protected function init() { | ||
| add_filter( 'page_template_hierarchy', array( $this, 'page_template_hierarchy' ), 1 ); | ||
| add_filter( 'frontpage_template_hierarchy', array( $this, 'page_template_hierarchy' ), 1 ); | ||
| add_filter( 'woocommerce_blocks_template_content', array( $this, 'page_template_content' ), 10, 2 ); | ||
| add_action( 'current_screen', array( $this, 'page_template_editor_redirect' ) ); | ||
| add_filter( 'pre_get_document_title', array( $this, 'page_template_title' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the template slug. | ||
| * | ||
| * @return string | ||
| */ | ||
| abstract public static function get_slug(); | ||
|
|
||
| /** | ||
| * Returns the page object assigned to this template/page used for legacy purposes. Pages are no longer required. | ||
| * | ||
| * @return \WP_Post|null Post object or null. | ||
| */ | ||
| abstract public static function get_legacy_page(); | ||
|
|
||
| /** | ||
| * Should return true on pages/endpoints/routes where the template should be shown. | ||
| * | ||
| * @return boolean | ||
| */ | ||
| abstract protected function is_active_template(); | ||
|
|
||
| /** | ||
| * Should return the title of the page. | ||
| * | ||
| * @return string | ||
| */ | ||
| abstract protected function get_template_title(); | ||
|
|
||
| /** | ||
| * Returns the URL to edit the template. | ||
| * | ||
| * @return string | ||
| */ | ||
| protected function get_edit_template_url() { | ||
| return admin_url( 'site-editor.php?postType=wp_template&postId=woocommerce%2Fwoocommerce%2F%2F' . $this->get_slug() ); | ||
| } | ||
|
|
||
| /** | ||
| * Get the default content for a template. | ||
| * | ||
| * Overridden by child class to include their own logic. | ||
| * | ||
| * @param string $template_content The original content of the template. | ||
| * @return string | ||
| */ | ||
| protected function get_default_template_content( $template_content ) { | ||
| return $template_content; | ||
| } | ||
|
|
||
| /** | ||
| * When the page should be displaying the template, add it to the hierarchy. | ||
| * | ||
| * This places the template name e.g. `cart`, at the beginning of the template hierarchy array. The hook priority | ||
| * is 1 to ensure it runs first; other consumers e.g. extensions, could therefore inject their own template instead | ||
| * of this one when using the default priority of 10. | ||
| * | ||
| * @param array $templates Templates that match the pages_template_hierarchy. | ||
| */ | ||
| public function page_template_hierarchy( $templates ) { | ||
| if ( $this->is_active_template() ) { | ||
| array_unshift( $templates, $this->get_slug() ); | ||
| } | ||
| return $templates; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the default template content. | ||
| * | ||
| * @param string $template_content The content of the template. | ||
| * @param object $template_file The template file object. | ||
| * @return string | ||
| */ | ||
| public function page_template_content( $template_content, $template_file ) { | ||
| if ( $this->get_slug() !== $template_file->slug ) { | ||
| return $template_content; | ||
| } | ||
| return $this->get_default_template_content( $template_content ); | ||
| } | ||
|
|
||
| /** | ||
| * Redirect the edit page screen to the template editor. | ||
| * | ||
| * @param \WP_Screen $current_screen Current screen information. | ||
| */ | ||
| public function page_template_editor_redirect( \WP_Screen $current_screen ) { | ||
| $page = $this->get_legacy_page(); | ||
| $edit_page_id = 'page' === $current_screen->id && ! empty( $_GET['post'] ) ? absint( $_GET['post'] ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended | ||
|
|
||
| if ( $page && $edit_page_id === $page->id ) { | ||
| wp_safe_redirect( $this->get_edit_template_url() ); | ||
| exit; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Filter the page title when the template is active. | ||
| * | ||
| * @param string $title Page title. | ||
| * @return string | ||
| */ | ||
| public function page_template_title( $title ) { | ||
| if ( $this->is_active_template() ) { | ||
| return $this->get_template_title(); | ||
| } | ||
| return $title; | ||
| } | ||
| } |
Oops, something went wrong.