'my_module', * 'selector' => '.module-selector', * 'attr' => array( 'attr1' => 'value1', 'attr2' => 'value2' ), * 'transform' => array( 'attr1' => 'value1', 'attr2' => 'value2' ), * 'storeInstance' => null, * ); * self::set( $args ); * ``` * * @example How scroll settings presented as a JSON object named `diviElementScrollData`: * * ```html * * ``` */ public static function set( array $args ): void { $args = array_merge( [ 'id' => '', 'selector' => '', 'attr' => [], 'transform' => [], // FE only. 'storeInstance' => null, ], $args ); // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase,WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- WP use snakeCase in \WP_Block_Parser_Block /** * Module Block Data. * * @var BlockParserBlock $module_data */ $module_data = BlockParserStore::get( $args['id'], $args['storeInstance'] ); // bail if no module data is found or no block name is found. if ( empty( $args['attr'] ) && ( empty( $module_data ) || empty( $module_data->blockName ) ) ) { return; } /** * Module Configurations. * * @var \WP_Block_Type $module_config */ $module_config = \WP_Block_Type_Registry::get_instance()->get_registered( $module_data->blockName ); $parent_script_setting = []; $parent_id = $module_data->parentId; $is_child_module = 'child-module' === $module_config->category; if ( $is_child_module ) { $parent_data = BlockParserStore::get( $parent_id, $args['storeInstance'] ); $parent_attrs = $parent_data->get_merged_attrs(); $parent_attr = $parent_attrs['module'] ?? []; // regex test: https://regex101.com/r/9DZVS6/1. $regex = '/"gridMotion":\{"enable":"on"\}/m'; // only process parent scroll effects if grid motion is enabled in the attributes. if ( preg_match( $regex, wp_json_encode( $parent_attr ) ) === 1 ) { $parent_script_setting = ScrollEffectsUtils::get_scroll_setting( [ 'attr' => $parent_attr['decoration']['scroll'] ?? [], 'id' => $parent_id, 'transform' => $parent_attr['decoration']['transform'] ?? [], // Use child item selector. 'selector' => $args['selector'], // FE only. 'storeInstance' => $args['storeInstance'], // Module Data. 'module_data' => $module_data, ] ); } } // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- WP use snakeCase in \WP_Block_Parser_Block // Bail early if no attr is given. // NOTE: Because scroll effects can be inherited from parent module i.e grid motion, // we should only bail early if no parent script setting is given for a child module. if ( empty( $args['attr'] ) && ( $is_child_module && empty( $parent_script_setting ) ) ) { return; } // get scroll effects enabled status. $is_enabled = ScrollEffectsUtils::is_scroll_effects_enabled( $args['id'], BlockParserStore::get_all( $args['storeInstance'] ), $is_child_module, $parent_script_setting ); // Skip if scroll status isn't true. if ( ! $is_enabled ) { return; } $scroll_setting = ScrollEffectsUtils::get_scroll_setting( [ 'attr' => $args['attr'], 'id' => $args['id'], 'selector' => $args['selector'], 'transform' => $args['transform'], 'is_child_module' => $is_child_module, 'parent_script_setting' => $parent_script_setting, 'module_data' => $module_data, // FE only. 'storeInstance' => $args['storeInstance'], ] ); // Register script data item. ScriptData::add_data_item( [ 'data_name' => 'scroll', 'data_item_id' => $args['selector'], 'data_item' => $scroll_setting, ] ); // Cleanup. unset( $scroll_setting ); } }