-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
109 lines (81 loc) · 2.5 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# Idloom Events Attendee Display
A WordPress plugin for displaying attendee information from the Idloom Events API with sorting, filtering, and pagination capabilities.
## Features
- Displays attendees in a sortable table
- Real-time search filtering (minimum 3 characters)
- Pagination (20 attendees per page)
- Sortable columns for attendee details
- Displays primary cast, other casts, and country information
- API integration with Idloom Events
- Admin configuration panel
- Caching system (5min primary, 1hr backup)
- Support for large events (200+ attendees)
## Installation
1. Download the plugin files
2. Upload to your `/wp-content/plugins/` directory
3. Activate the plugin through WordPress admin menu
4. Navigate to "Idloom Settings" and configure
## Configuration
1. Navigate to "Idloom Settings" in WordPress admin menu
2. Enter your API Key
3. Enter your Event ID
4. Save settings
5. (Optional) Monitor cache status in Cache Status submenu
## Usage
Use the shortcode `[display_attendees]` in any post or page to display the attendee list.
## File Structure
- idloom-attendee-display.php
- includes/
- class-api-handler.php
- class-admin.php
- class-display.php
- templates/
- admin-page.php
- attendee-list.php
- cache-status.php
- assets/
- css/style.css
- js/script.js
## API Requirements
- Requires valid Idloom Events API credentials
- API must return attendee data with:
- firstname
- lastname
- free_field12 (Primary Cast)
- free_field40 (Other Casts)
- cpy_country
- free_field56 (Who's Registered List visibility)
## Display Fields
- First Name
- Last Name
- Primary Cast
- Other Casts (comma-separated)
- Country
## Filtering
Only displays attendees with:
- registration_status = 'Complete'
- payment_status = 'Paid'
- free_field56 = true (Who's Registered List permission)
## Dependencies
- WordPress 5.0+
- PHP 7.2+
- jQuery (included with WordPress)
- Dashicons (included with WordPress)
## Development
### API Handler
Handles API communication, caching, and data filtering. Includes pagination support for large datasets.
### Admin Panel
Manages plugin settings and cache monitoring through WordPress admin interface.
### Display Handler
Controls frontend display, sorting, searching, and shortcode functionality.
## Debug Mode
Enable WP_DEBUG in wp-config.php for detailed logging to wp-content/uploads/idloom-debug.log.
## Styling
Custom CSS classes for styling:
- .attendee-list
- .attendee-search
- .attendee-table
- .sortable
- .pagination
## License
GPL v3 or later