hametuha/sharee

Library to share revenue to users.

0.8.11 2025-02-11 23:59 UTC

Requires

• php: >=7.2
• hametuha/pattern: ^1.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• fakerphp/faker: ^1.20.0
• hametuha/hashboard: ^0.9.1
• phpunit/phpunit: ~5.7|^6|^7
• wp-coding-standards/wpcs: ~3.0
• yoast/phpunit-polyfills: ^1.0

GPL-3.0-or-later

• Hametuha INC

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++;
}

Query User

There are 2 additional query vars for user query.

• paid_since: Filter users who has been paid since the date.
• paid_until: Filter users who has been paid until the date.

This works with WP_User_Query.

$query = new WP_User_Query( [
	'role'        => 'subscriber',
	'paid_since'  => '2018-01-01',
	'paid_until'  => '2018-12-31',
	'number'      => 10,
	'paged'       => 1,
] );