# convertkit/3.4.5/includes/block-formatters/class-convertkit-block-formatter-form-link.php

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

- Page: https://pluginprobe.com/plugins/convertkit/3.4.5/code/includes/block-formatters/class-convertkit-block-formatter-form-link.php
- Raw: https://pluginprobe.com/plugins/convertkit/3.4.5/raw/includes/block-formatters/class-convertkit-block-formatter-form-link.php
- Modified: 2024-10-01T15:23:02+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.5/code/includes/block-formatters/class-convertkit-block-formatter-form-link.php#L10-L20`.

```php
<?php
/**
 * ConvertKit Form Link Block Formatter class.
 *
 * @package ConvertKit
 * @author ConvertKit
 */

/**
 * ConvertKit Form Link Block Formatter class.
 *
 * @package ConvertKit
 * @author  ConvertKit
 */
class ConvertKit_Block_Formatter_Form_Link extends ConvertKit_Block_Formatter {

	/**
	 * Holds the ConvertKit Forms resource class.
	 *
	 * @since   2.2.0
	 *
	 * @var     bool|ConvertKit_Resource_Forms
	 */
	public $forms = false;

	/**
	 * Holds the Post's content.
	 *
	 * @since   2.2.0
	 *
	 * @var     string
	 */
	public $content = '';

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

		// Register this as a Gutenberg block formatter in the ConvertKit Plugin,
		// if non-inline forms exist on ConvertKit.
		$this->forms = new ConvertKit_Resource_Forms( 'block_formatter_register' );
		if ( $this->forms->non_inline_exist() ) {
			add_filter( 'convertkit_get_block_formatters', array( $this, 'register' ) );
		}

		// Enqueue JS in footer if links exist in the content that have the formatter applied.
		add_filter( 'the_content', array( $this, 'maybe_enqueue_scripts' ) );

	}

	/**
	 * Returns this formatter's programmatic name, excluding the convertkit- prefix.
	 *
	 * @since   2.2.0
	 *
	 * @return  string
	 */
	public function get_name() {

		return 'form-link';

	}

	/**
	 * Returns this formatters's Title, Description and Icon
	 *
	 * @since   2.2.0
	 *
	 * @return  array
	 */
	public function get_overview() {

		return array(
			'title'          => __( 'Kit Form Trigger', 'convertkit' ),
			'description'    => __( 'Displays a modal, sticky bar or slide in form to display when the link is pressed.', 'convertkit' ),
			'icon'           => 'resources/backend/images/block-icon-formtrigger.svg',

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

	}

	/**
	 * Returns this formatter's attributes, which are applied
	 * to the tag.
	 *
	 * @since   2.2.0
	 *
	 * @return  array
	 */
	public function get_attributes() {

		return array(
			'data-id'             => '',
			'data-formkit-toggle' => '',
			'href'                => '',
		);

	}

	/**
	 * Returns this formatter's fields to display when the formatter
	 * button is clicked in the toolbar.
	 *
	 * @since   2.2.0
	 *
	 * @return  bool|array
	 */
	public function get_fields() {

		// Bail if the request is not for the WordPress Administration or frontend editor.
		if ( ! WP_ConvertKit()->is_admin_or_frontend_editor() ) {
			return false;
		}

		// Get non-inline ConvertKit Forms.
		$forms      = array();
		$forms_data = array();
		if ( $this->forms->exist() ) {
			foreach ( $this->forms->get_non_inline() as $form ) {
				// Add this form's necessary to the attribute arrays.
				// Legacy forms don't include a `format` key, so define them as inline.
				$forms[ absint( $form['id'] ) ]      = sprintf(
					'%s [%s]',
					sanitize_text_field( $form['name'] ),
					( ! empty( $form['format'] ) ? sanitize_text_field( $form['format'] ) : 'inline' )
				);
				$forms_data[ absint( $form['id'] ) ] = array(
					'data-id'             => sanitize_text_field( $form['id'] ),
					'data-formkit-toggle' => sanitize_text_field( $form['uid'] ),
					'href'                => $form['embed_url'],
				);
			}
		}

		// Return field.
		return array(
			'data-id' => array(
				'label'       => __( 'Form', 'convertkit' ),
				'type'        => 'select',
				'description' => __( 'The modal, sticky bar or slide in form to display when the text is clicked.', 'convertkit' ),

				// Key/value pairs for the <select> dropdown.
				'values'      => $forms,

				// Contains all additional data required to build the link.
				'data'        => $forms_data,
			),
		);

	}

	/**
	 * Filters the Post / Page's content, enqueuring a form's ConvertKit script where
	 * modal, sticky bar or slide in form links have been added by this block formatter
	 * in Gutenberg.
	 *
	 * @since   2.2.0
	 *
	 * @param   string $content    Page/Post Content.
	 * @return  string              Page/Post Content
	 */
	public function maybe_enqueue_scripts( $content ) {

		// Store content in class.
		$this->content = $content;

		// Return content, unedited, if no form links exist in the content.
		if ( strpos( $content, 'data-formkit-toggle' ) === false ) {
			return $content;
		}

		// Return content, unedited, if no Forms exist.
		if ( ! $this->forms->exist() ) {
			return $content;
		}

		// Enqueue scripts.
		$content = preg_replace_callback(
			'#<' . $this->get_tag() . ' data-id="([^"]*)" data-formkit-toggle="([^"]*)".*?href="([^"]*)".*?>([^>]*)</' . $this->get_tag() . '>#i',
			array( $this, 'enqueue_scripts' ),
			$content
		);

		// Return.
		return $content;

	}

	/**
	 * Callback function to enqueue a script to a matching link.
	 *
	 * @since   2.2.0
	 *
	 * @param   array $preg_match  preg_replace_callback() match.
	 * @return  string              Link with script appended
	 */
	public function enqueue_scripts( $preg_match ) {

		// Get Form by its ID.
		$form = $this->forms->get_by_id( absint( $preg_match[1] ) );

		// Just return the original element, unedited, if the Form could not be found.
		if ( ! $form ) {
			return $preg_match[0];
		}

		// Return the original link, unedited, if the Form doesn't have a UID or JS embed.
		// This prevents issues with legacy modal forms.
		if ( ! array_key_exists( 'uid', $form ) ) {
			return $preg_match[0];
		}
		if ( ! array_key_exists( 'embed_js', $form ) ) {
			return $preg_match[0];
		}

		// Register the script, so it's only loaded once for this non-inline form across the entire page.
		add_filter(
			'convertkit_output_scripts_footer',
			function ( $scripts ) use ( $form ) {

				$scripts[] = array(
					'async'    => true,
					'data-uid' => $form['uid'],
					'src'      => $form['embed_js'],
				);

				return $scripts;

			}
		);

		// Return original link.
		return $preg_match[0];

	}

}

```