Developer Reference
Constants
| Constant | Value | Description |
|---|---|---|
RETURNDESK_VERSION | 1.0.0 | Plugin version |
RETURNDESK_PLUGIN_FILE | __FILE__ | Absolute path to main plugin file |
RETURNDESK_PLUGIN_DIR | plugin_dir_path() | Plugin directory path |
RETURNDESK_SETTINGS_OPTION | returndesk_settings | WordPress option key for all settings |
Filters
| Filter | Arguments | Description |
|---|---|---|
returndesk_is_item_eligible | $eligible (bool), $order, $item, $qty | Override eligibility check result |
returndesk_account_tab_label | $label (string) | Change the My Account tab label |
returndesk_reasons | $reasons (array) | Modify available return reasons |
returndesk_email_tokens | $tokens (array), $request (array) | Add custom email tokens |
returndesk_statuses | $statuses (array) | Modify available request statuses |
Actions
| Action | Arguments | Description |
|---|---|---|
returndesk_request_created | $request_id (int), $request (array) | Fires after a new request is inserted |
returndesk_status_updated | $request_id (int), $old_status (string), $new_status (string) | Fires after status change |
returndesk_email_sent | $template (string), $request_id (int) | Fires after a notification email is sent |
Options Schema
| Key | Type | Default | Description |
|---|---|---|---|
returndesk_settings[enable_returns] | string yes/no | yes | Master toggle |
returndesk_settings[return_window_days] | int | 7 | Return eligibility window |
returndesk_settings[allowed_statuses] | array | [completed, processing] | Eligible order statuses |
returndesk_settings[return_allow_sale_products] | string yes/no | yes | Allow returns of sale items |
returndesk_settings[return_reasons] | array | 4 defaults | Selectable return reasons |
returndesk_settings[terms_page_id] | int | 0 | Terms page post ID |
Database Table
Table: {prefix}returndesk_requests
| Column | Type | Description |
|---|---|---|
id | int AUTO_INCREMENT | Request ID |
order_id | int | WooCommerce order ID |
customer_id | int | WordPress user ID |
type | varchar | return |
status | varchar | pending / approved / rejected / cancelled |
items | longtext | JSON array of requested items |
reason | varchar | Selected return reason |
notes | text | Customer notes |
created_at | datetime | Submission timestamp |
updated_at | datetime | Last status change timestamp |