Skip to content

Commit

Permalink
Prepare for next release (#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
@irshadahmad21
irshadahmad21 authored Mar 13, 2024
1 parent 3f44427 commit f604626
Show file tree
Hide file tree
Showing 25 changed files with 225 additions and 221 deletions.
5 changes: 0 additions & 5 deletions .changeset/flat-years-thank.md
View file

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/gorgeous-actors-promise.md
View file

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/loud-seahorses-bathe.md
View file

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/mighty-fishes-hammer.md
View file

This file was deleted.

317 changes: 161 additions & 156 deletions plugins/wptelegram-login/docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

## Actions

### `wptelegram_login_init`

*Fires before the login process starts.*


Source: [src/shared/LoginHandler.php](../src/shared/LoginHandler.php), [line 43](../src/shared/LoginHandler.php#L43-L46)

### `wptelegram_login_pre_save_user_data`
Expand Down Expand Up @@ -131,161 +136,6 @@ Source: [src/shared/LoginHandler.php](../src/shared/LoginHandler.php), [line 634

## Filters

### `wptelegram_login_intercept_request_on`

*Filter the hook and priority to use for intercepting the login request.*

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

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$hook_and_priority` | `array` | The hook and priority.

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)

### `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 128](../src/shared/Shared.php#L128-L137)

### `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 157](../src/shared/Shared.php#L157-L166)

### `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 221](../src/shared/Shared.php#L221-L229)

### `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 235](../src/shared/Shared.php#L235-L251)

### `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 312](../src/shared/Shared.php#L312-L323)

### `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 357](../src/shared/Shared.php#L357-L364)

### `wptelegram_login_validation_query_params`

*Filter the validation query parameters that the plugin uses.*
Expand Down Expand Up @@ -396,7 +246,7 @@ Source: [src/shared/LoginHandler.php](../src/shared/LoginHandler.php), [line 383

### `wptelegram_login_disable_signup`

*Filter whether to disable sign up via Telegram!!*
*Filters whether to disable sign up via Telegram.*

It means that the user must first create an account and connect it to Telegram to be able to use Telegram Login.

Expand Down Expand Up @@ -491,6 +341,120 @@ Argument | Type | Description

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

### `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 128](../src/shared/Shared.php#L128-L137)

### `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 157](../src/shared/Shared.php#L157-L166)

### `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 221](../src/shared/Shared.php#L221-L229)

### `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 235](../src/shared/Shared.php#L235-L251)

### `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 312](../src/shared/Shared.php#L312-L323)

### `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 357](../src/shared/Shared.php#L357-L364)

### `widget_title`

*Filters the widget title.*
Expand All @@ -511,6 +475,47 @@ Version | Description

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

### `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)

### `wptelegram_login_intercept_request_on`

*Filter the hook and priority to use for intercepting the login request.*

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

**Arguments**

Argument | Type | Description
-------- | ---- | -----------
`$hook_and_priority` | `array` | The hook and priority.

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


<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>

8 changes: 8 additions & 0 deletions plugins/wptelegram-widget/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 2.1.20

### Patch Changes

- [#110](https://github.com/wpsocio/wp-projects/pull/110) [`e2a689c`](https://github.com/wpsocio/wp-projects/commit/e2a689c152f4ea0d377544b75912831f88e4451e) Thanks [@irshadahmad21](https://github.com/irshadahmad21)! - Fixed the deprecation warning for `FocusableIframe`

- [#110](https://github.com/wpsocio/wp-projects/pull/110) [`e2a689c`](https://github.com/wpsocio/wp-projects/commit/e2a689c152f4ea0d377544b75912831f88e4451e) Thanks [@irshadahmad21](https://github.com/irshadahmad21)! - Fixed the single post widget styles in post editor

## 2.1.19

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion plugins/wptelegram-widget/README.md
View file
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.4.3
**Stable tag:** 2.1.19
**Stable tag:** 2.1.20
**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
Loading

0 comments on commit f604626

Please sign in to comment.