Changeset 2908629

Timestamp:

05/05/2023 04:11:25 PM (3 years ago)

Author:

deryck

Message:

Added last_login as a filter parameter in user endpoint.

Location:

user-toolkit/trunk

Files:

• README.txt (modified) (5 diffs)
• src/RestEndpoints.php (modified) (2 diffs)
• user-toolkit.php (modified) (1 diff)

user-toolkit/trunk/README.txt

@@ -4 +4 @@
 Tags: user profile, last login, disable user, registration date
 Requires at least: 5.9.5
-Tested up to: 6.1
+Tested up to: 6.2
 Requires PHP: 7.3
-Stable tag: 1.2
+Stable tag: 1.2.1
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
@@ -31 +31 @@
 Full support for administration over SSL (if applicable).
 
+** REST API Support **
+
+The field last_login is included as a result in endpoint wp/v2/users/.
+Filtering the endpoint wp/v2/users/ using parameter last_login is also supported.
+
 ## USAGE
 
@@ -52 +57 @@
 2. Disable all or any column clicking "Screen Options" on the right top corner of the screen.
 
+** Retrieve Last Login info using REST API **
+
+1. Get last_login field with ISO 8601 form on endpoint wp/v2/users/
+2. Filter using parameter last_login using the following options wp/v2/users/?last_login=FROM,[TO:optional] using ISO 8601 or Y-m-d format.
 
 ## PRIVACY STATEMENT
@@ -84 +93 @@
 
 == Changelog ==
+
+= 1.2.1 =
+* Added last_login as a filter parameter in user endpoint.
 
 = 1.2 =
@@ -122 +134 @@
 == Upgrade Notice ==
 
+= 1.2.1 =
+* Added last_login as a filter parameter in user endpoint.
+
 = 1.2 =
 * Last Login date is now filterable in User List

user-toolkit/trunk/src/RestEndpoints.php

@@ -12 +12 @@
         add_action( 'rest_api_init', [ $this, 'registerCanLoginField' ] );
         add_action( 'rest_api_init', [ $this, 'registerLastLoginField' ] );
+        add_filter( 'rest_user_collection_params', [ $this, 'registerParams' ] );
+        add_filter( 'rest_user_query', [ $this, 'filterByParams' ], 10, 2 );
     }
 
@@ -76 +78 @@
     }
 
+    public function registerParams( $params ) {
+        $params['last_login']   = [
+            'description' => 'Last login range',
+            'type'        => 'string',
+        ];
+
+        return $params;
+    }
+
+    public function filterByParams( $prepared_args, \WP_REST_Request $request ) {
+        $last_login = $request->get_param( 'last_login' );
+        if ( ! empty( $last_login ) ) {
+
+            $last_login_range = explode( ',', $last_login );
+
+            if ( count( $last_login_range ) === 1 ) {
+                $last_login_range[1] = date( 'Y-m-d\TH:i:s', strtotime( 'now' ) );
+            }
+
+            $last_login_args = array_map( function ( $date ) {
+                return strtotime( $date );
+            }, $last_login_range );
+
+            $prepared_args['meta_query'] = [
+                [
+                    'key'     => 'last_login',
+                    'value'   => $last_login_args,
+                    'compare' => 'BETWEEN',
+                ],
+            ];
+        }
+
+        return $prepared_args;
+    }
+
 
 }

user-toolkit/trunk/user-toolkit.php

@@ -9 +9 @@
  * Plugin URI:        https://deryckoe.com/user-toolkit
  * Description:       The missing user tools and activity data that you need and don't have by default.
- * Version:           1.2
+ * Version:           1.2.1
  * Author:            Deryck Oñate
  * Author URI:        http://deryckoe.com