Files
2026-07-02 15:54:39 -06:00

321 lines
9.5 KiB
PHP

<?php
// If Gravity Forms Block Manager is not available, do not run.
if ( ! class_exists( 'GF_Blocks' ) || ! defined( 'ABSPATH' ) ) {
exit;
}
class GF_Block_Form extends GF_Block {
/**
* Contains an instance of this block, if available.
*
* @since 2.4.10
* @var GF_Block $_instance If available, contains an instance of this block.
*/
private static $_instance = null;
/**
* Block type.
*
* @since 2.4.10
* @var string
*/
public $type = 'gravityforms/form';
/**
* Handle of primary block script.
*
* @since 2.4.10
* @var string
*/
public $script_handle = 'gform_editor_block_form';
/**
* Handle of primary block style.
*
* @since 2.5.6
* @var string
*/
public $style_handle = 'gform_editor_block_form';
public function __construct() {
$this->assign_attributes();
}
/**
* Register block type and add filters specific to the form block.
*
* @since 2.10.5
*
* @return void
*/
public function init() {
parent::init();
// Move WordPress's custom CSS classes from the <script> to the <div class="gform_wrapper">, so that the form is styled correctly.
add_filter( 'render_block_gravityforms/form', array( $this, 'fix_custom_css_class_placement' ), 10, 2 );
}
private function assign_attributes() {
$default_attributes = GFForms::get_service_container()->get( \Gravity_Forms\Gravity_Forms\Blocks\GF_Blocks_Service_Provider::FORM_BLOCK_ATTRIBUTES );
$attributes = apply_filters( 'gform_form_block_attributes', $default_attributes );
array_walk( $attributes, function ( &$value ) {
$value = array( 'type' => $value['type'] );
} );
$this->attributes = $attributes;
}
/**
* Get instance of this class.
*
* @since 2.4.10
*
* @return GF_Block_Form
*/
public static function get_instance() {
if ( null === self::$_instance ) {
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Move the WordPress "Custom CSS" block-support classes from a leading <script> to the gform_wrapper <div>.
*
* The block "Custom CSS" setting introduced in WP 7.0 adds custom CSS classes to the first HTML element in a block,
* which might be the <script> tag added by GFForms::maybe_prepend_hooks_js_script() instead of the <div class="gform_wrapper">.
* This filter corrects that.
*
* @since 2.10.5
*
* @param string $block_content The rendered block HTML.
* @param array $block The parsed block data.
*
* @return string The (possibly corrected) block HTML.
*/
public function fix_custom_css_class_placement( $block_content, $block ) {
if ( ! class_exists( 'WP_HTML_Tag_Processor' ) ) {
return $block_content;
}
$tags = new WP_HTML_Tag_Processor( $block_content );
// Advance to the first tag. If the content is empty or has no tags, bail.
if ( ! $tags->next_tag() ) {
return $block_content;
}
// Only act when the first element is a <script> — i.e. the hooks JS was prepended.
if ( 'SCRIPT' !== $tags->get_tag() ) {
return $block_content;
}
// Only act when WordPress has placed the custom-CSS marker classes on this <script>.
$class_attr = $tags->get_attribute( 'class' );
if ( ! $class_attr || false === strpos( $class_attr, 'has-custom-css' ) ) {
return $block_content;
}
// Extract the unique `wp-custom-css-*` class generated for this block instance.
$custom_css_class = null;
foreach ( preg_split( '/\s+/', $class_attr ) as $class ) {
if ( 0 === strpos( $class, 'wp-custom-css-' ) ) {
$custom_css_class = $class;
break;
}
}
// Remove the custom-CSS classes from the <script> tag.
$tags->remove_class( 'has-custom-css' );
if ( $custom_css_class ) {
$tags->remove_class( $custom_css_class );
}
// Find the form wrapper <div> and add the classes to it instead.
// next_tag() searches forward from the current cursor position.
if ( $tags->next_tag( array( 'class_name' => 'gform_wrapper' ) ) ) {
$tags->add_class( 'has-custom-css' );
if ( $custom_css_class ) {
$tags->add_class( $custom_css_class );
}
}
return $tags->get_updated_html();
}
// # SCRIPT / STYLES -----------------------------------------------------------------------------------------------
public function register_block_assets() {
parent::register_block_assets();
if ( function_exists( 'wp_enqueue_block_style' ) && is_admin() ) {
wp_enqueue_block_style( $this->type, array( 'handle' => 'gravity_forms_theme_reset' ) );
wp_enqueue_block_style( $this->type, array( 'handle' => 'gravity_forms_theme_foundation' ) );
wp_enqueue_block_style( $this->type, array( 'handle' => 'gravity_forms_theme_framework' ) );
wp_enqueue_block_style( $this->type, array( 'handle' => 'gravity_forms_orbital_theme' ) );
}
}
/**
* Register scripts for block.
*
* @since 2.4.10
*
* @return array
*/
public function scripts() {
return array();
}
/**
* Localize Form block script.
*
* @since 2.4.10
*
* @param array $script Script arguments.
*/
public function localize_script( $script = array() ) {
wp_localize_script(
$script['handle'],
'gform_block_form',
array(
'adminURL' => admin_url( 'admin.php' ),
'forms' => $this->get_forms(),
'preview' => GFCommon::get_base_url() . '/images/gf_block_preview.svg',
)
);
if ( function_exists( 'wp_set_script_translations' ) ) {
wp_set_script_translations( $script['handle'], 'gravityforms', GFCommon::get_base_path() . '/languages' );
}
}
/**
* Register styles for block.
*
* @since 2.4.10
*
* @return array
*/
public function styles() {
// Prepare styling dependencies.
$deps = array( 'wp-edit-blocks' );
// Add Gravity Forms styling if CSS is enabled.
if ( ! GFCommon::is_frontend_default_css_disabled() ) {
$deps = array_merge( $deps, array( 'gforms_reset_css', 'gform_basic', 'gforms_formsmain_css', 'gforms_ready_class_css', 'gforms_browsers_css', 'gform_theme' ) );
/**
* Allows users to disable the main theme.css file from being loaded on the Front End.
*
* @since 2.5-beta-3
*
* @param boolean Whether to disable the theme css.
*/
$disable_theme_css = apply_filters( 'gform_disable_form_theme_css', false );
if ( ! $disable_theme_css ) {
$deps[] = 'gform_theme';
}
}
$dev_min = defined( 'GF_SCRIPT_DEBUG' ) && GF_SCRIPT_DEBUG ? '' : '.min';
return array(
array(
'handle' => $this->style_handle,
'src' => GFCommon::get_base_url() . "/assets/css/dist/blocks{$dev_min}.css",
'deps' => $deps,
'version' => defined( 'GF_SCRIPT_DEBUG' ) && GF_SCRIPT_DEBUG ? filemtime( GFCommon::get_base_path() . "/assets/css/dist/blocks{$dev_min}.css" ) : GFForms::$version,
),
);
}
// # BLOCK RENDER -------------------------------------------------------------------------------------------------
/**
* Display block contents on frontend.
*
* @since 2.4.10
*
* @param array $attributes Block attributes.
*
* @return string
*/
public function render_block( $attributes = array() ) {
GFForms::get_service_container()->get( 'block_attributes' )->store( $attributes );
// Prepare variables.
$form_id = rgar( $attributes, 'formId' ) ? $attributes['formId'] : false;
$title = isset( $attributes['title'] ) ? $attributes['title'] : true;
$description = isset( $attributes['description'] ) ? $attributes['description'] : true;
$ajax = isset( $attributes['ajax'] ) ? $attributes['ajax'] : false;
$tabindex = isset( $attributes['tabindex'] ) ? intval( $attributes['tabindex'] ) : 0;
$field_values = isset( $attributes['fieldValues'] ) ? $attributes['fieldValues'] : '';
// If form ID was not provided or form does not exist, return.
if ( ! $form_id || ( $form_id && ! GFAPI::get_form( $form_id ) ) ) {
return '';
}
// Use Gravity Forms function for REST API requests.
if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
// Start output buffering.
ob_start();
// Prepare field values.
if ( ! empty( $field_values ) ) {
$field_values = str_replace( '&#038;', '&', $field_values );
parse_str( $field_values, $field_value_array );
$field_values = stripslashes_deep( $field_value_array );
}
// Get form output string.
$form_string = gravity_form( $form_id, $title, $description, false, $field_values, $ajax, $tabindex, false, rgar( $attributes, 'theme' ), json_encode( $attributes ) );
// Get output buffer contents.
$buffer_contents = ob_get_contents();
ob_end_clean();
// Return buffer contents with form string.
return $buffer_contents . $form_string; // nosemgrep audit.php.wp.security.xss.block-attr
}
// Encode field values.
$field_values = htmlspecialchars_decode( $field_values );
$field_values = str_replace( array( '&#038;', '&#091;', '&#093;' ), array( '&', '[', ']' ), $field_values );
parse_str( $field_values, $field_value_array ); //parsing query string like string for field values and placing them into an associative array
$field_values = stripslashes_deep( $field_value_array );
// If no field values are set, set field values to an empty string
if ( empty( $field_values ) ) {
$field_values = '';
}
return gravity_form( $form_id, $title, $description, false, $field_values, $ajax, $tabindex, false, rgar( $attributes, 'theme' ), json_encode( $attributes ) ); // nosemgrep audit.php.wp.security.xss.block-attr
}
}
// Register block.
if ( true !== ( $registered = GF_Blocks::register( GF_Block_Form::get_instance() ) ) && is_wp_error( $registered ) ) {
// Log that block could not be registered.
GFCommon::log_error( 'Unable to register block; ' . $registered->get_error_message() );
}