Elementor Developers

# Field Dependencies

Elementor Pro Advanced

Some form fields are dependent on custom scripts for functionality and custom styles for look and feel.

# Dependency Properties

Inside the field class we can enqueue any required JS and CSS dependencies the following way:

class Elementor_Test_Field extends \ElementorPro\Modules\Forms\Fields\Field_Base {

	public $depended_scripts = [ 'script-handle' ];

	public $depended_styles = [ 'style-handle' ];

}
1
2
3
4
5
6
7

  • Field Scripts – The $depended_scripts property defines the JS files required to display the field.

  • Field Styles – The $depended_styles property defines the CSS files required to display the field.

# Registering Scripts & Styles in WordPress

Like any other WordPress plugin, scripts and styles have to be registered using the wp_register_script() (opens new window) and wp_register_style() (opens new window) functions in the plugin’s PHP.

You can use the wp_enqueue_scripts (opens new window) hook to register scripts and styles on front-end pages

# Registering Scripts & Styles in Elementor

Elementor addon developers should register JS and CSS dependencies in the main file, usually where form fields are registered:

/**
 * Register Elementor form fields.
 */
function elementor_test_field_registration( $form_fields_registrar ) {

	require_once( __DIR__ . '/forms/fields/field-1.php' );
	require_once( __DIR__ . '/forms/fields/field-2.php' );

	$form_fields_registrar->register( new \Elementor_Test_Field_1() );
	$form_fields_registrar->register( new \Elementor_Test_Field_2() );

}
add_action( 'elementor_pro/forms/fields/register', 'elementor_test_field_registration' );

/**
 * Register scripts and styles for Elementor form fields.
 */
function elementor_test_field_dependencies() {

	/* Scripts */
	wp_register_script( 'field-script', plugins_url( 'assets/js/field-script.js', __FILE__ ) );
	wp_register_script( 'external-library', plugins_url( 'assets/js/libs/external-library.js', __FILE__ ) );

	/* Styles */
	wp_register_style( 'field-style', plugins_url( 'assets/css/field-style.css', __FILE__ ) );
	wp_register_style( 'external-framework', plugins_url( 'assets/css/libs/external-framework.css', __FILE__ ) );

}
add_action( 'wp_enqueue_scripts', 'elementor_test_field_dependencies' );
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

Then, each form field should set its dependencies as follows:

class Elementor_Test_Field extends \ElementorPro\Modules\Forms\Fields\Field_Base {

	public $depended_scripts = [ 'field-script', 'external-library' ];

	public $depended_styles = [ 'field-style', 'external-framework' ];

}
1
2
3
4
5
6
7

# Future Development

Our roadmap includes a task to unify the way scripts and styles are registered across different components.

We plan to deprecate the $depended_scripts and $depended_styles properties, replacing them with the get_script_depends() and get_style_depends() methods. The same way it's done in widgets.

class Elementor_Test_Field extends \ElementorPro\Modules\Forms\Fields\Field_Base {

	public function get_script_depends(): array {
		return [ 'field-script-1', 'field-script-2' ];
	}

	public function get_style_depends(): array {
		return [ 'field-style-1', 'field-style-2' ];
	}

}
1
2
3
4
5
6
7
8
9
10
11

Please Note

To make sure your current code is future campatible, make sure your form field class doesn't have the get_script_depends() and get_style_depends() methods.

← Simple Example →