generator-chisel 2.3.2 → 2.4.0

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/WP/Site.php

@@ -5,36 +5,32 @@ namespace Chisel\WP;
 use Timber\Timber;
 use Timber\Site as TimberSite;
 
-use Chisel\Interfaces\InstanceInterface;
-use Chisel\Interfaces\HooksInterface;
-use Chisel\Traits\Singleton;
+use Chisel\Traits\HooksSingleton;
+use Chisel\Timber\ChiselImage;
+use Chisel\Timber\ChiselPost;
+use Chisel\Timber\ChiselProduct;
+use Chisel\Timber\ChiselProductCategory;
+use Chisel\Timber\ChiselTerm;
+use Chisel\Timber\Components;
 
 /**
  * Site related functionality related to timber.
  *
  * @package Chisel
  */
-final class Site extends TimberSite implements InstanceInterface, HooksInterface {
+final class Site extends TimberSite {
 
-	use Singleton;
+	use HooksSingleton;
 
 	/**
-	 * Class constructor.
+	 * Call parent constructor.
+	 *
+	 * @return bool
 	 */
-	private function __construct() {
-		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
-
-		$this->action_hooks();
-		$this->filter_hooks();
-
-		parent::__construct();
+	protected function should_call_parent_construct(): bool {
+		return true;
 	}
 
-	/**
-	 * Set properties.
-	 */
-	public function set_properties(): void {}
-
 	/**
 	 * Register action hooks.
 	 */
@@ -44,11 +40,33 @@ final class Site extends TimberSite implements InstanceInterface, HooksInterface
 	 * Register filter hooks.
 	 */
 	public function filter_hooks(): void {
+		add_filter( 'timber/locations', array( $this, 'tiwg_files_locations' ) );
 		add_filter( 'timber/context', array( $this, 'add_to_context' ) );
 		add_filter( 'timber/post/classmap', array( $this, 'post_classmap' ) );
 		add_filter( 'timber/term/classmap', array( $this, 'term_classmap' ) );
 	}
 
+	/**
+	 * Add custom Timber files locations. Let views in custom directory override default views.
+	 *
+	 * @param array $locations The locations.
+	 *
+	 * @return array
+	 */
+	public function tiwg_files_locations( array $locations ): array {
+		$custom_templates = get_template_directory() . '/custom/views/';
+
+		if ( is_dir( $custom_templates ) ) {
+			if ( isset( $locations['__main__'] ) ) {
+				array_unshift( $locations['__main__'], $custom_templates );
+			} else {
+				array_unshift( $locations, $custom_templates );
+			}
+		}
+
+		return $locations;
+	}
+
 	/**
 	 * Add data to the context.
 	 *
@@ -80,6 +98,14 @@ final class Site extends TimberSite implements InstanceInterface, HooksInterface
 			'attachment' => ChiselImage::class,
 		);
 
+		$custom_post_types = CustomPostTypes::get_post_types();
+
+		foreach ( $custom_post_types as $cpt => $data ) {
+			if ( ! isset( $custom_classmap[$cpt] ) ) {
+				$custom_classmap[$cpt] = ChiselPost::class;
+			}
+		}
+
 		return array_merge( $classmap, $custom_classmap );
 	}
 
@@ -95,6 +121,14 @@ final class Site extends TimberSite implements InstanceInterface, HooksInterface
 			'product_cat' => ChiselProductCategory::class,
 		);
 
+		$custom_taxonomies = CustomTaxonomies::get_taxonomies();
+
+		foreach ( $custom_taxonomies as $taxonomy => $data ) {
+			if ( ! isset( $custom_classmap[$taxonomy] ) ) {
+				$custom_classmap[$taxonomy] = ChiselTerm::class;
+			}
+		}
+
 		return array_merge( $classmap, $custom_classmap );
 	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/WP/Theme.php

@@ -2,9 +2,7 @@
 
 namespace Chisel\WP;
 
-use Chisel\Interfaces\InstanceInterface;
-use Chisel\Interfaces\HooksInterface;
-use Chisel\Traits\Singleton;
+use Chisel\Traits\HooksSingleton;
 use Chisel\Helpers\ThemeHelpers;
 
 /**
@@ -12,9 +10,9 @@ use Chisel\Helpers\ThemeHelpers;
  *
  * @package Chisel
  */
-final class Theme implements InstanceInterface, HooksInterface {
+final class Theme {
 
-	use Singleton;
+	use HooksSingleton;
 
 	/**
 	 * Post types that support post thumbnails.
@@ -30,16 +28,6 @@ final class Theme implements InstanceInterface, HooksInterface {
 	 */
 	private array $nav_menus = array();
 
-	/**
-	 * Class constructor.
-	 */
-	private function __construct() {
-		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
-
-		$this->action_hooks();
-		$this->filter_hooks();
-	}
-
 	/**
 	 * Set properties.
 	 */
@@ -83,6 +71,7 @@ final class Theme implements InstanceInterface, HooksInterface {
 	public function theme_supports(): void {
 		$this->post_thumbnails_post_types = (array) apply_filters( 'chisel_post_thumbnails_post_types', $this->post_thumbnails_post_types );
 
+		add_theme_support( 'title-tag' );
 		add_theme_support( 'post-formats', array() );
 		add_theme_support( 'post-thumbnails', $this->post_thumbnails_post_types );
 		add_theme_support( 'menus' );

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/WP/Twig.php

@@ -4,9 +4,7 @@ namespace Chisel\WP;
 
 use Timber\Timber;
 
-use Chisel\Interfaces\InstanceInterface;
-use Chisel\Interfaces\HooksInterface;
-use Chisel\Traits\Singleton;
+use Chisel\Traits\HooksSingleton;
 use Chisel\Helpers\CommentsHelpers;
 use Chisel\Helpers\DataHelpers;
 use Chisel\Helpers\ImageHelpers;
@@ -20,24 +18,9 @@ use Chisel\WP\Components;
  *
  * @package Chisel
  */
-final class Twig implements InstanceInterface, HooksInterface {
+final class Twig {
 
-	use Singleton;
-
-	/**
-	 * Class constructor.
-	 */
-	private function __construct() {
-		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
-
-		$this->action_hooks();
-		$this->filter_hooks();
-	}
-
-	/**
-	 * Set properties.
-	 */
-	public function set_properties(): void {}
+	use HooksSingleton;
 
 	/**
 	 * Register action hooks.
@@ -83,6 +66,8 @@ final class Twig implements InstanceInterface, HooksInterface {
 		$this->register_function( $twig, 'get_icon', array( $this, 'get_icon' ) );
 		$this->register_function( $twig, 'should_use_icons_module', array( $this, 'should_use_icons_module' ) );
 
+		do_action( 'chisel_twig_register_functions', $twig, $this );
+
 		return $twig;
 	}
 
@@ -93,6 +78,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 * @return \Twig\Environment
 	 */
 	public function register_filters( \Twig\Environment $twig ): \Twig\Environment {
+		do_action( 'chisel_twig_register_filters', $twig, $this );
 
 		return $twig;
 	}
@@ -104,6 +90,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 * @return \Twig\Environment
 	 */
 	public function register_tests( \Twig\Environment $twig ): \Twig\Environment {
+		do_action( 'chisel_twig_register_tests', $twig, $this );
 
 		return $twig;
 	}
@@ -117,7 +104,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_function( $twig, $name, $callback ): \Twig\Environment {
+	public function register_function( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addFunction( new \Twig\TwigFunction( $name, $callback ) );
 
 		return $twig;
@@ -132,7 +119,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_filter( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
+	public function register_filter( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addFilter( new \Twig\TwigFilter( $name, $callback ) );
 
 		return $twig;
@@ -147,7 +134,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_test( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
+	public function register_test( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addTest( new \Twig\TwigTest( $name, $callback ) );
 
 		return $twig;
@@ -182,20 +169,14 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return string
 	 */
-	public function post_classes( ?string $classes, string $prefix = 'c-post--' ): string {
+	public function post_classes( ?string $classes, string $prefix = 'c-post' ): string {
 		if ( empty( $classes ) ) {
 			return '';
 		}
 
 		$classnames = explode( ' ', $classes );
-		$classnames = array_map(
-			function ( $classname ) use ( $prefix ) {
-				return $prefix . $classname;
-			},
-			$classnames
-		);
 
-		return implode( ' ', $classnames );
+		return ThemeHelpers::bem( $prefix, ...$classnames );
 	}
 
 	/**

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/Timber/ChiselPost.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Chisel\Timber\Custom;
+
+use Chisel\Timber\ChiselPost as CoreChiselPost;
+use Timber\Timber;
+
+/**
+ * Extend Timber Post class with custom functionality.
+ *
+ * @package Chisel
+ */
+class ChiselPost extends CoreChiselPost {
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Acf.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * ACF related functionality.
+ *
+ * @package Chisel
+ */
+class Acf {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_acf_options_pages', array( $this, 'register_acf_options_pages' ) );
+		add_filter( 'chisel_acf_options_sub_pages', array( $this, 'register_acf_options_sub_pages' ) );
+	}
+
+	/**
+	 * Register custom ACF options pages.
+	 *
+	 * @param array $options_pages The options pages.
+	 *
+	 * @return array
+	 */
+	public function register_acf_options_pages( $options_pages ) {
+		// phpcs:disable -- Example of custom ACF options page
+		// $options_pages[] = array(
+		// 	'menu_slug'  => 'theme-settings',
+		// 	'page_title' => __( 'Theme Settings', 'chisel' ),
+		// );
+		// phpcs:enable
+
+		return $options_pages;
+	}
+
+	/**
+	 * Register custom ACF options sub pages.
+	 *
+	 * @param array $options_sub_pages The options sub pages.
+	 *
+	 * @return array
+	 */
+	public function register_acf_options_sub_pages( $options_sub_pages ) {
+		// phpcs:disable -- Example of custom ACF options sub page
+		// $options_sub_pages[] = array(
+		// 	'menu_slug'   => 'theme-sub-settings',
+		// 	'page_title'  => __( 'Theme Sub settings', 'chisel' ),
+		// 	'menu_title'  => __( 'Theme Sub settings', 'chisel' ),
+		// 	'parent_slug' => 'theme-settings',
+		// );
+		// phpcs:enable
+
+		return $options_sub_pages;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Ajax.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Ajax related functionality.
+ *
+ * @package Chisel
+ */
+class Ajax {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_ajax_routes', array( $this, 'register_ajax_routes' ) );
+	}
+
+	/**
+	 * Register custom ajax routes.
+	 *
+	 * @param array $routes The ajax routes.
+	 *
+	 * @return array
+	 */
+	public function register_ajax_routes( array $routes ): array {
+		// phpcs:disable -- Example of custom ajax route
+		// $routes['custom_route'] = array(
+		// 	'methods'  => 'POST', // default is POST
+		// 	'handler'  => 'Chisel\WP\Custom\Ajax\CustomRouteHandler', // custom handler class, leave empty for default handler: CustomRouteEndpoint
+		// );
+		// phpcs:enable
+
+		return $routes;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Assets.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Class for enqueuing scripts and styles.
+ *
+ * @package Chisel
+ */
+class Assets {
+	use HooksSingleton;
+
+	/**
+	 * Add action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Add filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_frontend_styles', array( $this, 'frontend_styles' ) );
+	}
+
+	/**
+	 * Modify frontend styles.
+	 *
+	 * @param array $styles Frontend styles.
+	 *
+	 * @return array Frontend styles.
+	 */
+	public function frontend_styles( array $styles ): array {
+		return $styles;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/CustomPostTypes.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Custom Post Types related functionality.
+ *
+ * @package Chisel
+ */
+class CustomPostTypes {
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_custom_post_types', array( $this, 'register_custom_post_types' ) );
+		add_filter( 'chisel_custom_taxonomies', array( $this, 'register_custom_taxonomies' ) );
+	}
+
+	/**
+	 * Register custom post types.
+	 *
+	 * @param array $post_types The post types.
+	 *
+	 * @return array
+	 */
+	public function register_custom_post_types( $post_types ) {
+		// phpcs:disable -- Example of custom post type. Remove this line and the phpcs:enable when adding your own custom post types
+		// $post_types['chisel-cpt'] = array(
+		// 	'singular'      => __( 'Chisel CPT', 'chisel' ),
+		// 	'plural'        => __( 'Chisel CPTs', 'chisel' ),
+		// 	'supports'      => array( 'editor', 'thumbnail', 'excerpt' ),
+		// 	'menu_icon'     => 'dashicons-location-alt',
+		// 	'hierarchical'  => true,
+		// 	'public'        => true,
+		// 	'menu_position' => 20,
+		// 	'rewrite'       => array(
+		// 		'slug' => 'chisel-post',
+		// 	),
+		// );
+		// phpcs:enable
+
+		return $post_types;
+	}
+
+	/**
+	 * Register custom taxonomies.
+	 *
+	 * @param array $taxonomies The taxonomies.
+	 *
+	 * @return array
+	 */
+	public function register_custom_taxonomies( $taxonomies ) {
+		// phpcs:disable -- Example of custom taxonomy. Remove this line and the phpcs:enable when adding your own custom taxonomies
+		// $taxonomies['chisel-term'] = array(
+		// 	'singular'   => __( 'Chisel Term', 'chisel' ),
+		// 	'plural'     => __( 'Chisel Terms', 'chisel' ),
+		// 	'post_types' => array( 'chisel-cpt' ),
+		// 	'public'     => true,
+		// 	'rewrite'    => array(
+		// 		'slug' => 'chisel-term',
+		// 	),
+		// );
+		// phpcs:enable
+
+		return $taxonomies;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Site.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Site related functionality related to timber.
+ *
+ * @package Chisel
+ */
+class Site {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'timber/post/classmap', array( $this, 'post_classmap' ), 11 );
+	}
+
+	/**
+	 * Add custom post class map.
+	 *
+	 * @param array $classmap The class map.
+	 *
+	 * @return array
+	 */
+	public function post_classmap( array $classmap ): array {
+		$custom_classmap = array(
+			'post' => \Chisel\Timber\Custom\ChiselPost::class,
+		);
+
+		return array_merge( $classmap, $custom_classmap );
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Twig.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Custom Twig functionality.
+ *
+ * @package Chisel
+ */
+class Twig {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {
+		add_action( 'chisel_twig_register_functions', array( $this, 'register_functions' ), 10, 2 );
+		add_action( 'chisel_twig_register_filters', array( $this, 'register_filters' ), 10, 2 );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {}
+
+	/**
+	 * Register custom twig functions.
+	 *
+	 * @param \Twig\Environment $twig The Twig environment.
+	 * @param \Chisel\WP\Twig   $chisel_twig The Chisel Twig instance.
+	 */
+	public function register_functions( \Twig\Environment $twig, \Chisel\WP\Twig $chisel_twig ): void {
+		// phpcs:disable -- Example of custom function. Remove this line and the phpcs:enable when adding your own custom functions
+		// $twig->addFunction( new \Twig\Function( 'custom_fn', array( $this, 'custom_fn_callback' ) ) );
+		// phpcs:enable
+	}
+
+	/**
+	 * Register custom twig filters.
+	 *
+	 * @param \Twig\Environment $twig The Twig environment.
+	 * @param \Chisel\WP\Twig   $chisel_twig The Chisel Twig instance.
+	 */
+	public function register_filters( \Twig\Environment $twig, \Chisel\WP\Twig $chisel_twig ): void {
+		// phpcs:disable -- Example of custom filter. Remove this line and the phpcs:enable when adding your own custom filters
+		// $twig->addFilter( new \Twig\Filter( 'custom_filter', array( $this, 'custom_filter_callback' ) ) );
+		// phpcs:enable
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/functions.php

@@ -0,0 +1,8 @@
+<?php
+
+\Chisel\WP\Custom\Acf::get_instance();
+\Chisel\WP\Custom\Ajax::get_instance();
+\Chisel\WP\Custom\Assets::get_instance();
+\Chisel\WP\Custom\CustomPostTypes::get_instance();
+\Chisel\WP\Custom\Site::get_instance();
+\Chisel\WP\Custom\Twig::get_instance();

package/lib/commands/create/creators/app/chisel-starter-theme/custom/views/README.md

@@ -0,0 +1,7 @@
+# Custom views
+
+Recommended approach is to use the main views folder, but if want more control and clear separation between the main theme and customizations, use the custom views folder.
+
+## Usage
+
+To overwrite views existing in the main folder create a file with the same name and the same folder structure.