namespace Elementor\Modules\Variables\Classes;
use Elementor\Modules\Variables\Storage\Exceptions\Type_Mismatch;
use Elementor\Modules\Variables\Services\Variables_Service;
use Elementor\Modules\Variables\Module as Variables_Module;
use Elementor\Modules\Variables\Storage\Exceptions\VariablesLimitReached;
use Elementor\Modules\Variables\Storage\Exceptions\RecordNotFound;
use Elementor\Modules\Variables\Storage\Exceptions\DuplicatedLabel;
use Elementor\Modules\Variables\Storage\Exceptions\BatchOperationFailed;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
const API_NAMESPACE = 'elementor/v1';
const API_BASE = 'variables';
const HTTP_CREATED = 201;
const HTTP_BAD_REQUEST = 400;
const HTTP_NOT_FOUND = 404;
const HTTP_SERVER_ERROR = 500;
const MAX_ID_LENGTH = 64;
const MAX_LABEL_LENGTH = 50;
const MAX_VALUE_LENGTH = 512;
private Variables_Service $service;
public function __construct( Variables_Service $service ) {
$this->service = $service;
public function enough_permissions_to_perform_ro_action() {
return current_user_can( 'edit_posts' );
public function enough_permissions_to_perform_rw_action() {
return current_user_can( 'manage_options' );
public function register_routes() {
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/list', [
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_variables' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_ro_action' ],
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/create', [
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'create_variable' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],
'validate_callback' => [ $this, 'is_valid_variable_type' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_label' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_value' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/update', [
'methods' => WP_REST_Server::EDITABLE,
'callback' => [ $this, 'update_variable' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],
'validate_callback' => [ $this, 'is_valid_variable_id' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_label' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_value' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_order' ],
'validate_callback' => [ $this, 'is_valid_variable_type' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/delete', [
'methods' => WP_REST_Server::EDITABLE,
'callback' => [ $this, 'delete_variable' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],
'validate_callback' => [ $this, 'is_valid_variable_id' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/restore', [
'methods' => WP_REST_Server::EDITABLE,
'callback' => [ $this, 'restore_variable' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],
'validate_callback' => [ $this, 'is_valid_variable_id' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_label' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_value' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
'validate_callback' => [ $this, 'is_valid_variable_type' ],
'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],
register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/batch', [
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'process_batch' ],
'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],
'validate_callback' => [ $this, 'is_valid_watermark' ],
'validate_callback' => [ $this, 'is_valid_operations_array' ],
public function trim_and_sanitize_text_field( $value ) {
return trim( sanitize_text_field( $value ) );
public function is_valid_variable_id( $id ) {
'invalid_variable_id_empty',
__( 'ID cannot be empty', 'elementor' )
if ( self::MAX_ID_LENGTH < strlen( $id ) ) {
return new WP_Error( 'invalid_variable_id_length', sprintf(
/* translators: %d: Maximum ID length. */
__( 'ID cannot exceed %d characters', 'elementor' ),
public function is_valid_variable_type( $type ) {
$allowed_types = array_keys( Variables_Module::instance()->get_variable_types_registry()->all() );
return in_array( $type, $allowed_types, true );
public function is_valid_variable_label( $label ) {
'invalid_variable_label_empty',
__( 'Label cannot be empty', 'elementor' )
if ( self::MAX_LABEL_LENGTH < strlen( $label ) ) {
return new WP_Error( 'invalid_variable_label_length', sprintf(
/* translators: %d: Maximum label length. */
__( 'Label cannot exceed %d characters', 'elementor' ),
public function is_valid_order( $order ) {
if ( ! is_numeric( $order ) || $order < 0 ) {
__( 'Order must be a non-negative integer', 'elementor' )
public function is_valid_variable_value( $value ) {
'invalid_variable_value_empty',
__( 'Value cannot be empty', 'elementor' )
if ( self::MAX_VALUE_LENGTH < strlen( $value ) ) {
return new WP_Error( 'invalid_variable_value_length', sprintf(
/* translators: %d: Maximum value length. */
__( 'Value cannot exceed %d characters', 'elementor' ),
public function create_variable( WP_REST_Request $request ) {
return $this->create_new_variable( $request );
} catch ( Exception $e ) {
return $this->error_response( $e );
protected function clear_cache() {
Plugin::$instance->files_manager->clear_cache();
private function create_new_variable( WP_REST_Request $request ) {
$type = $request->get_param( 'type' );
$label = $request->get_param( 'label' );
$value = $request->get_param( 'value' );
$result = $this->service->create( [
return $this->success_response( [
'variable' => $result['variable'],
'watermark' => $result['watermark'],
public function update_variable( WP_REST_Request $request ) {
return $this->update_existing_variable( $request );
} catch ( Exception $e ) {
return $this->error_response( $e );
private function update_existing_variable( WP_REST_Request $request ) {
$id = $request->get_param( 'id' );
$label = $request->get_param( 'label' );
$value = $request->get_param( 'value' );
$order = $request->get_param( 'order' );
$type = $request->get_param( 'type' );
$update_data['type'] = $type;
$update_data['order'] = $order;
$result = $this->service->update( $id, $update_data );
return $this->success_response( [
'variable' => $result['variable'],
'watermark' => $result['watermark'],
public function delete_variable( WP_REST_Request $request ) {
return $this->delete_existing_variable( $request );
} catch ( Exception $e ) {
return $this->error_response( $e );
private function delete_existing_variable( WP_REST_Request $request ) {
$id = $request->get_param( 'id' );
$result = $this->service->delete( $id );
return $this->success_response( [
'variable' => $result['variable'],
'watermark' => $result['watermark'],
public function restore_variable( WP_REST_Request $request ) {
return $this->restore_existing_variable( $request );
} catch ( Exception $e ) {
return $this->error_response( $e );
private function restore_existing_variable( WP_REST_Request $request ) {
$id = $request->get_param( 'id' );
$label = $request->get_param( 'label' );
$overrides['label'] = $label;
$value = $request->get_param( 'value' );
$overrides['value'] = $value;
$type = $request->get_param( 'type' );
$overrides['type'] = $type;
$result = $this->service->restore( $id, $overrides );
return $this->success_response( [
'variable' => $result['variable'],
'watermark' => $result['watermark'],
public function get_variables() {
return $this->list_of_variables();
} catch ( Exception $e ) {
return $this->error_response( $e );
private function list_of_variables() {
$db_record = $this->service->load();
return $this->success_response( [
'variables' => $db_record['data'] ?? [],
'total' => count( $db_record['data'] ),
'watermark' => $db_record['watermark'],
private function success_response( $payload, $status_code = null ) {
return new WP_REST_Response( [
], $status_code ?? self::HTTP_OK );
private function error_response( Exception $e ) {
if ( $e instanceof VariablesLimitReached ) {
return $this->prepare_error_response(
'invalid_variable_limit_reached',
__( 'Reached the maximum number of variables', 'elementor' )
if ( $e instanceof DuplicatedLabel ) {
return $this->prepare_error_response(
__( 'Variable label already exists', 'elementor' )
if ( $e instanceof RecordNotFound ) {
return $this->prepare_error_response(
__( 'Variable not found', 'elementor' )
if ( $e instanceof Type_Mismatch ) {
return $this->prepare_error_response(
return $this->prepare_error_response(
'unexpected_server_error',
__( 'Unexpected server error', 'elementor' )
private function prepare_error_response( $status_code, $error, $message ) {
return new WP_REST_Response( [
'status' => $status_code,
public function is_valid_watermark( $watermark ) {
if ( ! is_numeric( $watermark ) || $watermark < 0 ) {
__( 'Watermark must be a non-negative integer', 'elementor' )
public function is_valid_operations_array( $operations ) {
if ( ! is_array( $operations ) || empty( $operations ) ) {
'invalid_operations_empty',
__( 'Operations array cannot be empty', 'elementor' )
foreach ( $operations as $index => $operation ) {
if ( ! is_array( $operation ) || ! isset( $operation['type'] ) ) {
$sanitized_index = absint( $index );
'invalid_operation_structure',
/* translators: %d: operation index */