List of variables available for custom functions
You can use Custom function to run designated processes during certain functions.
For example, in the Custom function editor, select [After adding content] as the trigger and enter the target content ID in the text box to run the current function when the target content is added.
Input refers to variables that are pre-assigned to a template, while output refers to variables that are recognized by the system as a result of processing when being assigned to a template.
The variables available differ based on the selected trigger. The following sections list the variables that correspond to the various triggers.
Content
After adding content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
After updating content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
After deleting content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
After rejecting content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
After applying content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
After accepting content
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
Before content validation
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
$ext_no | String | Additional field number |
$filename | String | File name |
Return values
Variable name | Type | Description |
---|---|---|
$errors | Object {Field name: Error message, ...} | Input error |
After downloading content file
Can be set for each content structure ID.
Available variables
Variable name | Type | Description |
---|---|---|
$topics_id | Int | Content ID |
Master
After adding master
Available variables
Variable name | Type | Description |
---|---|---|
$csvtable_id | Int | Master ID |
After updating master
Available variables
Variable name | Type | Description |
---|---|---|
$csvtable_id | Int | Master ID |
After deleting master
Available variables
Variable name | Type | Description |
---|---|---|
$csvtable_id | Int | Master ID |
Member
Before member registration
Available variables
Variable name | Type | Description |
---|---|---|
$row | Object {member_id: Int, name1: String, ...} | Member information |
Return values
Variable name | Type | Description |
---|---|---|
$row | Object {member_id: Int, name1: String, ...} | Member information |
Before updating member information
Available variables
Variable name | Type | Description |
---|---|---|
$member_id | Int | Member ID |
After member registration
Available variables
Variable name | Type | Description |
---|---|---|
$row | Object {member_id: Int, name1: String, ...} | Member information |
After updating member information
Available variables
Variable name | Type | Description |
---|---|---|
$member_id | Int | Member ID |
Before member verification
Available variables
Variable name | Type | Description |
---|---|---|
$member_id | Int | Member ID |
$formData | Object {member_id: Int, name1: String, ...} | Member input information |
$memberExtensionColumns | Object[] [{ disp_name: String, key_name:String, type:String, ...}, ...] | Member input field |
Return values
Variable name | Type | Description |
---|---|---|
$errors | Object {Field name: Error message, ...} | Input error |
Pre-processing for row data in batch member upload
Available variables
Variable name | Type | Description |
---|---|---|
$row | Object {member_id: Int, name1: String, ...} | Member information |
Return values
Variable name | Type | Description |
---|---|---|
$row | Object {member_id: Int, name1: String, ...} | Member information |
$errors | String[] | Error string array |
After batch member upload
Available variables
Variable name | Type | Description |
---|---|---|
$member_ids | Int[] | List of updated member IDs |
Tag
After adding tag
Available variables
Variable name | Type | Description |
---|---|---|
$tag_id | Int | Tag ID |
$tagData | Object {tag_id: Int, tag_nm: String, ...} | Tag information |
After updating tag
Available variables
Variable name | Type | Description |
---|---|---|
$tag_id | Int | Tag ID |
$tagData | Object {tag_id: Int, tag_nm: String, ...} | Tag information |
Before tag validation
Available variables
Variable name | Type | Description |
---|---|---|
$tag_id | Int | Tag ID |
Return values
Variable name | Type | Description |
---|---|---|
$errors | Object {Field name: Error message, ...} | Input error |
-->
E-commerce
After running inventory check logic
Available variables
Variable name | Type | Description |
---|---|---|
$cart_items | Object {Product ID: { product_name: String, topics_name:String, ...}, ...} | Items in shopping cart |
$products | Object { topics_name:String, ...}} | Product information |
Return values
Variable name | Type | Description |
---|---|---|
$errors | Object {Field name: Error message, ...} | Input error |
Authorization
API login check
Return values
Variable name | Type | Description |
---|---|---|
$login_email | String | E-mail address or login ID |
$login_member_id | Int | Member ID |
$login_save | Bool | Maintain login status |
$is_login | Bool | Allow login |
$custom_search_ids | Int[] | Permission for user logging in |
After logging in
Available variables
Variable name | Type | Description |
---|---|---|
$is_login | Bool | Allow login |
$auto_login | Bool | Save login |
$custom_search_ids | Int[] | Permission for user logging in |
$member_id | Int | Member ID |
Return values
Variable name | Type | Description |
---|---|---|
$is_login | Bool | Allow login |
$auto_login | Bool | Save login |
$custom_search_ids | Int[] | Permission for user logging in |
After changing password using reminder
Available variables
Variable name | Type | Description |
---|---|---|
$member_id | Int | Member ID |
Workflow
After workflow application
Can be set for each approval workflow ID.
Available variables
Variable name | Type | Description |
---|---|---|
$module_nm | String | Module name |
$module_id | Int | Module ID |
After approving workflow application
Can be set for each approval workflow ID.
Available variables
Variable name | Type | Description |
---|---|---|
$module_nm | String | Module name |
$module_id | Int | Module ID |
$approvalflow_apply | Object {approvalflow_id: Int, draft_id: Int, ...} | Application information |
$nextApply | Object {approvalflow_id: Int, approvalflow_apply_id: Int, ...} | Information on next approval application request |
After rejecting workflow application
Can be set for each approval workflow ID.
Available variables
Variable name | Type | Description |
---|---|---|
$module_nm | String | Module name |
$module_id | Int | Module ID |
Notification
Upon adding notification recipient(s)
Can be set for each notification ID.
Available variables
Variable name | Type | Description |
---|---|---|
$magazine_data | Object {magazine_id: Int, magazine_name: String, ...} | Notification details |
$destination | Int[] | Member search condition ID(s) of the recipient(s) |
$search_condition_list | String[] | Member search conditions of the recipient(s) |
$preview_flg | Bool | true when pre-verified on the admin panel |
Return values
Variable name | Type | Description |
---|---|---|
$additional_member_ids | Int[] | Member ID(s) of added recipient(s) |
Before sending notification
Can be set for each notification ID.
Available variables
Variable name | Type | Description |
---|---|---|
$mail_header | String | Message header |
$subject | String | Subject line |
$body | String | Message body (HTML) |
$body_plain | String | Message body (text) |
$can_send | Bool | Allow delivery |
$member_id | Int | Member ID |
$magazine_data | Object {magazine_id: Int, magazine_name: String, ...} | Notification details |
Return values
Variable name | Type | Description |
---|---|---|
$mail_header | String | Message header |
$subject | String | Subject line |
$body | String | Message body (HTML) |
$body_plain | String | Message body (text) |
$can_send | Bool | Allow delivery |
$member | Object {email: String, ...} | Member information |
Notification substitution
Can be set for each notification ID.
Available variables
Variable name | Type | Description |
---|---|---|
$member_info | Object {member_id: Int, name1: String, ...} | Recipient information |
$magazine_info | Object {magazine_id: Int, magazine_name: String, ...} | Notification details |
Return values
Variable name | Type | Description |
---|---|---|
$substitutions | Object {String to be replaced: string to be replaced, ...} | Replaced string |