Black Friday: 40% off every Pro planGet 40% off

Extending PushRow with Custom Providers

Available in: Pro

PushRow Pro can be extended with your own data types (providers) and import destinations (targets).

Data providers

A provider implements the PushRowPro\Providers\Data_Provider interface:

  • get_id(): a unique ID such as my_custom_data.
  • get_label() and get_description(): shown in the job wizard.
  • get_icon(): the icon for the provider card.
  • is_available(): return false when a required plugin is missing.
  • get_fields(): the available fields with their labels and types.
  • get_filters(): the filter options.
  • get_data( array $args = [] ): the rows to export.
  • import_item( array $row_data, array $field_map ): create or update one item from a row.
  • get_sync_hooks(): the WordPress actions that trigger real-time sync.
  • get_available_triggers(): the triggers users can pick, such as create, update and delete.
  • get_item_data( int $item_id, array $fields = [] ): one item’s data, used by real-time sync.

Register it on the pushrow_pro_register_providers action:

add_action( 'pushrow_pro_register_providers', function ( $sync_engine ) {
	$sync_engine->register_provider( new My_Custom_Provider() );
} );

Import targets

Import destinations implement PushRowPro\Targets\Sync_Target (get_fields(), get_unique_keys(), get_settings(), validate_settings(), import_item(), find_existing_item(), delete_item() and the same ID, label, description, icon and availability methods) and register on pushrow_pro_register_targets:

add_action( 'pushrow_pro_register_targets', function ( $sync_engine ) {
	$sync_engine->register_target( new My_Custom_Target() );
} );

Field filters

These filters receive the field list of a built-in provider or target, so you can add or remove fields:

  • Posts and users: pushrow_pro_posts_fields, pushrow_pro_cpt_acf_fields, pushrow_pro_users_provider_fields
  • WooCommerce: pushrow_pro_wc_orders_fields, pushrow_pro_wc_products_fields, pushrow_pro_wc_coupons_fields, pushrow_pro_wc_refunds_fields, pushrow_pro_wc_reviews_fields, pushrow_pro_wc_taxonomies_fields
  • Forms: pushrow_pro_cf7_fields, pushrow_pro_gravity_forms_fields, pushrow_pro_wpforms_fields, pushrow_pro_ninja_forms_fields, pushrow_pro_fluent_forms_fields, pushrow_pro_formidable_fields
  • Easy Digital Downloads: pushrow_pro_edd_orders_fields, pushrow_pro_edd_customers_fields, pushrow_pro_edd_licenses_fields
  • Import targets: pushrow_pro_target_wp_posts_fields, pushrow_pro_target_wp_users_fields, pushrow_pro_target_wc_products_fields, pushrow_pro_target_wc_orders_fields, pushrow_pro_target_wc_coupons_fields, pushrow_pro_target_wc_reviews_fields, pushrow_pro_target_wc_taxonomies_fields

WooCommerce customers, LearnDash, Amelia and custom database tables have no field filter.

Masking EDD license keys

EDD order and license exports include full license keys. Return true from pushrow_pro_edd_mask_license_key to mask them:

add_filter( 'pushrow_pro_edd_mask_license_key', '__return_true' );

Was this page helpful? If something is unclear or missing, tell the developer.