-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
258 lines (204 loc) · 11.5 KB
/
readme.txt
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
=== Ultimate Integration for Telegram ===
Version: 1.1.0
Stable tag: 1.1.0
Author: BlackSwan
Donate link: https://amirhp.com/contact/
Author URI: https://amirhp.com/landing
Plugin URI: https://wordpress.org/plugins/ultimate-integration-for-telegram/
Contributors: amirhpcom, blackswanlab, pigmentdev
Tags: woocommerce, telegram, notification, automation
Tested up to: 6.7
WC requires at least: 5.0
WC tested up to: 9.7
Text Domain: ultimate-integration-for-telegram
Domain Path: /languages
Copyright: (c) BlackSwanDev, All rights reserved.
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
The most versatile plugin for connecting WordPress to Telegram. Easily send personalized notifications to Telegram channels, groups, or private chats.
== Description ==
**Ultimate Integration for Telegram** is the ultimate solution for connecting WordPress and WooCommerce to Telegram. With this plugin, you can send customized notifications to Telegram channels, groups, bots, or private chats. Packed with features like a Markdown Validator, extensive macros, and a notifications manager, this plugin ensures your Telegram automation is seamless and efficient.
The plugin offers powerful features like dynamic translation management, gettext replacement, and string customization to tailor messages for your audience. Designed for flexibility, it fully supports WooCommerce core and popular add-ons such as WooCommerce Subscription, WooCommerce Membership, WooCommerce Booking, WooCommerce Points and Reward, and WooCommerce Multi-Currency. With extensive developer hooks and filters, it’s open for seamless customization and new integrations. Whether for business, e-commerce, or automation, this plugin is the ultimate solution for managing Telegram notifications directly from your WordPress site.
== Features ==
- **Comprehensive Notifications Panel**: Manage notifications for WordPress, WooCommerce, and supported add-ons with ease.
- **Send Notifications Anywhere**: Send alerts to Telegram channels, groups, bots, or private chats.
- **WooCommerce & Add-on Support**: Fully supports WooCommerce and popular extensions, including:
- WooCommerce Subscriptions
- WooCommerce Memberships
- WooCommerce Bookings
- WooCommerce Points and Rewards
- WooCommerce Multi-Currency
- **Built-in Jalali (Shamsi) Date Support**: Automatically convert Gregorian dates to Jalali for Persian-speaking audiences.
- **Import/Export Notifications**: Easily migrate or duplicate notification settings across websites with JSON import/export.
- **Macros for Dynamic Content**: Customize notifications and buttons with an extensive list of predefined macros.
- **Built-in Translation Manager**: Dynamically translate and replace strings using the built-in gettext manager.
- **String Replacement Tool**: Replace placeholders or dynamic text in notifications effortlessly.
- **HTML and Markdown Support**: Create visually appealing messages with flexible formatting options.
- **Markdown Validator**: Validate messages for correct Markdown formatting to prevent rendering issues in Telegram.
- **Custom Buttons**: Add interactive buttons to your Telegram messages for better user engagement.
- **Developer-Friendly**: Extend functionality using extensive hooks and filters for full customization.
== Available Macros ==
Macros are placeholders that get dynamically replaced with actual values in your Telegram messages and buttons. Below is a sample list of macros available in the plugin.
You can find the complete list of macros in the plugin under the Notifications > Available Macros section.
=== General Macros ===
- `{current_date}`: Current date.
- `{current_time}`: Current time.
- `{current_date_time}`: Current date and time.
- `{current_user_id}`: Current user ID.
- `{current_user_name}`: Current user name.
- `{site_name}`: Website name.
- `{site_url}`: Website URL.
=== WooCommerce Order Details ===
- `{order_id}`: Order ID.
- `{order_number}`: Order number.
- `{order_status}`: Order status.
- `{order_total}`: Total order amount.
- `{order_subtotal}`: Order subtotal amount.
- `{order_tax_total}`: Total tax amount.
- `{order_discount_total}`: Total discount amount.
- `{customer_name}`: Customer name.
- `{customer_email}`: Customer email.
- `{customer_phone}`: Customer phone number.
=== WooCommerce Order URLs ===
- `{edit_url}`: Order edit URL (Admin).
- `{view_url}`: Order view URL (Customer).
- `{pay_url}`: Order payment URL.
- `{cancel_url}`: Order cancel URL.
- `{thank_you_url}`: Order thank-you page URL.
- `{tracking_url}`: Order tracking URL.
=== WooCommerce Add-ons ===
- **WooCommerce Subscription**:
- `{subscription_id}`: Subscription ID.
- `{subscription_status}`: Subscription status.
- `{subscription_total}`: Subscription total amount.
- `{subscription_start_date}`: Subscription start date.
- `{subscription_end_date}`: Subscription end date.
- **WooCommerce Membership**:
- `{membership_plan}`: Membership plan name.
- `{membership_status}`: Membership status.
- `{membership_start_date}`: Membership start date.
- `{membership_end_date}`: Membership expiration date.
- **WooCommerce Booking**:
- `{booking_id}`: Booking ID.
- `{booking_status}`: Booking status.
- `{booking_date}`: Booking date.
- `{booking_start_time}`: Booking start time.
- `{booking_end_time}`: Booking end time.
== Sample Messages ==
Here are some examples of how you can use macros in your notifications:
=== Example 1: New Order Notification ===
**Message:**
`
🎉 New Order Received! 🎉
Order ID: {order_id}
Customer: {customer_name}
Total: {order_total}
View Order: {edit_url}
`
=== Example 2: Subscription Renewal Reminder ===
**Message:**
`
🔔 Subscription Renewal Alert 🔔
Subscription ID: {subscription_id}
Plan: {membership_plan}
Next Payment Date: {subscription_end_date}
`
=== Example 3: Booking Confirmation ===
**Message:**
`
✅ Booking Confirmed ✅
Booking ID: {booking_id}
Date: {booking_date}
Start Time: {booking_start_time}
End Time: {booking_end_time}
`
=== Supported Add-ons and Plugins ===
In addition to WordPress and WooCommerce core, the plugin supports:
- WooCommerce Subscription
- WooCommerce Membership
- WooCommerce Booking
- WooCommerce Points and Reward
- WooCommerce Multi-Currency
- Contact Form 7 (coming soon)
- Gravity Form (coming soon)
The plugin is also open to integration with other plugins via hooks and filters.
=== How to Setup the Plugin ===
1. **Install the Plugin**: Upload and activate it via the WordPress admin dashboard.
2. **Configure General Settings**:
- Go to **Settings > Telegram**.
- Enter your Telegram Bot Token and username.
- Enable or disable options like Jalali date conversion and admin bar link.
3. **Connect the Telegram Bot**:
- Click "Connect Webhook" to enable Telegram integration.
- Use "Send Test Message" to verify the setup.
4. **Create Notifications**:
- Navigate to the **Notifications** tab to manage or add new notifications.
- Customize the message, macros, and formatting for each notification type.
=== How to Setup a Telegram Bot ===
1. Open Telegram and search for **@BotFather**.
2. Start a chat and use the `/newbot` command to create a bot.
3. Follow the instructions to name your bot and get the **Bot Token**.
4. Paste the token into the plugin’s settings under **Your Bot Token**.
5. Use `/setprivacy` in BotFather to allow the bot to receive messages.
=== How to Add Custom Notifications ===
1. Go to the **Notifications** tab in the plugin settings.
2. Select an existing notification or create a new one.
3. Customize the message and macros for each event (e.g., WooCommerce order created, status changed, email sent).
4. Save the notification to enable it.
=== Import/Export Notifications ===
- Use the **Import/Export** button in the Notifications tab to transfer settings.
- Export configurations as JSON to duplicate them on another website.
- Import JSON files to quickly set up predefined notifications.
== Disclaimer and Warranty ==
This plugin is provided "as is" without any warranties, express or implied. While every effort has been made to ensure reliability and security, the developers are not responsible for any issues arising from its use. Always test in a staging environment before deploying to production.
== About the Developer ==
**Ultimate Integration for Telegram** is developed and maintained by [BlackSwanDev](https://blackswandev.com/), in collaboration with [Pigment.Dev](https://pigment.dev/). Together, we have joined forces as a dedicated team of WordPress developers, focused on creating powerful tools for automation and communication.
This project is led by **AmirhpCom**, Learn more at **[amirhp.com](https://amirhp.com/)**.
== Third-Party & External Resources Used ==
This plugin utilizes the following third-party libraries to enhance functionality:
1. Tippy.js v6.3.7
- **Description**: Tippy.js is a lightweight, customizable tooltip library. It is used in this plugin to provide user-friendly tooltips for better UI/UX.
- **License**: MIT License
- **Source**: [https://atomiks.github.io/tippyjs/](https://atomiks.github.io/tippyjs/)
2. jQuery Repeater v1.2.2
- **Description**: jQuery Repeater is a library that allows dynamic addition and removal of form fields. It is used in this plugin to manage repeatable input fields.
- **License**: MIT License
- **Source**: [https://github.com/DubFriend/jquery.repeater](https://github.com/DubFriend/jquery.repeater)
3. Font Awesome (Free Version)
- **Description**: Font Awesome is used to provide icons ONLY on the plugin's settings page for a better user experience.
- **Source**: [https://github.com/FortAwesome/Font-Awesome](https://github.com/FortAwesome/Font-Awesome)
- **License**: [Font Awesome Free License](https://fontawesome.com/license/free).
- **No Account Required**: No additional setup or account is needed.
== Screenshots ==
1. Setting > General
2. Setting > Notifications
3. Setting > Translation Panel
== Installation ==
1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Go to **Settings > Telegram** to configure the plugin.
== Frequently Asked Questions ==
= What is required to use this plugin? =
You need a Telegram bot. Follow the instructions in the plugin to set it up via BotFather.
= How can I contribute to this plugin? =
You can help us improve our works by committing your changes to [pigment-dev/ultimate-integration-for-telegram](https://github.com/pigment-dev/ultimate-integration-for-telegram)
= Does the plugin support WooCommerce add-ons? =
Yes, it supports major WooCommerce add-ons like WooCommerce Subscription, WooCommerce Membership, and WooCommerce Booking.
== Credits ==
Developed at: [BlackSwanDev](https://blackswandev.com/) & [Pigment.Dev](https://pigment.dev/)
Lead Developer: [AmirhpCom](https://amirhp.com/)
== Upgrade Notice ==
Upgrade to enjoy the latest features and stability improvements.
= v1.1.0 | 2025-03-17 | 1403-12-27 =
* Set minimum PHP required to 7.4
* Fixed Markdown Validator
== Changelog ==
For full changelog please view [Github Repository (github.com/pigment-dev/ultimate-integration-for-telegram)](https://github.com/pigment-dev/ultimate-integration-for-telegram)
= v1.1.0 | 2025-03-17 | 1403-12-27 =
* Set minimum PHP required to 7.4
* Fixed Markdown Validator
= v1.0.0 | 2025-01-20 | 1403-11-01 =
* Initial release of Ultimate Integration for Telegram.
* Telegram bot integration with webhook support.
* Notification macros and string replacement features.
* Full WooCommerce integration.