=== Log in with Google ===
Contributors: rtCamp, sh4lin, nikhiljoshua, mchirag2002, mi5t4n
Unlinked contributors: Jeppehimer, dev-alamin
Donate link: https://rtcamp.com/
Tags: Google login, sign in, sso, oauth, authentication, sign-in, single sign-on, log in
Requires at least: 5.5
Tested up to: 6.7.2
Requires PHP: 7.4
Stable tag: 1.4.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Minimal plugin that allows WordPress users to log in using Google.

== Description ==

Ultra minimal plugin to let your users login to WordPress applications using their Google accounts. No more remembering hefty passwords!

### Initial Setup

1. Create a project from [Google Developers Console](https://console.developers.google.com/apis/dashboard) if none exists.


2. Go to **Credentials** tab, then create credential for OAuth client.
    * Application type will be **Web Application**
    * Add `YOUR_DOMAIN/wp-login.php` in **Authorized redirect URIs**


3. This will give you **Client ID** and **Secret key**.


4. Input these values either in `WP Admin > Settings > WP Google Login`, or in `wp-config.php` using the following code snippet:

```
define( 'WP_GOOGLE_LOGIN_CLIENT_ID', 'YOUR_GOOGLE_CLIENT_ID' );
define( 'WP_GOOGLE_LOGIN_SECRET', 'YOUR_SECRET_KEY' );
```

### Browser support
[These browsers are supported](https://developers.google.com/identity/gsi/web/guides/supported-browsers). Note, for example, that One Tap Login is not supported in Safari.

### How to enable automatic user registration

You can enable user registration either by
- Enabling *Settings > WP Google Login > Enable Google Login Registration*


OR


- Adding
```
define( 'WP_GOOGLE_LOGIN_USER_REGISTRATION', 'true' );
```
in wp-config.php file.

**Note:** If the checkbox is ON then, it will register valid Google users even when WordPress default setting, under

*Settings > General Settings > Membership > Anyone can register* checkbox

is OFF.

### Restrict user registration to one or more domain(s)

By default, when you enable user registration via constant `WP_GOOGLE_LOGIN_USER_REGISTRATION` or enable *Settings > WP Google Login > Enable Google Login Registration*, it will create a user for any Google login (including gmail.com users). If you are planning to use this plugin on a private, internal site, then you may like to restrict user registration to users under a single Google Suite organization. This configuration variable does that.

Add your domain name, without any schema prefix and `www,` as the value of `WP_GOOGLE_LOGIN_WHITELIST_DOMAINS` constant or in the settings `Settings > WP Google Login > Whitelisted Domains`. You can whitelist multiple domains. Please separate domains with commas. See the below example to know how to do it via constants:
```
define( 'WP_GOOGLE_LOGIN_WHITELIST_DOMAINS', 'example.com,sample.com' );
```

**Note:** If a user already exists, they **will be allowed to login with Google** regardless of whether their domain is whitelisted or not. Whitelisting will only prevent users from **registering** with email addresses from non-whitelisted domains.

### Hooks

For a list of all hooks please refer to [this documentation](https://github.com/rtCamp/login-with-google#hooks).

#### wp-config.php parameters list

* `WP_GOOGLE_LOGIN_CLIENT_ID` (string): Google client ID of your application.


* `WP_GOOGLE_LOGIN_SECRET` (string): Secret key of your application


* `WP_GOOGLE_LOGIN_USER_REGISTRATION` (boolean) (optional): Set `true` If you want to enable new user registration. By default, user registration defers to `Settings > General Settings > Membership` if constant is not set.


* `WP_GOOGLE_LOGIN_WHITELIST_DOMAINS` (string) (optional): Domain names, if you want to restrict login with your custom domain. By default, it will allow all domains. You can whitelist multiple domains.

### BTW, We're Hiring!

[<img src="https://camo.githubusercontent.com/414c21a6d0e5f71c0e3b1da4380483b1240fdf36f85942c8e24b9f020236c8d9/68747470733a2f2f727463616d702e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031392f30342f6769746875622d62616e6e65724032782e706e67" />](https://rtcamp.com/careers/)

== Installation ==

1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Follow "Setup" instructions in ReadMe to configure credentials from Google Developers Console.

== Frequently Asked Questions ==

= Reporting a bug 🐞 =

Before creating a new issue, do browse through the [existing issues](https://github.com/rtCamp/login-with-google/issues) for resolution or upcoming fixes.

If you still need to [log an issue](https://github.com/rtCamp/login-with-google/issues/new), making sure to include as much detail as you can, including clear steps to reproduce the issue, if possible.

= Creating a pull request =

Want to contribute a new feature? Start a conversation by [logging an issue](https://github.com/rtCamp/login-with-google/issues).

Once you're ready to send a pull request, please run through the following checklist:

1. Browse through the [existing issues](https://github.com/rtCamp/login-with-google/issues) for anything related to what you want to work on. If you don't find any related issues, open a new one.

2. Fork this repository.

3. Create a branch from `develop` for each issue you'd like to address and commit your changes.

4. Push the code changes from your local clone to your fork.

5. Open a pull request and that's it! We'll respond with feedback as soon as possible (Isn't collaboration a great thing? 😌)

6. Once your pull request has passed final code review and tests, it will be merged into `develop` and be in the pipeline for the next release. Props to you! 🎉

= Unit testing =

- Clone the plugin from [repository](https://github.com/rtCamp/login-with-google).

- Run `composer install && composer tests:unit` to run unit tests.

= Code Snippets =
Code snippets to extend and customize the plugin can be found [here](https://github.com/rtCamp/login-with-google/blob/develop/docs/CODE_SNIPPETS.md).

== Screenshots ==

1. Login screen with Google option added.
2. Plugin settings screen.
3. Settings within Google Developer Console.

== Changelog ==

= 1.4.1 =
Fix: Resolved the issue of redirect_to parameters not working with the shortcode.
Update: Migrated block implementation to modern block implementations.
Update: Updated Composer and NPM dependencies.
Fix: Fixed the issue of One-tap script not being enqueued if the user was logged out.
Chore: Documentation update.

= 1.4.0 =
Update: Migrated One Tap Login to use FedCM.
Update: After a successful login or logout, users are now redirected to the page they originally intended to access.
Update: When the plugin performs a redirect, it now includes an x-redirect-by header.
Update: A settings page link has been added directly under the plugin name on the Plugins screen.
Fix: Resolved an issue with generating unique usernames.
Fix: Fixed a bug where JavaScript string translations were not being applied correctly.
Chore: Documentation update.

= 1.3.7 =
* Compatible with WordPress 6.7.2

= 1.3.6 =
* Fix: PHPCS Errors and Warnings

= 1.3.5 =
* Fix: FILTER_SANITIZE_STRING Deprecation warning

= 1.3.4 =
* Chore: Doc update

= 1.3.3 =
* Fix: Redirection back to login page issue.

= 1.3.2 =
* Compatible with PHP 8.1
* Compatible with WordPress latest version 6.3.1

= 1.3.1 =
* Maintenance release: Updated minimum requirements.

= 1.3.0 =
* Feature: Gutenberg block for Login button.
* Feature: Save user first name and last name on registration.
* Add: PHP 8.0 compatibility.
* Add: Added hook after user authentication.
* Add: Added hook after user is logged-in.
* Fix: set login cookie with shortcode display.
* Fix: Redirection back to login page issue.
* Updated npm packages and laravel-mix.

= 1.2.2 =
* Maintenance release. Requires PHP >= 7.4.

= 1.2.1 =
* Feature: Provide filter for client arguments: rtcamp.google_client_args

= 1.2 =
* Feature: One-Tap Login setting for supported browsers.

= 1.1 =
* Feature: Add shortcode `[google_login]` with optional attributes: `[google_login button_text="Login with Google" force_display="no" redirect_to="https://example.url/page"]`.
* Feature: Replace third-party oAuth client with custom GoogleClient class.
* Fix: Identification of state value, whether a given oAuth login is relevant to this plugin.
* Remove: Google oAuth library from composer.

= 1.0.14 =
* Revert Login with GitHub state fix.

= 1.0.13 =
* Fix login issue related to oAuth state.

= 1.0.12 =
* Fix conflict with Login with GitHub plugin.

= 1.0.11 =
* Add 'login_with_google/client_arguments' filter for Google_Client arguments.

= 1.0.10 =
* Fix issue where JS/CSS were not loading.

= 1.0.9 =
* Initial release.

= 1.3.1 =
* Maintenance release: Updated minimum requirements.

== Upgrade Notice ==

= 1.4.1 =
Fix: Resolved the issue of redirect_to parameters not working with the shortcode.
Update: Migrated block implementation to modern block implementations.
Update: Updated Composer and NPM dependencies.
Fix: Fixed the issue of One-tap script not being enqueued if the user was logged out.
Chore: Documentation update.

= 1.4.0 =
Update: Migrated One Tap Login to use FedCM.
Update: After a successful login or logout, users are now redirected to the page they originally intended to access.
Update: When the plugin performs a redirect, it now includes an x-redirect-by header.
Update: A settings page link has been added directly under the plugin name on the Plugins screen.
Fix: Resolved an issue with generating unique usernames.
Fix: Fixed a bug where JavaScript string translations were not being applied correctly.
Chore: Documentation update.

= 1.3.7 =
* Compatible with WordPress 6.7.2

= 1.3.6 =
* Fix: PHPCS Errors and Warnings

= 1.3.5 =
* Fix: FILTER_SANITIZE_STRING Deprecation warning

= 1.3.4 =
* Fix: Redirection back to login page issue.
* Chore: Doc update

= 1.3.2 =
* Compatible with PHP 8.1 and WordPress 6.3.1