gamipress / integrations / armember / includes / triggers.php

triggers.php in GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI 8.0.2, at integrations/armember/includes/triggers.php

215 lines 7.1 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\ARMember\Triggers
6	* @since 1.0.0
7	*/
8
9	// Exit if accessed directly
10	if( !defined( 'ABSPATH' ) ) exit;
11
12	/**
13	* Register ARMember specific triggers
14	*
15	* @since 1.0.0
16	*
17	* @param array $triggers
18	* @return mixed
19	*/
20	function gamipress_armember_activity_triggers( $triggers ) {
21
22	$triggers[__( 'ARMember', 'gamipress' )] = array(
23	'gamipress_armember_add_membership' => __( 'Add to membership plan', 'gamipress' ),
24	'gamipress_armember_add_specific_membership' => __( 'Add to specific membership plan', 'gamipress' ),
25	'gamipress_armember_cancel_membership' => __( 'Cancel any membership plan', 'gamipress' ),
26	'gamipress_armember_cancel_specific_membership' => __( 'Cancel a specific membership plan', 'gamipress' ),
27	'gamipress_armember_renew_membership' => __( 'Renew any membership plan', 'gamipress' ),
28	'gamipress_armember_renew_specific_membership' => __( 'Renew a specific membership plan', 'gamipress' ),
29	);
30
31	return $triggers;
32
33	}
34	add_filter( 'gamipress_activity_triggers', 'gamipress_armember_activity_triggers' );
35
36	/**
37	* Register specific activity triggers
38	*
39	* @since 1.0.0
40	*
41	* @param array $specific_activity_triggers
42	* @return array
43	*/
44	function gamipress_armember_specific_activity_triggers( $specific_activity_triggers ) {
45
46	$specific_activity_triggers['gamipress_armember_add_specific_membership'] = array( 'armember_membership' );
47	$specific_activity_triggers['gamipress_armember_cancel_specific_membership'] = array( 'armember_membership' );
48	$specific_activity_triggers['gamipress_armember_renew_specific_membership'] = array( 'armember_membership' );
49
50	return $specific_activity_triggers;
51	}
52	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_armember_specific_activity_triggers' );
53
54	/**
55	* Register specific activity triggers labels
56	*
57	* @since 1.0.0
58	*
59	* @param array $specific_activity_trigger_labels
60	* @return array
61	*/
62	function gamipress_armember_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
63
64	$specific_activity_trigger_labels['gamipress_armember_add_specific_membership'] = __( 'Add to %s membership plan', 'gamipress' );
65	$specific_activity_trigger_labels['gamipress_armember_cancel_specific_membership'] = __( 'Cancel %s membership plan', 'gamipress' );
66	$specific_activity_trigger_labels['gamipress_armember_renew_specific_membership'] = __( 'Renew %s membership plan', 'gamipress' );
67
68	return $specific_activity_trigger_labels;
69	}
70	add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_armember_specific_activity_trigger_label' );
71
72	/**
73	* Get plugin specific activity trigger post title
74	*
75	* @since 1.0.0
76	*
77	* @param string $post_title
78	* @param integer $specific_id
79	* @param string $trigger_type
80	*
81	* @return string
82	*/
83	function gamipress_armember_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) {
84
85	switch( $trigger_type ) {
86	case 'gamipress_armember_add_specific_membership':
87	case 'gamipress_armember_cancel_specific_membership':
88	case 'gamipress_armember_renew_specific_membership':
89	if( absint( $specific_id ) !== 0 ) {
90	// Get the membership plan title
91	$plan_title = gamipress_armember_get_plan_title( $specific_id );
92
93	$post_title = $plan_title;
94	}
95	break;
96	}
97
98	return $post_title;
99
100	}
101	add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_armember_specific_activity_trigger_post_title', 10, 3 );
102
103	/**
104	* Get plugin specific activity trigger permalink
105	*
106	* @since 1.0.0
107	*
108	* @param string $permalink
109	* @param integer $specific_id
110	* @param string $trigger_type
111	* @param integer $site_id
112	*
113	* @return string
114	*/
115	function gamipress_armember_specific_activity_trigger_permalink( $permalink, $specific_id, $trigger_type, $site_id ) {
116
117	switch( $trigger_type ) {
118	case 'gamipress_armember_add_specific_membership':
119	case 'gamipress_armember_cancel_specific_membership':
120	case 'gamipress_armember_renew_specific_membership':
121	$permalink = '';
122	break;
123	}
124
125	return $permalink;
126
127	}
128	add_filter( 'gamipress_specific_activity_trigger_permalink', 'gamipress_armember_specific_activity_trigger_permalink', 10, 4 );
129
130
131	/**
132	* Get user for a given trigger action.
133	*
134	* @since 1.0.0
135	*
136	* @param integer $user_id user ID to override.
137	* @param string $trigger Trigger name.
138	* @param array $args Passed trigger args.
139	* @return integer User ID.
140	*/
141	function gamipress_armember_trigger_get_user_id( $user_id, $trigger, $args ) {
142
143	switch ( $trigger ) {
144	case 'gamipress_armember_add_membership':
145	case 'gamipress_armember_add_specific_membership':
146	case 'gamipress_armember_cancel_membership':
147	case 'gamipress_armember_cancel_specific_membership':
148	case 'gamipress_armember_renew_membership':
149	case 'gamipress_armember_renew_specific_membership':
150	$user_id = $args[1];
151	break;
152	}
153
154	return $user_id;
155
156	}
157	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_armember_trigger_get_user_id', 10, 3 );
158
159	/**
160	* Get the id for a given specific trigger action.
161	*
162	* @since 1.0.0
163	*
164	* @param integer $specific_id Specific ID to override.
165	* @param string $trigger Trigger name.
166	* @param array $args Passed trigger args.
167	*
168	* @return integer Specific ID.
169	*/
170	function gamipress_armember_specific_trigger_get_id( $specific_id, $trigger, $args ) {
171
172	switch ( $trigger ) {
173	case 'gamipress_armember_add_specific_membership':
174	case 'gamipress_armember_cancel_specific_membership':
175	case 'gamipress_armember_renew_specific_membership':
176	$specific_id = $args[0];
177	break;
178	}
179
180	return $specific_id;
181
182	}
183
184	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_armember_specific_trigger_get_id', 10, 3 );
185
186	/**
187	* Extended meta data for event trigger logging
188	*
189	* @since 1.0.1
190	*
191	* @param array $log_meta
192	* @param integer $user_id
193	* @param string $trigger
194	* @param integer $site_id
195	* @param array $args
196	*
197	* @return array
198	*/
199	function gamipress_armember_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
200
201	switch ( $trigger ) {
202	case 'gamipress_armember_add_membership':
203	case 'gamipress_armember_add_specific_membership':
204	case 'gamipress_armember_cancel_membership':
205	case 'gamipress_armember_cancel_specific_membership':
206	case 'gamipress_armember_renew_membership':
207	case 'gamipress_armember_renew_specific_membership':
208	// Add the membership ID
209	$log_meta['membership_id'] = $args[0];
210	break;
211	}
212
213	return $log_meta;
214	}
215	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_armember_log_event_trigger_meta_data', 10, 5 );