Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for next release #185

Merged
merged 1 commit into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/wild-squids-lick.md

This file was deleted.

6 changes: 6 additions & 0 deletions plugins/wptelegram-login/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## 1.11.3

### Patch Changes

- [#184](https://github.com/wpsocio/wp-projects/pull/184) [`97ad3cd`](https://github.com/wpsocio/wp-projects/commit/97ad3cdca071bab580779a49240cee064f1b1957) Thanks [@irshadahmad21](https://github.com/irshadahmad21)! - Fixed the messed up query params passed by Telegram Mini Apps

## 1.11.2

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion plugins/wptelegram-login/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
**Requires at least:** 6.4
**Requires PHP:** 7.4
**Tested up to:** 6.6.2
**Stable tag:** 1.11.2
**Stable tag:** 1.11.3
**License:** GPL-3.0-or-later
**License URI:** [https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html)
**Donate link:** [wpsocio.com/donate](https://wpsocio.com/donate)
Expand Down
2 changes: 1 addition & 1 deletion plugins/wptelegram-login/composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wpsocio/wptelegram-login",
"version": "1.11.2",
"version": "1.11.3",
"description": "Let the users login to your website with their Telegram and make it simple for them to get connected and let them receive their email notifications on Telegram.",
"scripts": {
"gen:docs": "\"vendor/bin/wp-documentor\" parse src --format=markdown --output=docs/README.md --relative=docs",
Expand Down
288 changes: 144 additions & 144 deletions plugins/wptelegram-login/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,140 @@ Source: [src/shared/LoginHandler.php](../src/shared/LoginHandler.php), [line 634

## Filters

### `widget_title`

*Filters the widget title.*

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$title` | `string` | The widget title. Default 'Pages'.
`$instance` | `array` | Array of settings for the current widget.
`$this->id_base` | |

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/widgets/Primary.php](../src/shared/widgets/Primary.php), [line 46](../src/shared/widgets/Primary.php#L46-L55)

### `wptelegram_login_redirect_to`

*Filters the redirect URL for the login button*

It can be used to fix the wrong URL in case the website is in subdirectory and the URL is invalid.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$redirect_to` | `string` | The redirect URL.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 125](../src/shared/Shared.php#L125-L134)

### `wptelegram_login_telegram_callback_url`

*Filters the callback URL for the login button*

It can be used to fix the wrong URL in case the website is in subdirectory and the URL is invalid.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$callback_url` | `string` | The callback URL.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 154](../src/shared/Shared.php#L154-L163)

### `wptelegram_login_show_if_user_connected`

*Filters whether to show the button if user is already connected.*

- [Examples](./examples/show_if_user_connected.md)

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$show_if_connected` | `bool` | Whether to show the button if user is already connected.
`$current_user_telegram_id` | `int` | The current user's Telegram ID.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 218](../src/shared/Shared.php#L218-L226)

### `wptelegram_login_show_if_user_is`

*Filters when to show the login button*

Possible values:
"logged_out", "logged_in", "author", "subscriber" etc.

You can also pass a user role e.g "editor" or a comma separated list or an array of roles
to display the button for specific user roles

Passing an empty value will display the button
for both logged in and logged out users

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$show_if_user_is` | `string` | When to show the button.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 232](../src/shared/Shared.php#L232-L248)

### `wptelegram_login_use_telegram_avatar`

*Filters whether to use the Telegram avatar.*

Pass `false` to disable the Telegram avatar.

- [Examples](./examples/use_telegram_avatar.md)

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$use_telegram_avatar` | `bool` | Whether to use the Telegram avatar.
`$url` | `string` | Avatar URL.
`$id_or_email` | `mixed` | user id or email.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 307](../src/shared/Shared.php#L307-L318)

### `wptelegram_login_custom_avatar_url`

*Filters the custom avatar URL.*

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$avatar_url` | `string` | The custom avatar URL.
`$url` | `string` | Avatar URL.
`$id_or_email` | `mixed` | user id or email.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 352](../src/shared/Shared.php#L352-L359)

### `wptelegram_login_validation_query_params`

*Filter the validation query parameters that the plugin uses.*
Expand Down Expand Up @@ -341,139 +475,32 @@ Argument | Type | Description

Source: [src/shared/LoginHandler.php](../src/shared/LoginHandler.php), [line 682](../src/shared/LoginHandler.php#L682-L688)

### `widget_title`

*Filters the widget title.*

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$title` | `string` | The widget title. Default 'Pages'.
`$instance` | `array` | Array of settings for the current widget.
`$this->id_base` | |

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/widgets/Primary.php](../src/shared/widgets/Primary.php), [line 46](../src/shared/widgets/Primary.php#L46-L55)

### `wptelegram_login_redirect_to`

*Filters the redirect URL for the login button*

It can be used to fix the wrong URL in case the website is in subdirectory and the URL is invalid.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$redirect_to` | `string` | The redirect URL.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 125](../src/shared/Shared.php#L125-L134)

### `wptelegram_login_telegram_callback_url`

*Filters the callback URL for the login button*

It can be used to fix the wrong URL in case the website is in subdirectory and the URL is invalid.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$callback_url` | `string` | The callback URL.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 154](../src/shared/Shared.php#L154-L163)

### `wptelegram_login_show_if_user_connected`

*Filters whether to show the button if user is already connected.*

- [Examples](./examples/show_if_user_connected.md)

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$show_if_connected` | `bool` | Whether to show the button if user is already connected.
`$current_user_telegram_id` | `int` | The current user's Telegram ID.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 218](../src/shared/Shared.php#L218-L226)

### `wptelegram_login_show_if_user_is`

*Filters when to show the login button*

Possible values:
"logged_out", "logged_in", "author", "subscriber" etc.

You can also pass a user role e.g "editor" or a comma separated list or an array of roles
to display the button for specific user roles

Passing an empty value will display the button
for both logged in and logged out users

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$show_if_user_is` | `string` | When to show the button.

**Changelog**

Version | Description
------- | -----------
`1.0.0` |

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 232](../src/shared/Shared.php#L232-L248)

### `wptelegram_login_use_telegram_avatar`

*Filters whether to use the Telegram avatar.*
### `wptelegram_login_web_app_login_data`

Pass `false` to disable the Telegram avatar.
*Filters the data for the web app login.*

- [Examples](./examples/use_telegram_avatar.md)
This can be used to customize the messages etc. for the web app login UI.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$use_telegram_avatar` | `bool` | Whether to use the Telegram avatar.
`$url` | `string` | Avatar URL.
`$id_or_email` | `mixed` | user id or email.
`$data` | `array` | The data for the web app login.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 307](../src/shared/Shared.php#L307-L318)
Source: [src/includes/AssetManager.php](../src/includes/AssetManager.php), [line 274](../src/includes/AssetManager.php#L274-L281)

### `wptelegram_login_custom_avatar_url`
### `wptelegram_login_language_options`

*Filters the custom avatar URL.*
*Filters the language options for the settings page.*

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$avatar_url` | `string` | The custom avatar URL.
`$url` | `string` | Avatar URL.
`$id_or_email` | `mixed` | user id or email.
`$data` | `array` | The language options.
`$translations` | `array` | The available translations.

Source: [src/shared/Shared.php](../src/shared/Shared.php), [line 352](../src/shared/Shared.php#L352-L359)
Source: [src/includes/AssetManager.php](../src/includes/AssetManager.php), [line 410](../src/includes/AssetManager.php#L410-L416)

### `wptelegram_login_intercept_request_on`

Expand All @@ -489,33 +516,6 @@ Argument | Type | Description

Source: [src/includes/Main.php](../src/includes/Main.php), [line 392](../src/includes/Main.php#L392-L399)

### `wptelegram_login_web_app_login_data`

*Filters the data for the web app login.*

This can be used to customize the messages etc. for the web app login UI.

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$data` | `array` | The data for the web app login.

Source: [src/includes/AssetManager.php](../src/includes/AssetManager.php), [line 272](../src/includes/AssetManager.php#L272-L279)

### `wptelegram_login_language_options`

*Filters the language options for the settings page.*

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$data` | `array` | The language options.
`$translations` | `array` | The available translations.

Source: [src/includes/AssetManager.php](../src/includes/AssetManager.php), [line 408](../src/includes/AssetManager.php#L408-L414)


<p align="center"><a href="https://github.com/pronamic/wp-documentor"><img src="https://cdn.jsdelivr.net/gh/pronamic/wp-documentor@main/logos/pronamic-wp-documentor.svgo-min.svg" alt="Pronamic WordPress Documentor" width="32" height="32"></a><br><em>Generated by <a href="https://github.com/pronamic/wp-documentor">Pronamic WordPress Documentor</a> <code>1.2.0</code></em><p>

2 changes: 1 addition & 1 deletion plugins/wptelegram-login/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "wptelegram-login",
"title": "WP Telegram Login",
"version": "1.11.2",
"version": "1.11.3",
"description": "Let the users login to your website with their Telegram and make it simple for them to get connected and let them receive their email notifications on Telegram.",
"private": true,
"license": "GPL-3.0-or-later",
Expand Down
Loading
Loading