generator-chisel 2.1.2 → 2.2.1

package/lib/commands/create/creators/app/chisel-starter-theme/inc/WP/ChiselProduct.php

@@ -4,7 +4,7 @@ namespace Chisel\WP;
 
 use Timber\Post as TimberPost;
 use Timber\Timber;
-use Chisel\Helper\ImageHelpers;
+use Chisel\Helpers\ImageHelpers;
 
 /**
  * Extend Timber Post class with custom functionality. This is a woocommerce product class.
@@ -16,30 +16,32 @@ class ChiselProduct extends TimberPost {
 	/**
 	 * Product thumbnail.
 	 *
-	 * @var html
+	 * @var ?string
 	 */
-	public $thumbnail_html = null;
+	public ?string $thumbnail_html = null;
 
 	/**
 	 * Category thumbnail id.
 	 *
-	 * @var int
+	 * @var ?int
 	 */
-	public $thumbnail_id = null;
+	public ?int $thumbnail_id = null;
 
 	/**
 	 * Get the product thumbnail. Returns the thumbnail responsive image html.
 	 *
 	 * @param string $size Thumbnail size.
-	 * @return html
+	 * @param array  $attrs Image attributes.
+	 *
+	 * @return string Responsive <img> HTML, or empty string.
 	 */
-	public function get_thumbnail( $size = 'woocommerce_thumbnail' ) {
+	public function get_thumbnail( string $size = 'woocommerce_thumbnail', array $attrs = array() ): string {
 		$size = apply_filters( 'single_product_archive_thumbnail_size', $size );
 
 		if ( $this->thumbnail_html === null ) {
-			$thumbnail_id = $this->get_thumbnail_id( $size );
+			$thumbnail_id = $this->get_thumbnail_id();
 
-			$this->thumbnail_html = $thumbnail_id ? ImageHelpers::get_responsive_image( $thumbnail_id, $size ) : '';
+			$this->thumbnail_html = $thumbnail_id ? ImageHelpers::get_responsive_image( $thumbnail_id, $size, $attrs ) : '';
 		}
 
 		return $this->thumbnail_html;
@@ -50,7 +52,7 @@ class ChiselProduct extends TimberPost {
 	 *
 	 * @return int
 	 */
-	public function get_thumbnail_id() {
+	public function get_thumbnail_id(): int {
 		if ( $this->thumbnail_id === null ) {
 			$thumbnail_id = get_post_thumbnail_id( $this->ID );
 
@@ -61,6 +63,6 @@ class ChiselProduct extends TimberPost {
 			$this->thumbnail_id = $thumbnail_id;
 		}
 
-		return $this->thumbnail_id;
+		return (int) $this->thumbnail_id;
 	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/inc/WP/ChiselProductCategory.php

@@ -3,7 +3,7 @@
 namespace Chisel\WP;
 
 use Timber\Term as TimberTerm;
-use Chisel\Helper\ImageHelpers;
+use Chisel\Helpers\ImageHelpers;
 
 /**
  * Extend Timber Term class with custom functionality.
@@ -15,31 +15,32 @@ class ChiselProductCategory extends TimberTerm {
 	/**
 	 * Category thumbnail.
 	 *
-	 * @var html
+	 * @var ?string
 	 */
-	public $thumbnail_html = null;
+	public ?string $thumbnail_html = null;
 
 	/**
 	 * Category thumbnail id.
 	 *
-	 * @var int
+	 * @var ?int
 	 */
-	public $thumbnail_id = null;
+	public ?int $thumbnail_id = null;
 
 	/**
 	 * Get the product thumbnail. Returns the thumbnail responsive image html.
 	 *
 	 * @param string $size Thumbnail size.
+	 * @param array  $attrs Image attributes.
 	 *
-	 * @return html
+	 * @return string Responsive <img> HTML, or empty string.
 	 */
-	public function get_thumbnail( $size = 'woocommerce_thumbnail' ) {
+	public function get_thumbnail( string $size = 'woocommerce_thumbnail', array $attrs = array() ): string {
 		$size = apply_filters( 'subcategory_archive_thumbnail_size', $size );
 
 		if ( $this->thumbnail_html === null ) {
-			$thumbnail_id = $this->get_thumbnail_id( $size );
+			$thumbnail_id = $this->get_thumbnail_id();
 
-			$this->thumbnail_html = $thumbnail_id ? ImageHelpers::get_responsive_image( $thumbnail_id, $size ) : '';
+			$this->thumbnail_html = $thumbnail_id ? ImageHelpers::get_responsive_image( $thumbnail_id, $size, $attrs ) : '';
 		}
 
 		return $this->thumbnail_html;
@@ -50,9 +51,9 @@ class ChiselProductCategory extends TimberTerm {
 	 *
 	 * @return int
 	 */
-	public function get_thumbnail_id() {
+	public function get_thumbnail_id(): int {
 		if ( $this->thumbnail_id === null ) {
-			$thumbnail_id = $this->meta( 'thumbnail_id' );
+			$thumbnail_id = (int) $this->meta( 'thumbnail_id' );
 
 			if ( ! $thumbnail_id ) {
 				$thumbnail_id = get_option( 'woocommerce_placeholder_image', 0 );

package/lib/commands/create/creators/app/chisel-starter-theme/inc/WP/Comments.php

@@ -11,7 +11,7 @@ use Chisel\Traits\Singleton;
  *
  * @package Chisel
  */
-class Comments implements InstanceInterface, HooksInterface {
+final class Comments implements InstanceInterface, HooksInterface {
 
 	use Singleton;
 
@@ -20,14 +20,14 @@ class Comments implements InstanceInterface, HooksInterface {
 	 *
 	 * @var bool
 	 */
-	private $disable_comments;
+	private bool $disable_comments = true;
 
 	/**
 	 *  Post types for which comments are disabled.
 	 *
 	 * @var array
 	 */
-	private $post_types = array(
+	private array $post_types = array(
 		'post',
 		'page',
 	);
@@ -47,14 +47,14 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Set properties.
 	 */
-	public function set_properties() {
+	public function set_properties(): void {
 		$this->disable_comments = apply_filters( 'chisel_disable_comments', true );
 	}
 
 	/**
 	 * Register action hooks.
 	 */
-	public function action_hooks() {
+	public function action_hooks(): void {
 			add_action( 'after_setup_theme', array( $this, 'disable_comments_for_post_types' ), 99 );
 			add_action( 'admin_menu', array( $this, 'remove_admin_menu' ), 999 );
 
@@ -74,7 +74,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Register filter hooks.
 	 */
-	public function filter_hooks() {
+	public function filter_hooks(): void {
 			add_filter( 'wp_headers', array( $this, 'filter_wp_headers' ) );
 			add_filter( 'pre_option_default_pingback_flag', '__return_zero' );
 			add_filter( 'comments_open', '__return_false', 20 );
@@ -102,7 +102,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	 *
 	 * @return void
 	 */
-	public function disable_comments_for_post_types() {
+	public function disable_comments_for_post_types(): void {
 		$this->post_types = apply_filters( 'chisel_disable_comments_post_types', $this->post_types );
 
 		if ( $this->post_types ) {
@@ -121,7 +121,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Remove comments related admin menus.
 	 */
-	public function remove_admin_menu() {
+	public function remove_admin_menu(): void {
 		global $pagenow;
 
 		if ( in_array( $pagenow, array( 'comment.php', 'edit-comments.php', 'options-discussion.php' ), true ) ) {
@@ -135,7 +135,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Add custom CSS to dashboard.
 	 */
-	public function admin_css() {
+	public function admin_css(): void {
 		?>
 		<style>
 			#dashboard_right_now .comment-count,
@@ -152,14 +152,14 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Remove comments from dashboard.
 	 */
-	public function filter_dashboard() {
+	public function filter_dashboard(): void {
 		remove_meta_box( 'dashboard_recent_comments', 'dashboard', 'normal' );
 	}
 
 	/**
 	 * Disable recent comments widget.
 	 */
-	public function disable_rc_widget() {
+	public function disable_rc_widget(): void {
 		unregister_widget( 'WP_Widget_Recent_Comments' );
 		add_filter( 'show_recent_comments_widget_style', '__return_false' );
 	}
@@ -167,7 +167,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Filter feed query
 	 */
-	public function filter_query() {
+	public function filter_query(): void {
 		if ( is_comment_feed() ) {
 			wp_die( esc_html__( 'Comments are closed.' ), '', array( 'response' => 403 ) );
 		}
@@ -176,7 +176,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Remove comment links from admin bar.
 	 */
-	public function filter_admin_bar() {
+	public function filter_admin_bar(): void {
 		remove_action( 'admin_bar_menu', 'wp_admin_bar_comments_menu', 60 );
 
 		if ( is_multisite() ) {
@@ -187,7 +187,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Disable comments template on single posts.
 	 */
-	public function check_comment_template() {
+	public function check_comment_template(): void {
 		if ( is_singular() ) {
 			// Kill the comments' template.
 			add_filter( 'comments_template', '__return_empty_string', 20 );
@@ -201,14 +201,14 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Add hook to run custom script.
 	 */
-	public function filter_gutenberg() {
+	public function filter_gutenberg(): void {
 		add_action( 'admin_footer', array( $this, 'print_footer_scripts' ) );
 	}
 
 	/**
 	 * Unregister comments blocks and panels.
 	 */
-	public function print_footer_scripts() {
+	public function print_footer_scripts(): void {
 		?>
 		<script>
 			wp.domReady( () => {
@@ -221,7 +221,7 @@ class Comments implements InstanceInterface, HooksInterface {
 					wp.blocks.unregisterBlockType( blockType );
 				}
 
-				wp.data.dispatch( 'core/edit-post')?.removeEditorPanel( 'discussion-panel' ); // Discussion
+				wp.data.dispatch( 'core/editor')?.removeEditorPanel( 'discussion-panel' ); // Discussion
 			} );
 		</script>
 		<?php
@@ -234,16 +234,8 @@ class Comments implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function filter_rest_endpoints( $endpoints ) {
-		if ( isset( $endpoints['comments'] ) ) {
-			unset( $endpoints['comments'] );
-		}
-		if ( isset( $endpoints['/wp/v2/comments'] ) ) {
-			unset( $endpoints['/wp/v2/comments'] );
-		}
-		if ( isset( $endpoints['/wp/v2/comments/(?P<id>[\d]+)'] ) ) {
-			unset( $endpoints['/wp/v2/comments/(?P<id>[\d]+)'] );
-		}
+	public function filter_rest_endpoints( array $endpoints ): array {
+		unset( $endpoints['comments'], $endpoints['/wp/v2/comments'], $endpoints['/wp/v2/comments/(?P<id>[\d]+)'] );
 
 		return $endpoints;
 	}
@@ -255,7 +247,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function disable_xmlrc_comments( $methods ) {
+	public function disable_xmlrc_comments( array $methods ): array {
 		unset( $methods['wp.newComment'] );
 
 		return $methods;
@@ -264,23 +256,23 @@ class Comments implements InstanceInterface, HooksInterface {
 	/**
 	 * Remove comments from REST API
 	 *
-	 * @param array           $prepared_comment
-	 * @param WP_REST_Request $request
+	 * @param array            $prepared_comment
+	 * @param \WP_REST_Request $request
 	 *
-	 * @return WP_Error
+	 * @return \WP_Error
 	 */
-	public function disable_rest_api_comments( $prepared_comment, $request ) {
+	public function disable_rest_api_comments( array $prepared_comment, \WP_REST_Request $request ): \WP_Error {
 		return new \WP_Error( 'rest_comment_disabled', 'Commenting is disabled.', array( 'status' => 403 ) );
 	}
 
 	/**
 	 * Remove comment links from network admin bar.
 	 *
-	 * @param WP_Admin_Bar $wp_admin_bar
+	 * @param \WP_Admin_Bar $wp_admin_bar
 	 *
 	 * @return void
 	 */
-	public function remove_network_comment_links( $wp_admin_bar ) {
+	public function remove_network_comment_links( \WP_Admin_Bar $wp_admin_bar ): void {
 		if ( is_user_logged_in() ) {
 			foreach ( (array) $wp_admin_bar->user->blogs as $blog ) {
 				$wp_admin_bar->remove_menu( 'blog-' . $blog->userblog_id . '-c' );
@@ -295,7 +287,7 @@ class Comments implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function filter_wp_headers( $headers ) {
+	public function filter_wp_headers( array $headers ): array {
 		unset( $headers['X-Pingback'] );
 
 		return $headers;

package/lib/commands/create/creators/app/chisel-starter-theme/inc/WP/Components.php

@@ -3,80 +3,75 @@
 namespace Chisel\WP;
 
 use Timber\Timber;
-use Chisel\Helper\ImageHelpers;
-use Chisel\Helper\AcfHelpers;
-use Chisel\Helper\CacheHelpers;
+use Chisel\Helpers\ImageHelpers;
+use Chisel\Helpers\AcfHelpers;
+use Chisel\Helpers\CacheHelpers;
 
 /**
  * Use this class to get site components.
  *
  * @package Chisel
  */
-class Components {
+final class Components {
 
 	/**
 	 * The site nav menus.
 	 *
 	 * @var array
 	 */
-	private static $menus = array();
+	private static array $menus = array();
 
 	/**
 	 * The logo.
 	 *
-	 * @var array
+	 * @var string
 	 */
-	private static $logo = array();
+	private static string $logo = '';
 
 	/**
 	 * The sidebar widgets.
 	 *
 	 * @var array
 	 */
-	private static $sidebar = array();
+	private static array $sidebar = array();
 
 	/**
 	 * The footer sidebars.
 	 *
 	 * @var array
 	 */
-	private static $footer_sidebars = array();
+	private static array $footer_sidebars = array();
 
 	/**
 	 * The page / post title.
 	 *
 	 * @var array
 	 */
-	private static $the_title = array();
+	private static array $the_title = array();
 
 	/**
 	 * The svg icons.
 	 *
 	 * @var array
 	 */
-	private static $icons = array();
+	private static array $icons = array();
 
 	/**
 	 * Get the site nav menus.
 	 *
 	 * @return array
 	 */
-	public static function get_menus() {
-		if ( ! self::$menus ) {
-			foreach ( array_keys( get_registered_nav_menus() ) as $menu ) {
-				if ( strpos( $menu, 'chisel', 0 ) === false ) {
-					continue;
-				}
-
-				$menu_name = str_replace( 'chisel_', '', $menu );
-
-				if ( ! has_nav_menu( $menu ) ) {
-					$menus[$menu_name] = '';
+	public static function get_menus(): array {
+		if ( empty( self::$menus ) ) {
+			$nav_menus = get_registered_nav_menus();
 
+			foreach ( array_keys( $nav_menus ) as $menu ) {
+				if ( strpos( $menu, 'chisel', 0 ) === false ) {
 					continue;
 				}
 
-				$menus[$menu_name] = Timber::get_menu( $menu );
+				$menu_name         = str_replace( 'chisel_', '', $menu );
+				$menus[$menu_name] = has_nav_menu( $menu ) ? Timber::get_menu( $menu ) : '';
 			}
 		}
 
@@ -88,7 +83,7 @@ class Components {
 	 *
 	 * @return string
 	 */
-	public static function get_logo() {
+	public static function get_logo(): string {
 		if ( self::$logo ) {
 			return self::$logo;
 		}
@@ -107,27 +102,36 @@ class Components {
 	 *
 	 * @param string $sidebar_id The sidebar id.
 	 *
-	 * @return array
+	 * @return ?array
 	 */
-	public static function get_sidebar( $sidebar_id = false ) {
-		if ( self::$sidebar ) {
-			return self::$sidebar;
-		}
+	public static function get_sidebar( string $sidebar_id = '' ): ?array {
+		$sidebar_name = null;
 
 		if ( $sidebar_id ) {
-			self::$sidebar = Timber::get_widgets( 'chisel-sidebar-' . $sidebar_id );
-			return self::$sidebar;
+			$sidebar_name = 'chisel-sidebar-' . $sidebar_id;
+		} elseif ( is_singular( 'post' ) ) {
+			$sidebar_name = 'chisel-sidebar-blog';
+		} elseif ( function_exists( 'is_shop' ) && is_shop() ) {
+			$sidebar_name = 'chisel-sidebar-woocommerce';
 		}
 
-		if ( is_singular( 'post' ) ) {
-			self::$sidebar = Timber::get_widgets( 'chisel-sidebar-blog' );
+		if ( ! $sidebar_name ) {
+			return null;
 		}
 
-		if ( function_exists( 'is_shop' ) && is_shop() ) {
-			self::$sidebar = Timber::get_widgets( 'chisel-sidebar-woocommerce' );
+		if ( isset( self::$sidebar[ $sidebar_name ] ) ) {
+			return self::$sidebar[ $sidebar_name ];
 		}
 
-		return self::$sidebar;
+		$sidebar_content = Timber::get_widgets( $sidebar_name );
+
+		self::$sidebar[ $sidebar_name ] = array(
+			'id'      => $sidebar_id,
+			'name'    => $sidebar_name,
+			'content' => $sidebar_content,
+		);
+
+		return self::$sidebar[ $sidebar_name ];
 	}
 
 	/**
@@ -135,8 +139,8 @@ class Components {
 	 *
 	 * @return array
 	 */
-	public static function get_footer_sidebars() {
-		if ( self::$footer_sidebars ) {
+	public static function get_footer_sidebars(): array {
+		if ( ! empty( self::$footer_sidebars ) ) {
 			return self::$footer_sidebars;
 		}
 
@@ -154,20 +158,14 @@ class Components {
 			}
 		}
 
-		switch ( count( self::$footer_sidebars['columns'] ) ) {
-			case 4:
-				$column_class = 'o-layout__item--3-large';
-				break;
-			case 3:
-				$column_class = 'o-layout__item--4-large';
-				break;
-			case 2:
-				$column_class = 'o-layout__item--6-large';
-				break;
-			default:
-				$column_class = 'o-layout__item--12';
-				break;
-		}
+		$column_count = count( self::$footer_sidebars['columns'] );
+
+		$column_class = match ( $column_count ) {
+			4 => 'o-layout__item--3-large',
+			3 => 'o-layout__item--4-large',
+			2 => 'o-layout__item--6-large',
+			default => 'o-layout__item--12',
+		};
 
 		self::$footer_sidebars['column_class'] = $column_class;
 
@@ -175,17 +173,16 @@ class Components {
 	}
 
 	/**
-	 * Get the current page title.
+	 * Get the current page title data.
 	 *
 	 * @return array
 	 */
-	public static function get_the_title() {
-		if ( self::$the_title ) {
+	public static function get_the_title(): array {
+		if ( ! empty( self::$the_title ) ) {
 			return self::$the_title;
 		}
 
 		$classname   = 'c-title';
-		$the_title   = array();
 		$title_text  = '';
 		$title_class = '';
 
@@ -202,7 +199,7 @@ class Components {
 				}
 			}
 		} elseif ( is_home() ) {
-			$posts_page_id = absint( get_option( 'page_for_posts' ) );
+			$posts_page_id = (int) get_option( 'page_for_posts' );
 
 			if ( $posts_page_id ) {
 				$title_text = get_the_title( $posts_page_id );
@@ -230,7 +227,7 @@ class Components {
 			$title_text = __( '404 - Page not found', 'chisel' );
 		}
 
-		if ( $title_text ) {
+		if ( $title_text !== '' ) {
 			self::$the_title = array(
 				'text'  => esc_html( $title_text ),
 				'class' => $title_class ? esc_attr( $title_class ) : $classname,
@@ -245,12 +242,12 @@ class Components {
 	 *
 	 * @param array $args
 	 *
-	 * @return html
+	 * @return string
 	 */
-	public static function get_icon( $args ) {
+	public static function get_icon( array $args ): string {
 		$icon_slug = sanitize_title( $args['name'] );
+		$icon_key  = '';
 
-		$icon_key = '';
 		foreach ( $args as $key => $value ) {
 			if ( is_bool( $value ) ) {
 				$value = $value ? 'yes' : 'no';

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

@@ -5,14 +5,14 @@ namespace Chisel\WP;
 use Chisel\Interfaces\InstanceInterface;
 use Chisel\Interfaces\HooksInterface;
 use Chisel\Traits\Singleton;
-use Chisel\Factory\RegisterCustomPostType;
+use Chisel\Factories\RegisterCustomPostType;
 
 /**
  * Custom post types and taxonomies wrapper class.
  *
  * @package Chisel
  */
-class CustomPostTypes implements InstanceInterface, HooksInterface {
+final class CustomPostTypes implements InstanceInterface, HooksInterface {
 
 	use Singleton;
 
@@ -21,21 +21,21 @@ class CustomPostTypes implements InstanceInterface, HooksInterface {
 	 *
 	 * @var array
 	 */
-	private $post_types = array();
+	private array $post_types = array();
 
 	/**
 	 * Default post type supports.
 	 *
 	 * @var array
 	 */
-	private $default_post_type_supports = array();
+	private array $default_post_type_supports = array();
 
 	/**
 	 * Default post type rewrite args.
 	 *
 	 * @var array
 	 */
-	private $default_post_type_rewrite_args = array();
+	private array $default_post_type_rewrite_args = array();
 
 	/**
 	 * Class constructor.
@@ -50,9 +50,9 @@ class CustomPostTypes implements InstanceInterface, HooksInterface {
 	/**
 	 * Set properties.
 	 */
-	public function set_properties() {
-		$this->default_post_type_supports     = apply_filters( 'chisel_default_post_type_supports', array( 'title', 'page-attributes', 'revisions', 'author' ) );
-		$this->default_post_type_rewrite_args = apply_filters(
+	public function set_properties(): void {
+		$this->default_post_type_supports     = (array) apply_filters( 'chisel_default_post_type_supports', array( 'title', 'page-attributes', 'revisions', 'author' ) );
+		$this->default_post_type_rewrite_args = (array) apply_filters(
 			'chisel_default_post_type_rewrite_args',
 			array(
 				'slug'       => '',
@@ -69,20 +69,19 @@ class CustomPostTypes implements InstanceInterface, HooksInterface {
 	/**
 	 * Register action hooks.
 	 */
-	public function action_hooks() {
+	public function action_hooks(): void {
 		add_action( 'init', array( $this, 'register_post_types' ) );
 	}
 
 	/**
 	 * Register filter hooks.
 	 */
-	public function filter_hooks() {
-	}
+	public function filter_hooks(): void {}
 
 	/**
 	 * Register custom post types.
 	 */
-	public function register_post_types() {
+	public function register_post_types(): void {
 		$this->post_types = apply_filters( 'chisel_custom_post_types', $this->post_types );
 
 		if ( empty( $this->post_types ) ) {
@@ -103,14 +102,14 @@ class CustomPostTypes implements InstanceInterface, HooksInterface {
 	/**
 	 * Set custom post types.
 	 */
-	private function set_post_types() {
+	private function set_post_types(): void {
 		$this->post_types = array(
 			// phpcs:disable
 			// 'chisel-cpt' => array(
 			// 	'singular'      => __( 'Chisel CPT', 'chisel' ),
 			// 	'plural'        => __( 'Chisel CPTs', 'chisel' ),
 			// 	'supports'      => array( 'editor', 'thumbnail', 'excerpt' ),
-			// 	'menu-icon'     => 'location-alt',
+			// 	'menu_icon'     => 'dashicons-location-alt',
 			// 	'hierarchical'  => true,
 			// 	'public'        => true,
 			// 	'menu_position' => 20,