hametuha/sharee

Library to share revenue to users.

0.8.9 2023-03-16 12:22 UTC

This package is auto-updated.

Last update: 2024-03-16 14:25:21 UTC


README

WordPress library for Reward manager.

Installation

composer require hametuha/sharee

To enable sharee, call bootstrap method.

// Call before after_setup_theme
\Hametuha\Sharee::get_instance();

Features

Reward List

Reward list on WordPress Dashboard.

Payment List

Payment list is a expected payment list for user's reward. Works fine with hashboard.

/**
 * Enable payment list
 * 
 * @param bool $enabled Default false.
 * @param bool $service Service name to be enabled.
 */
add_filter( 'sharee_should_enable', function( $enabled, $service ) {
	switch ( $service ) {
		case 'billing': // Billing is billing list.
			return true;
		default:
			return $enabled;
	}
}, 10, 2 );

API

Sharee has no screen to add reward record. You have to enter one manually.

Add Record

$result = RevenueModel::get_instance()->add_revenue( 'kdp', $user_id, $price, [
	'unit'        => $unit,
	'total'       => $total,
	'tax'         => $tax,
	'deducting'   => $deducting,
	'description' => $label
] );
if ( $result && ! is_wp_error( $result ) ) {
	$success++;
}