Hooks

Depositline's hooks are WordPress actions and filters. Put the examples in a small custom plugin or your child theme's functions.php. Classes live in the Extendiment\Depositline namespace.

A deposit order keeps its products at their full price, with an untaxed negative fee, "Balance, paid later", for what's left. Once the deposit is paid it gets a child balance order (parent = the deposit order) with one untaxed fee for the balance. Extendiment\Depositline\Balance has the helpers: is_deposit_order( $order ), is_balance( $order ), balance_of( $order ), parent_of( $balance ), amount( $order ), due( $order ) (Y-m-d), outstanding( $order ) and paid( $order ). The "Partially paid" order status is partial-payment (wc-partial-payment).

Loading

Deposit rules

// A 50% deposit, required, on anything over $1,000.
add_filter( 'depositline_rule', function ( $rule, $product ) {
	if ( (float) $product->get_price() > 1000 ) {
		$rule = array( 'mode' => 'required', 'amount' => '50%' );
	}
	return $rule;
}, 10, 2 );

// Never a deposit on gift cards.
add_filter( 'depositline_applies', function ( $applies, $product ) {
	return $product->is_type( 'gift-card' ) ? false : $applies;
}, 10, 2 );

Balances

// Balances are due on the 1st of the month after the usual due date.
add_filter( 'depositline_due_date', function ( $date, $order ) {
	return ( new DateTime( $date ) )->modify( 'first day of next month' )->format( 'Y-m-d' );
}, 10, 2 );

// Tell the warehouse when a layaway is fully paid.
add_action( 'depositline_balance_paid', function ( $parent, $balance ) {
	wp_mail( '[email protected]', 'Paid in full: order #' . $parent->get_order_number(), 'Ready to ship.' );
}, 10, 2 );

Charging saved cards

A connector implements two methods:

• gateway_id(): string: the WooCommerce payment gateway whose saved cards (payment tokens) it charges. The gateway must be enabled.
• charge( WC_Order $order, WC_Payment_Token $token ): array: charge the balance order's total off-session (the customer isn't there). Return result ("paid" or "failed"), optionally transaction (the transaction ID, passed to payment_complete()) and message (why it failed, in words the customer can read: it goes into their email). A thrown exception counts as a failure.

On "paid", Depositline sets the balance order's payment method to that gateway and completes it. On "failed", the customer gets the payment link with the message.

use Extendiment\Depositline\Charging\Connector;

class My_Gateway_Connector implements Connector {
	public function gateway_id(): string {
		return 'my_gateway';
	}
	public function charge( WC_Order $order, WC_Payment_Token $token ): array {
		$response = my_gateway_charge( $token->get_token(), $order->get_total(), $order->get_currency() );
		return $response->ok
			? array( 'result' => 'paid', 'transaction' => $response->id )
			: array( 'result' => 'failed', 'message' => 'Your card was declined.' );
	}
}

add_filter( 'depositline_charge_connectors', function ( $connectors ) {
	$connectors[] = new My_Gateway_Connector();
	return $connectors;
} );

Other deposits plugins

// Pause Depositline while our own deposits plugin is active.
add_filter( 'depositline_conflicts', function ( $names ) {
	if ( is_plugin_active( 'my-deposits/my-deposits.php' ) ) {
		$names['my-deposits/my-deposits.php'] = 'My Deposits';
	}
	return $names;
} );

Settings page

add_action( 'depositline_settings', function ( $page ) {
	register_setting( 'depositline', 'my_layaway_terms' );
	add_settings_section( 'my_layaway', 'Layaway terms', '__return_false', $page );
	add_settings_field( 'my_layaway_terms', 'Terms page', function () {
		wp_dropdown_pages( array( 'name' => 'my_layaway_terms', 'selected' => (int) get_option( 'my_layaway_terms' ), 'show_option_none' => '—' ) );
	}, $page, 'my_layaway' );
} );

Store API (Checkout block)

• Cart extension data, namespace depositline (cart.extensions.depositline): deposit (a deposit is paid today), optional (the customer may pay in full), plan (deposit or full), later (the balance), moved (tax paid today because the balance can't carry it, 0 when none), note (that note's text, or empty), card_offered (the saved-card checkbox applies).
• Cart update, namespace depositline: extensionCartUpdate( { namespace: 'depositline', data: { plan: 'full' } } ) switches optional deposits to paying in full; deposit switches back.
• Checkout extension data, depositline.balance_card (boolean): the customer agrees to have the balance charged to a saved card.

WP-CLI

• wp depositline import [--dry-run]: imports WooCommerce Deposits or Webtomizer product settings and open balances; --dry-run only says what would be imported. Fails while another deposits plugin is active.
• wp depositline remind <balance-order>: runs a balance order's next step now (the reminder, the due-date charge or link, an overdue reminder, or the overdue action) and schedules the one after.

Constants

DEPOSITLINE_VERSION, DEPOSITLINE_FILE, DEPOSITLINE_URL and DEPOSITLINE_DIR.