gutenberg-hooks.php
| 1 | <?php |
| 2 | /** |
| 3 | * Gutenberg Hooks Manager Class. |
| 4 | * |
| 5 | * @package sureforms. |
| 6 | */ |
| 7 | |
| 8 | namespace SRFM\Inc; |
| 9 | |
| 10 | use SRFM\Inc\Traits\Get_Instance; |
| 11 | |
| 12 | if ( ! defined( 'ABSPATH' ) ) { |
| 13 | exit; // Exit if accessed directly. |
| 14 | } |
| 15 | |
| 16 | /** |
| 17 | * Gutenberg hooks handler class. |
| 18 | * |
| 19 | * @since 0.0.1 |
| 20 | */ |
| 21 | class Gutenberg_Hooks { |
| 22 | use Get_Instance; |
| 23 | /** |
| 24 | * Block patterns to register. |
| 25 | * |
| 26 | * @var array<mixed> |
| 27 | */ |
| 28 | protected $patterns = []; |
| 29 | |
| 30 | /** |
| 31 | * Class constructor. |
| 32 | * |
| 33 | * @return void |
| 34 | * @since 0.0.1 |
| 35 | */ |
| 36 | public function __construct() { |
| 37 | // Setting Form default patterns. |
| 38 | $this->patterns = [ |
| 39 | 'blank-form', |
| 40 | 'contact-form', |
| 41 | 'newsletter-form', |
| 42 | 'support-form', |
| 43 | 'feedback-form', |
| 44 | 'event-rsvp-form', |
| 45 | 'subscription-form', |
| 46 | ]; |
| 47 | |
| 48 | // Initializing hooks. |
| 49 | add_action( 'enqueue_block_editor_assets', [ $this, 'form_editor_screen_assets' ] ); |
| 50 | add_action( 'enqueue_block_editor_assets', [ $this, 'block_editor_assets' ] ); |
| 51 | add_filter( 'block_categories_all', [ $this, 'register_block_categories' ], 10, 1 ); |
| 52 | add_action( 'init', [ $this, 'register_block_patterns' ], 9 ); |
| 53 | add_filter( 'allowed_block_types_all', [ $this, 'disable_forms_wrapper_block' ], 10, 2 ); |
| 54 | add_action( 'save_post_sureforms_form', [ $this, 'update_field_slug' ], 10, 2 ); |
| 55 | add_action( 'load-post.php', [ $this, 'maybe_migrate_form_stylings' ] ); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Disable Sureforms_Form Block and allowed only sureforms block inside Sureform CPT editor. |
| 60 | * |
| 61 | * @param bool|array<string> $allowed_block_types Array of block types. |
| 62 | * @param \WP_Block_Editor_Context $editor_context The current block editor context. |
| 63 | * @return array<mixed>|bool |
| 64 | * @since 0.0.1 |
| 65 | */ |
| 66 | public function disable_forms_wrapper_block( $allowed_block_types, $editor_context ) { |
| 67 | if ( ! empty( $editor_context->post->post_type ) && 'sureforms_form' === $editor_context->post->post_type ) { |
| 68 | $allow_block_types = [ |
| 69 | 'srfm/input', |
| 70 | 'srfm/email', |
| 71 | 'srfm/textarea', |
| 72 | 'srfm/number', |
| 73 | 'srfm/checkbox', |
| 74 | 'srfm/gdpr', |
| 75 | 'srfm/phone', |
| 76 | 'srfm/address', |
| 77 | 'srfm/dropdown', |
| 78 | 'srfm/multi-choice', |
| 79 | 'srfm/url', |
| 80 | 'srfm/separator', |
| 81 | 'srfm/icon', |
| 82 | 'srfm/image', |
| 83 | 'srfm/advanced-heading', |
| 84 | 'srfm/inline-button', |
| 85 | ]; |
| 86 | // Apply a filter to the $allow_block_types types array. |
| 87 | return apply_filters( 'srfm_allowed_block_types', $allow_block_types, $editor_context ); |
| 88 | } |
| 89 | |
| 90 | // Return the default $allowed_block_types value. |
| 91 | return $allowed_block_types; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Register our custom block category. |
| 96 | * |
| 97 | * @param array<mixed> $categories Array of categories. |
| 98 | * @return array<mixed> |
| 99 | * @since 0.0.1 |
| 100 | */ |
| 101 | public function register_block_categories( $categories ) { |
| 102 | $screen = get_current_screen(); |
| 103 | |
| 104 | if ( $screen && SRFM_FORMS_POST_TYPE === $screen->post_type ) { |
| 105 | $title = esc_html__( 'General Fields', 'sureforms' ); |
| 106 | } else { |
| 107 | $title = esc_html__( 'SureForms', 'sureforms' ); |
| 108 | } |
| 109 | |
| 110 | $custom_categories = [ |
| 111 | [ |
| 112 | 'slug' => 'sureforms', |
| 113 | 'title' => $title, |
| 114 | ], |
| 115 | [ |
| 116 | 'slug' => 'sureforms-pro', |
| 117 | 'title' => esc_html__( 'Advanced Fields', 'sureforms' ), |
| 118 | ], |
| 119 | ]; |
| 120 | |
| 121 | return array_merge( $custom_categories, $categories ); |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Register our block patterns. |
| 126 | * |
| 127 | * @return void |
| 128 | * @since 0.0.1 |
| 129 | */ |
| 130 | public function register_block_patterns() { |
| 131 | // Apply filters to the patterns. |
| 132 | $this->patterns = apply_filters( 'srfm_block_patterns', $this->patterns ); |
| 133 | |
| 134 | // Iterate over each block pattern. |
| 135 | foreach ( $this->patterns as $block_pattern ) { |
| 136 | // Attempt to register block pattern from the main directory. |
| 137 | if ( ! $this->register_block_pattern_from_directory( $block_pattern, plugin_dir_path( SRFM_FILE ) . 'templates/forms/' ) ) { |
| 138 | // If unsuccessful, attempt to register block pattern from the pro directory. |
| 139 | if ( Helper::has_pro() ) { |
| 140 | $this->register_block_pattern_from_directory( $block_pattern, SRFM_PRO_DIR . 'templates/forms/' ); |
| 141 | } |
| 142 | } |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Add Form Editor Scripts. |
| 148 | * |
| 149 | * @return void |
| 150 | * @since 0.0.1 |
| 151 | */ |
| 152 | public function form_editor_screen_assets() { |
| 153 | $form_editor_script = '-formEditor'; |
| 154 | |
| 155 | $screen = get_current_screen(); |
| 156 | $post_types = [ SRFM_FORMS_POST_TYPE ]; |
| 157 | |
| 158 | if ( is_null( $screen ) || ! in_array( $screen->post_type, $post_types, true ) ) { |
| 159 | return; |
| 160 | } |
| 161 | |
| 162 | $script_asset_path = SRFM_DIR . 'assets/build/formEditor.asset.php'; |
| 163 | $script_info = file_exists( $script_asset_path ) |
| 164 | ? include $script_asset_path |
| 165 | : [ |
| 166 | 'dependencies' => [], |
| 167 | 'version' => SRFM_VER, |
| 168 | ]; |
| 169 | |
| 170 | wp_enqueue_script( SRFM_SLUG . $form_editor_script, SRFM_URL . 'assets/build/formEditor.js', $script_info['dependencies'], $script_info['version'], true ); |
| 171 | wp_localize_script( SRFM_SLUG . $form_editor_script, 'scIcons', [ 'path' => SRFM_URL . 'assets/build/icon-assets' ] ); |
| 172 | |
| 173 | // Enqueue the code editor for the Custom CSS Editor in SureForms. |
| 174 | wp_enqueue_code_editor( [ 'type' => 'text/css' ] ); |
| 175 | wp_enqueue_script( 'wp-theme-plugin-editor' ); |
| 176 | wp_enqueue_style( 'wp-codemirror' ); |
| 177 | |
| 178 | wp_localize_script( |
| 179 | SRFM_SLUG . $form_editor_script, |
| 180 | SRFM_SLUG . '_block_data', |
| 181 | [ |
| 182 | 'plugin_url' => SRFM_URL, |
| 183 | 'admin_email' => get_option( 'admin_email' ), |
| 184 | 'pro_plugin_name' => defined( 'SRFM_PRO_VER' ) && defined( 'SRFM_PRO_PRODUCT' ) ? SRFM_PRO_PRODUCT : 'free', |
| 185 | ] |
| 186 | ); |
| 187 | |
| 188 | Helper::register_script_translations( SRFM_SLUG . $form_editor_script ); |
| 189 | } |
| 190 | |
| 191 | /** |
| 192 | * Register all editor scripts. |
| 193 | * |
| 194 | * @return void |
| 195 | * @since 0.0.1 |
| 196 | */ |
| 197 | public function block_editor_assets() { |
| 198 | $all_screen_blocks = '-blocks'; |
| 199 | $screen = get_current_screen(); |
| 200 | |
| 201 | $blocks_asset_path = SRFM_DIR . 'assets/build/blocks.asset.php'; |
| 202 | $blocks_info = file_exists( $blocks_asset_path ) |
| 203 | ? include $blocks_asset_path |
| 204 | : [ |
| 205 | 'dependencies' => [], |
| 206 | 'version' => SRFM_VER, |
| 207 | ]; |
| 208 | wp_enqueue_script( SRFM_SLUG . $all_screen_blocks, SRFM_URL . 'assets/build/blocks.js', $blocks_info['dependencies'], SRFM_VER, true ); |
| 209 | |
| 210 | Helper::register_script_translations( SRFM_SLUG . $all_screen_blocks ); |
| 211 | |
| 212 | $site_url = Helper::get_string_value( wp_parse_url( esc_url( get_site_url() ), PHP_URL_HOST ) ); |
| 213 | $site_url = preg_replace( '/^www\./', '', $site_url ); |
| 214 | |
| 215 | wp_localize_script( |
| 216 | SRFM_SLUG . $all_screen_blocks, |
| 217 | SRFM_SLUG . '_block_data', |
| 218 | [ |
| 219 | 'template_picker_url' => admin_url( '/admin.php?page=add-new-form' ), |
| 220 | 'plugin_url' => SRFM_URL, |
| 221 | 'admin_email' => get_option( 'admin_email' ), |
| 222 | 'post_url' => admin_url( 'post.php' ), |
| 223 | 'current_screen' => $screen, |
| 224 | 'smart_tags_array' => Smart_Tags::smart_tag_list(), |
| 225 | 'smart_tags_array_email' => Smart_Tags::email_smart_tag_list(), |
| 226 | 'srfm_form_markup_nonce' => wp_create_nonce( 'srfm_form_markup' ), |
| 227 | 'get_form_markup_url' => 'sureforms/v1/generate-form-markup', |
| 228 | 'is_pro_active' => Helper::has_pro(), |
| 229 | 'srfm_default_dynamic_block_option' => get_option( 'srfm_default_dynamic_block_option', Helper::default_dynamic_block_option() ), |
| 230 | 'form_selector_nonce' => current_user_can( 'edit_posts' ) ? wp_create_nonce( 'wp_rest' ) : '', |
| 231 | 'is_admin_user' => current_user_can( 'manage_options' ), |
| 232 | 'site_url' => $site_url, |
| 233 | 'is_suremails_active' => is_plugin_active( 'suremails/suremails.php' ), |
| 234 | ] |
| 235 | ); |
| 236 | |
| 237 | // Localizing the field preview image links. |
| 238 | wp_localize_script( |
| 239 | SRFM_SLUG . $all_screen_blocks, |
| 240 | SRFM_SLUG . '_fields_preview', |
| 241 | apply_filters( |
| 242 | 'srfm_block_preview_images', |
| 243 | [ |
| 244 | 'input_preview' => SRFM_URL . 'images/field-previews/input.svg', |
| 245 | 'email_preview' => SRFM_URL . 'images/field-previews/email.svg', |
| 246 | 'url_preview' => SRFM_URL . 'images/field-previews/url.svg', |
| 247 | 'textarea_preview' => SRFM_URL . 'images/field-previews/textarea.svg', |
| 248 | 'multi_choice_preview' => SRFM_URL . 'images/field-previews/multi-choice.svg', |
| 249 | 'checkbox_preview' => SRFM_URL . 'images/field-previews/checkbox.svg', |
| 250 | 'number_preview' => SRFM_URL . 'images/field-previews/number.svg', |
| 251 | 'phone_preview' => SRFM_URL . 'images/field-previews/phone.svg', |
| 252 | 'dropdown_preview' => SRFM_URL . 'images/field-previews/dropdown.svg', |
| 253 | 'address_preview' => SRFM_URL . 'images/field-previews/address.svg', |
| 254 | 'sureforms_preview' => SRFM_URL . 'images/field-previews/sureforms.svg', |
| 255 | ] |
| 256 | ) |
| 257 | ); |
| 258 | |
| 259 | wp_localize_script( |
| 260 | SRFM_SLUG . $all_screen_blocks, |
| 261 | SRFM_SLUG . '_blocks_info', |
| 262 | [ |
| 263 | 'font_awesome_5_polyfill' => [], |
| 264 | 'collapse_panels' => 'enabled', |
| 265 | 'is_site_editor' => $screen ? $screen->id : null, |
| 266 | ] |
| 267 | ); |
| 268 | } |
| 269 | |
| 270 | /** |
| 271 | * This function generates slug for sureforms blocks. |
| 272 | * Generates slug only if slug attribute of block is empty. |
| 273 | * Ensures that all sureforms blocks have unique slugs. |
| 274 | * |
| 275 | * @param int $post_id current sureforms form post id. |
| 276 | * @param \WP_Post $post SureForms post object. |
| 277 | * @since 0.0.2 |
| 278 | * @return void |
| 279 | */ |
| 280 | public function update_field_slug( $post_id, $post ) { |
| 281 | $blocks = parse_blocks( $post->post_content ); |
| 282 | |
| 283 | if ( empty( $blocks ) ) { |
| 284 | return; |
| 285 | } |
| 286 | |
| 287 | $updated = false; |
| 288 | |
| 289 | /** |
| 290 | * List of slugs already taken by processed blocks. |
| 291 | * used to maintain uniqueness of slugs. |
| 292 | */ |
| 293 | $slugs = []; |
| 294 | |
| 295 | [ $blocks, $slugs, $updated ] = Helper::process_blocks( $blocks, $slugs, $updated ); |
| 296 | |
| 297 | if ( ! $updated ) { |
| 298 | return; |
| 299 | } |
| 300 | |
| 301 | $post_content = addslashes( serialize_blocks( $blocks ) ); |
| 302 | |
| 303 | wp_update_post( |
| 304 | [ |
| 305 | 'ID' => $post_id, |
| 306 | 'post_content' => $post_content, |
| 307 | ] |
| 308 | ); |
| 309 | } |
| 310 | |
| 311 | /** |
| 312 | * Migrate the background type and associated values from |
| 313 | * instant form settings to form styling meta. |
| 314 | * |
| 315 | * @since 1.4.4 |
| 316 | * @return void |
| 317 | */ |
| 318 | public function maybe_migrate_form_stylings() { |
| 319 | $post_id = isset( $_GET['post'] ) ? Helper::get_integer_value( sanitize_text_field( wp_unslash( $_GET['post'] ) ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- $_GET['post'] does not provide nonce. |
| 320 | if ( empty( $post_id ) || ! current_user_can( 'edit_post', $post_id ) ) { |
| 321 | return; |
| 322 | } |
| 323 | |
| 324 | $post_type = get_post_type( $post_id ); |
| 325 | if ( SRFM_FORMS_POST_TYPE !== $post_type ) { |
| 326 | return; |
| 327 | } |
| 328 | |
| 329 | $instant_form_settings = get_post_meta( $post_id, '_srfm_instant_form_settings', true ); |
| 330 | if ( ! is_array( $instant_form_settings ) ) { |
| 331 | return; |
| 332 | } |
| 333 | |
| 334 | $form_styling = get_post_meta( $post_id, '_srfm_forms_styling', true ); |
| 335 | if ( ! is_array( $form_styling ) ) { |
| 336 | $form_styling = []; |
| 337 | } |
| 338 | |
| 339 | $migrated = false; |
| 340 | $keys = [ 'bg_type', 'bg_color', 'bg_image', 'bg_image_id' ]; |
| 341 | |
| 342 | foreach ( $keys as $key ) { |
| 343 | if ( ! isset( $form_styling[ $key ] ) && isset( $instant_form_settings[ $key ] ) ) { |
| 344 | $form_styling[ $key ] = $instant_form_settings[ $key ]; |
| 345 | $migrated = true; |
| 346 | } |
| 347 | } |
| 348 | if ( $migrated ) { |
| 349 | update_post_meta( $post_id, '_srfm_forms_styling', $form_styling ); |
| 350 | } |
| 351 | } |
| 352 | |
| 353 | /** |
| 354 | * Register block pattern from the specified directory. |
| 355 | * |
| 356 | * @param string|mixed $block_pattern The block pattern name. |
| 357 | * @param string $directory The directory path. |
| 358 | * @since 0.0.2 |
| 359 | * @return bool True if the block pattern was registered, false otherwise. |
| 360 | */ |
| 361 | private function register_block_pattern_from_directory( $block_pattern, $directory ) { |
| 362 | $pattern_file = $directory . $block_pattern . '.php'; |
| 363 | |
| 364 | if ( is_readable( $pattern_file ) ) { |
| 365 | register_block_pattern( 'srfm/' . $block_pattern, require $pattern_file ); |
| 366 | return true; |
| 367 | } |
| 368 | |
| 369 | return false; |
| 370 | } |
| 371 | } |
| 372 |