# convertkit/3.4.3/includes/blocks/class-convertkit-block-product.php

Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages, version 3.4.3. 461 lines.

- Page: https://pluginprobe.com/plugins/convertkit/3.4.3/code/includes/blocks/class-convertkit-block-product.php
- Raw: https://pluginprobe.com/plugins/convertkit/3.4.3/raw/includes/blocks/class-convertkit-block-product.php
- Modified: 2026-08-28T10:49:42+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/convertkit/3.4.3/code/includes/blocks/class-convertkit-block-product.php#L10-L20`.

```php
<?php
/**
 * ConvertKit Product Button Block class.
 *
 * @package ConvertKit
 * @author ConvertKit
 */

/**
 * ConvertKit Product Button Block for Gutenberg and Shortcode.
 *
 * @package ConvertKit
 * @author  ConvertKit
 */
class ConvertKit_Block_Product extends ConvertKit_Block {

	/**
	 * Constructor
	 *
	 * @since   1.9.8.5
	 */
	public function __construct() {

		// Register this as a shortcode in the ConvertKit Plugin.
		add_filter( 'convertkit_shortcodes', array( $this, 'register' ) );

		// Register this as a Gutenberg block in the ConvertKit Plugin.
		add_filter( 'convertkit_blocks', array( $this, 'register' ) );

		// Register this block's MCP abilities.
		add_filter( 'convertkit_abilities', array( $this, 'register_abilities' ) );

		// Enqueue scripts and styles for this Gutenberg Block in the editor and frontend views.
		add_action( 'convertkit_gutenberg_enqueue_scripts_editor_and_frontend', array( $this, 'enqueue_scripts' ) );
		add_action( 'convertkit_gutenberg_enqueue_styles_editor_and_frontend', array( $this, 'enqueue_styles' ) );

	}

	/**
	 * Enqueues scripts for this Gutenberg Block in the editor and frontend views.
	 *
	 * @since   1.9.8.5
	 */
	public function enqueue_scripts() {

		// Get URL for commerce.js from Products.
		$convertkit_products = new ConvertKit_Resource_Products();
		$commerce_js_url     = $convertkit_products->get_commerce_js_url();

		// Bail if the commerce.js URL could not be fetched, as this means there are no Products.
		if ( ! $commerce_js_url ) {
			return;
		}

		// Enqueue.
		wp_enqueue_script( 'convertkit-commerce', $commerce_js_url, array(), false, true ); // phpcs:ignore

	}

	/**
	 * Enqueues styles for this Gutenberg Block in the editor and frontend views.
	 *
	 * @since   1.9.8.5
	 */
	public function enqueue_styles() {

		convertkit_enqueue_frontend_css();

		// Enqueue the block button CSS.
		wp_enqueue_style( 'wp-block-button' );

	}

	/**
	 * Returns this block's programmatic name, excluding the convertkit- prefix.
	 *
	 * @since   1.9.8.5
	 */
	public function get_name() {

		/**
		 * This will register as:
		 * - a shortcode, with the name [convertkit_product].
		 * - a Gutenberg block, with the name convertkit/product.
		 */
		return 'product';

	}

	/**
	 * Returns this block's title.
	 *
	 * @since   3.1.1
	 */
	public function get_title() {

		return __( 'Kit Product', 'convertkit' );

	}

	/**
	 * Returns this block's plural title.
	 *
	 * @since   3.4.0
	 *
	 * @return  string
	 */
	public function get_title_plural() {

		return __( 'Kit Products', 'convertkit' );

	}

	/**
	 * Returns this block's icon.
	 *
	 * @since   3.1.1
	 */
	public function get_icon() {

		return 'resources/backend/images/block-icon-product.svg';

	}

	/**
	 * Returns this block's Title, Icon, Categories, Keywords and properties.
	 *
	 * @since   1.9.8.5
	 */
	public function get_overview() {

		$convertkit_products = new ConvertKit_Resource_Products( 'block_edit' );
		$settings            = new ConvertKit_Settings();

		return array(
			'title'                                => $this->get_title(),
			'description'                          => __( 'Displays a button to purchase a Kit product.', 'convertkit' ),
			'icon'                                 => $this->get_icon(),
			'category'                             => 'convertkit',
			'keywords'                             => array(
				__( 'ConvertKit', 'convertkit' ),
				__( 'Kit', 'convertkit' ),
				__( 'Product', 'convertkit' ),
			),

			// Function to call when rendering as a block or a shortcode on the frontend web site.
			'render_callback'                      => array( $this, 'render' ),

			// Shortcode: TinyMCE / QuickTags Modal Width and Height.
			'modal'                                => array(
				'width'  => 600,
				'height' => 518,
			),

			// Shortcode: Include a closing [/shortcode] tag when using TinyMCE or QuickTag Modals.
			'shortcode_include_closing_tag'        => false,

			// Gutenberg: Block Icon in Editor.
			'gutenberg_icon'                       => convertkit_get_file_contents( CONVERTKIT_PLUGIN_PATH . '/resources/backend/images/block-icon-product.svg' ),

			// Gutenberg: Example image showing how this block looks when choosing it in Gutenberg.
			'gutenberg_example_image'              => CONVERTKIT_PLUGIN_URL . 'resources/backend/images/block-example-product.png',

			// Help descriptions, displayed when no Access Token / resources exist and this block/shortcode is added.
			'no_access_token'                      => array(
				'notice'           => __( 'Not connected to Kit.', 'convertkit' ),
				'link'             => convertkit_get_setup_wizard_plugin_link(),
				'link_text'        => __( 'Click here to connect your Kit account.', 'convertkit' ),
				'instruction_text' => __( 'Connect your Kit account at Settings > Kit, and then refresh this page to select a product.', 'convertkit' ),
			),
			'no_resources'                         => array(
				'notice'           => __( 'No products exist in Kit.', 'convertkit' ),
				'link'             => convertkit_get_new_product_url(),
				'link_text'        => __( 'Click here to create your first product.', 'convertkit' ),
				'instruction_text' => __( 'Add a product to your Kit account, and then refresh this page to select a product.', 'convertkit' ),
			),

			// Gutenberg: Help description, displayed when the defined attribute has not been set for the block.
			'gutenberg_help_description'           => __( 'Select a Product using the Product option in the Gutenberg sidebar.', 'convertkit' ),
			'gutenberg_help_description_attribute' => 'product',

			// Whether an Access Token exists in the Plugin, and are the required resources (products) available.
			// If no Access Token is specified in the Plugin's settings, render the "Not Connected" output.
			'has_access_token'                     => $settings->has_access_and_refresh_token(),
			'has_resources'                        => $convertkit_products->exist(),
		);

	}

	/**
	 * Returns this block's Attributes
	 *
	 * @since   1.9.8.5
	 */
	public function get_attributes() {

		return array(
			// Block attributes.
			'product'                 => array(
				'type'    => 'string',
				'default' => $this->get_default_value( 'product' ),
			),
			'text'                    => array(
				'type'    => 'string',
				'default' => $this->get_default_value( 'text' ),
			),
			'discount_code'           => array(
				'type'    => 'string',
				'default' => $this->get_default_value( 'discount_code' ),
			),
			'checkout'                => array(
				'type'    => 'boolean',
				'default' => $this->get_default_value( 'checkout' ),
			),
			'disable_modal_on_mobile' => array(
				'type'    => 'boolean',
				'default' => $this->get_default_value( 'disable_modal_on_mobile' ),
			),

			// The below are built in Gutenberg attributes registered in get_supports().

			// get_supports() style, color and typography attributes.
			'style'                   => array(
				'type' => 'object',
			),
			'backgroundColor'         => array(
				'type' => 'string',
			),
			'textColor'               => array(
				'type' => 'string',
			),
			'fontSize'                => array(
				'type' => 'string',
			),

			// Always required for Gutenberg.
			'is_gutenberg_example'    => array(
				'type'    => 'boolean',
				'default' => false,
			),
		);

	}

	/**
	 * Returns this block's supported built-in Attributes.
	 *
	 * @since   1.9.8.5
	 *
	 * @return  array   Supports
	 */
	public function get_supports() {

		return array(
			'className'  => true,
			'color'      => array(
				'background'                      => true,
				'text'                            => true,

				// Don't apply styles to the block editor's div element.
				// This ensures what's rendered in the Gutenberg editor matches the frontend output for styling.
				// See: https://github.com/WordPress/gutenberg/issues/32417.
				'__experimentalSkipSerialization' => true,
			),
			'typography' => array(
				'fontSize'   => true,
				'lineHeight' => true,
			),
			'spacing'    => array(
				'margin'  => true,
				'padding' => true,
			),
		);

	}

	/**
	 * Returns this block's Fields
	 *
	 * @since   1.9.8.5
	 *
	 * @return  bool|array
	 */
	public function get_fields() {

		// Get ConvertKit Products.
		$products            = array();
		$convertkit_products = new ConvertKit_Resource_Products();
		if ( $convertkit_products->exist() ) {
			foreach ( $convertkit_products->get() as $product ) {
				$products[ absint( $product['id'] ) ] = sanitize_text_field( $product['name'] );
			}
		}

		// Gutenberg's built-in fields (such as styling, padding etc) don't need to be defined here, as they'll be included
		// automatically by Gutenberg.
		return array(
			'product'                 => array(
				'label'    => __( 'Product', 'convertkit' ),
				'type'     => 'resource',
				'resource' => 'products',
				'values'   => $products,
			),
			'text'                    => array(
				'label'       => __( 'Button Text', 'convertkit' ),
				'type'        => 'text',
				'description' => __( 'The text to display for the button.', 'convertkit' ),
			),
			'discount_code'           => array(
				'label'       => __( 'Discount Code', 'convertkit' ),
				'type'        => 'text',
				'description' => __( 'Optional: A discount code to include. Must be defined in the Kit Product.', 'convertkit' ),
			),
			'checkout'                => array(
				'label'       => __( 'Load checkout step', 'convertkit' ),
				'type'        => 'toggle',
				'description' => __( 'If enabled, immediately loads the checkout screen, instead of the Kit Product description.', 'convertkit' ),
			),
			'disable_modal_on_mobile' => array(
				'label'       => __( 'Disable modal on mobile', 'convertkit' ),
				'type'        => 'toggle',
				'description' => __( 'Recommended if the Kit Product is a digital download being purchased on mobile, to ensure the subscriber can immediately download the PDF once purchased.', 'convertkit' ),
			),

			// These fields will only display on the shortcode, and are deliberately not registered in get_attributes(),
			// because Gutenberg will register its own color pickers for link, background and text.
			'background_color'        => array(
				'label' => __( 'Background color', 'convertkit' ),
				'type'  => 'color',
			),
			'text_color'              => array(
				'label' => __( 'Text color', 'convertkit' ),
				'type'  => 'color',
			),
		);

	}

	/**
	 * Returns this block's UI panels / sections.
	 *
	 * @since   1.9.8.5
	 *
	 * @return  bool|array
	 */
	public function get_panels() {

		// Gutenberg's built-in fields (such as styling, padding etc) don't need to be defined here, as they'll be included
		// automatically by Gutenberg.
		return array(
			'general' => array(
				'label'  => __( 'General', 'convertkit' ),
				'fields' => array(
					'product',
					'text',
					'discount_code',
					'checkout',
					'disable_modal_on_mobile',
					'background_color',
					'text_color',
				),
			),
		);

	}

	/**
	 * Returns this block's Default Values
	 *
	 * @since   1.9.8.5
	 *
	 * @return  array
	 */
	public function get_default_values() {

		return array(
			'product'                 => '',
			'text'                    => __( 'Buy my product', 'convertkit' ),
			'discount_code'           => '',
			'checkout'                => false,
			'disable_modal_on_mobile' => false,
			'background_color'        => '',
			'text_color'              => '',

			// Built-in Gutenberg block attributes.
			'backgroundColor'         => '',
			'textColor'               => '',
			'fontSize'                => '',
			'style'                   => array(
				'visualizers' => array(
					'padding' => array(
						'top'    => '',
						'bottom' => '',
						'left'   => '',
						'right'  => '',
					),
				),
			),
		);

	}

	/**
	 * Returns the block's output, based on the supplied configuration attributes.
	 *
	 * @since   1.9.8.5
	 *
	 * @param   array $atts                 Block / Shortcode / Page Builder Module Attributes.
	 * @return  string
	 */
	public function render( $atts ) {

		// Parse attributes, defining fallback defaults if required
		// and moving some attributes (such as Gutenberg's styles), if defined.
		$atts = $this->sanitize_and_declare_atts( $atts );

		// Setup Settings class.
		$settings = new ConvertKit_Settings();

		// Get Products Resource.
		$convertkit_products = new ConvertKit_Resource_Products();

		// Build HTML.
		$html = $convertkit_products->get_html(
			$atts['product'],
			$atts['text'],
			array(
				'discount_code'  => $atts['discount_code'],
				'checkout'       => $atts['checkout'],
				'disable_modal'  => ( $atts['disable_modal_on_mobile'] && wp_is_mobile() ),
				'css_classes'    => $this->get_css_classes( array( 'wp-block-button__link', 'wp-element-button' ) ),
				'css_styles'     => $this->get_css_styles( $atts ),
				'return_as_span' => $this->is_block_editor_request(),
			)
		);

		// Bail if an error occurred.
		if ( is_wp_error( $html ) ) {
			if ( $settings->debug_enabled() ) {
				return '<!-- ' . $html->get_error_message() . ' -->';
			}

			return '';
		}

		/**
		 * Filter the block's content immediately before it is output.
		 *
		 * @since   1.9.8.5
		 *
		 * @param   string  $html   ConvertKit Product button HTML.
		 * @param   array   $atts   Block Attributes.
		 */
		$html = apply_filters( 'convertkit_block_product_render', $html, $atts );

		return $html;

	}

}

```