← All changes | integrations/wp-forms/includes/triggers.php +234 -0 7.9.0 → 8.0.5 View file →

		@@ -1,0 +1,234 @@
	1	+<?php
	2	+/**
	3	+ * Triggers
	4	+ *
	5	+ * @package GamiPress\WP_Forms\Triggers
	6	+ * @since 1.0.0
	7	+ */
	8	+
	9	+// Exit if accessed directly
	10	+if( !defined( 'ABSPATH' ) ) exit;
	11	+
	12	+/**
	13	+ * Register plugin specific triggers
	14	+ *
	15	+ * @since 1.0.0
	16	+ *
	17	+ * @param array $triggers
	18	+ * @return mixed
	19	+ */
	20	+function gamipress_wp_forms_activity_triggers( $triggers ) {
	21	+
	22	+ $triggers[__( 'WPForms', 'gamipress' )] = array(
	23	+ 'gamipress_wp_forms_new_form_submission' => __( 'Successful submit a form', 'gamipress' ),
	24	+ 'gamipress_wp_forms_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ),
	25	+ 'gamipress_wp_forms_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
	26	+ 'gamipress_wp_forms_specific_field_value_submission' => __( 'Submit a specific field value on a specific form', 'gamipress' ),
	27	+ );
	28	+
	29	+ return $triggers;
	30	+
	31	+}
	32	+add_filter( 'gamipress_activity_triggers', 'gamipress_wp_forms_activity_triggers' );
	33	+
	34	+/**
	35	+ * Register plugin specific activity triggers
	36	+ *
	37	+ * @since 1.0.0
	38	+ *
	39	+ * @param array $specific_activity_triggers
	40	+ * @return array
	41	+ */
	42	+function gamipress_wp_forms_specific_activity_triggers( $specific_activity_triggers ) {
	43	+
	44	+ $specific_activity_triggers['gamipress_wp_forms_specific_new_form_submission'] = array( 'wpforms' );
	45	+ $specific_activity_triggers['gamipress_wp_forms_specific_field_value_submission'] = array( 'wpforms' );
	46	+
	47	+ return $specific_activity_triggers;
	48	+}
	49	+add_filter( 'gamipress_specific_activity_triggers', 'gamipress_wp_forms_specific_activity_triggers' );
	50	+
	51	+/**
	52	+ * Build custom activity trigger label
	53	+ *
	54	+ * @since 1.0.0
	55	+ *
	56	+ * @param string $title
	57	+ * @param integer $requirement_id
	58	+ * @param array $requirement
	59	+ *
	60	+ * @return string
	61	+ */
	62	+function gamipress_wp_forms_activity_trigger_label( $title, $requirement_id, $requirement ) {
	63	+
	64	+ $field_name = ( isset( $requirement['wp_forms_field_name'] ) ) ? $requirement['wp_forms_field_name'] : '';
	65	+ $field_value = ( isset( $requirement['wp_forms_field_value'] ) ) ? $requirement['wp_forms_field_value'] : '';
	66	+
	67	+ switch( $requirement['trigger_type'] ) {
	68	+ // Specific field value
	69	+ case 'gamipress_wp_forms_field_value_submission':
	70	+ return sprintf( __( 'Submit a form setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value );
	71	+ break;
	72	+ // Specific field value on a specific form
	73	+ case 'gamipress_wp_forms_specific_field_value_submission':
	74	+ $achievement_post_id = absint( $requirement['achievement_post'] );
	75	+ $form_title = gamipress_get_specific_activity_trigger_post_title( $achievement_post_id, $requirement['trigger_type'], get_current_blog_id() );
	76	+ return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_title, $field_name, $field_value );
	77	+ break;
	78	+ }
	79	+
	80	+ return $title;
	81	+}
	82	+add_filter( 'gamipress_activity_trigger_label', 'gamipress_wp_forms_activity_trigger_label', 10, 3 );
	83	+
	84	+/**
	85	+ * Register plugin specific activity triggers labels
	86	+ *
	87	+ * @since 1.0.0
	88	+ *
	89	+ * @param array $specific_activity_trigger_labels
	90	+ * @return array
	91	+ */
	92	+function gamipress_wp_forms_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
	93	+
	94	+ $specific_activity_trigger_labels['gamipress_wp_forms_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' );
	95	+ $specific_activity_trigger_labels['gamipress_wp_forms_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' );
	96	+
	97	+ return $specific_activity_trigger_labels;
	98	+}
	99	+add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_wp_forms_specific_activity_trigger_label' );
	100	+
	101	+/**
	102	+ * Get user for a given trigger action.
	103	+ *
	104	+ * @since 1.0.0
	105	+ *
	106	+ * @param integer $user_id user ID to override.
	107	+ * @param string $trigger Trigger name.
	108	+ * @param array $args Passed trigger args.
	109	+ * @return integer User ID.
	110	+ */
	111	+function gamipress_wp_forms_trigger_get_user_id( $user_id, $trigger, $args ) {
	112	+
	113	+ switch ( $trigger ) {
	114	+ case 'gamipress_wp_forms_new_form_submission':
	115	+ case 'gamipress_wp_forms_specific_new_form_submission':
	116	+ case 'gamipress_wp_forms_field_value_submission':
	117	+ case 'gamipress_wp_forms_specific_field_value_submission':
	118	+ $user_id = $args[1];
	119	+ break;
	120	+ }
	121	+
	122	+ return $user_id;
	123	+
	124	+}
	125	+add_filter( 'gamipress_trigger_get_user_id', 'gamipress_wp_forms_trigger_get_user_id', 10, 3);
	126	+
	127	+
	128	+/**
	129	+ * Get the id for a given specific trigger action.
	130	+ *
	131	+ * @since 1.0.0
	132	+ *
	133	+ * @param integer $specific_id Specific ID.
	134	+ * @param string $trigger Trigger name.
	135	+ * @param array $args Passed trigger args.
	136	+ *
	137	+ * @return integer Specific ID.
	138	+ */
	139	+function gamipress_wp_forms_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
	140	+
	141	+ switch ( $trigger ) {
	142	+ case 'gamipress_wp_forms_specific_new_form_submission':
	143	+ case 'gamipress_wp_forms_specific_field_value_submission':
	144	+ $specific_id = $args[0];
	145	+ break;
	146	+ }
	147	+
	148	+ return $specific_id;
	149	+}
	150	+add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_wp_forms_specific_trigger_get_id', 10, 3 );
	151	+
	152	+/**
	153	+ * Extended meta data for event trigger logging
	154	+ *
	155	+ * @since 1.0.0
	156	+ *
	157	+ * @param array $log_meta
	158	+ * @param integer $user_id
	159	+ * @param string $trigger
	160	+ * @param integer $site_id
	161	+ * @param array $args
	162	+ *
	163	+ * @return array
	164	+ */
	165	+function gamipress_wp_forms_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
	166	+
	167	+ switch ( $trigger ) {
	168	+ case 'gamipress_wp_forms_new_form_submission':
	169	+ case 'gamipress_wp_forms_specific_new_form_submission':
	170	+ // Add the form ID
	171	+ $log_meta['form_id'] = $args[0];
	172	+ break;
	173	+ case 'gamipress_wp_forms_field_value_submission':
	174	+ case 'gamipress_wp_forms_specific_field_value_submission':
	175	+ // Add the form ID, field name and value
	176	+ $log_meta['form_id'] = $args[0];
	177	+ $log_meta['field_name'] = $args[2];
	178	+ $log_meta['field_value'] = $args[3];
	179	+ break;
	180	+ }
	181	+
	182	+ return $log_meta;
	183	+}
	184	+add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_wp_forms_log_event_trigger_meta_data', 10, 5 );
	185	+
	186	+/**
	187	+ * Extra data fields
	188	+ *
	189	+ * @since 1.0.5
	190	+ *
	191	+ * @param array $fields
	192	+ * @param int $log_id
	193	+ * @param string $type
	194	+ *
	195	+ * @return array
	196	+ */
	197	+function gamipress_wp_forms_log_extra_data_fields( $fields, $log_id, $type ) {
	198	+
	199	+ $prefix = '_gamipress_';
	200	+
	201	+ $log = ct_get_object( $log_id );
	202	+ $trigger = $log->trigger_type;
	203	+
	204	+ if( $type !== 'event_trigger' ) {
	205	+ return $fields;
	206	+ }
	207	+
	208	+ switch( $trigger ) {
	209	+ case 'gamipress_wp_forms_field_value_submission':
	210	+ case 'gamipress_wp_forms_specific_field_value_submission':
	211	+
	212	+ $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
	213	+
	214	+ $fields[] = array(
	215	+ 'name' => __( 'Field name', 'gamipress' ),
	216	+ 'desc' => __( 'Field name attached to this log.', 'gamipress' ),
	217	+ 'id' => $prefix . 'field_name',
	218	+ 'type' => 'text',
	219	+ );
	220	+ $fields[] = array(
	221	+ 'name' => __( 'Field value', 'gamipress' ),
	222	+ 'desc' => __( 'Field value attached to this log.', 'gamipress' ),
	223	+ 'id' => $prefix . 'field_value',
	224	+ 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
	225	+ 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
	226	+ 'options' => ( is_array( $field_value ) ? $field_value : array() ),
	227	+ );
	228	+ break;
	229	+ }
	230	+
	231	+ return $fields;
	232	+
	233	+}
	234	+add_filter( 'gamipress_log_extra_data_fields', 'gamipress_wp_forms_log_extra_data_fields', 10, 3 );