*/ class LP_Jwt_Users_V1_Controller extends LP_REST_Jwt_Controller { protected $namespace = 'learnpress/v1'; protected $rest_base = 'users'; protected $hierarchical = true; protected $meta; public function __construct() { $this->meta = new WP_REST_User_Meta_Fields(); } public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base, array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_items' ), 'permission_callback' => array( $this, 'get_items_permissions_check' ), 'args' => $this->get_collection_params(), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P[\d]+)', array( 'args' => array( 'id' => array( 'description' => esc_html__( 'A unique identifier for the resource.', 'learnpress' ), 'type' => 'integer', ), ), array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), 'args' => array( 'context' => $this->get_context_param( array( 'default' => 'view', ) ), ), ), array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'update_item' ), 'permission_callback' => array( $this, 'update_item_permissions_check' ), 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/reset-password', array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'reset_password' ), 'permission_callback' => '__return_true', 'args' => array( 'user_login' => array( 'description' => esc_html__( 'User or Email login.', 'learnpress' ), 'type' => 'string', 'required' => true, ), ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/change-password', array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'change_password' ), 'permission_callback' => array( $this, 'update_item_password_permissions' ), 'args' => array( 'old_password' => array( 'description' => esc_html__( 'Old Password', 'learnpress' ), 'type' => 'string', 'required' => true, ), 'new_password' => array( 'description' => esc_html__( 'New Password', 'learnpress' ), 'type' => 'string', 'required' => true, ), ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/delete', array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'delete_account' ), 'permission_callback' => array( $this, 'update_item_password_permissions' ), 'args' => array( 'id' => array( 'description' => esc_html__( 'User ID', 'learnpress' ), 'type' => 'integer', 'required' => true, ), 'password' => array( 'description' => esc_html__( 'Password', 'learnpress' ), 'type' => 'string', 'required' => true, ), ), ) ); } public function get_items_permissions_check( $request ) { return true; } public function get_item_permissions_check( $request ) { $user = $this->get_user( $request['id'] ); if ( is_wp_error( $user ) ) { return $user; } if ( ! is_user_logged_in() ) { return new WP_Error( 'rest_forbidden', __( 'Authentication required to access user information.' ), array( 'status' => rest_authorization_required_code() ) ); } $types = get_post_types( array( 'show_in_rest' => true ), 'names' ); if ( get_current_user_id() === $user->ID ) { return true; } elseif ( ! current_user_can( UserModel::ROLE_ADMINISTRATOR ) ) { return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to list users.' ), array( 'status' => rest_authorization_required_code() ) ); } return true; } /** * Checks if a given request has access to update a user. * * @since 4.7.0 * * @param WP_REST_Request $request Full details about the request. * @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise. */ public function update_item_permissions_check( $request ) { $user = $this->get_user( $request['id'] ); if ( is_wp_error( $user ) ) { return $user; } if ( ! empty( $request['roles'] ) ) { if ( ! current_user_can( 'promote_user', $user->ID ) ) { return new WP_Error( 'rest_cannot_edit_roles', __( 'Sorry, you are not allowed to edit roles of this user.' ), array( 'status' => rest_authorization_required_code() ) ); } $request_params = array_keys( $request->get_params() ); sort( $request_params ); // If only 'id' and 'roles' are specified (we are only trying to // edit roles), then only the 'promote_user' cap is required. if ( array( 'id', 'roles' ) === $request_params ) { return true; } } if ( ! current_user_can( 'edit_user', $user->ID ) ) { return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this user.' ), array( 'status' => rest_authorization_required_code() ) ); } return true; } public function update_item_password_permissions( $request ) { $user = wp_get_current_user(); if ( ! $user ) { return new WP_Error( 'rest_cannot_update', __( 'Sorry, you are not allowed to update this user.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( ! current_user_can( 'edit_user', $user->ID ) ) { return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this user.' ), array( 'status' => rest_authorization_required_code() ) ); } return true; } /** * Determines if the current user is allowed to make the desired roles change. * * @since 4.7.0 * * @param int $user_id User ID. * @param array $roles New user roles. * @return true|WP_Error True if the current user is allowed to make the role change, * otherwise a WP_Error object. */ protected function check_role_update( $user_id, $roles ) { global $wp_roles; foreach ( $roles as $role ) { if ( ! isset( $wp_roles->role_objects[ $role ] ) ) { return new WP_Error( 'rest_user_invalid_role', /* translators: %s: Role key. */ sprintf( __( 'The role %s does not exist.' ), $role ), array( 'status' => 400 ) ); } $potential_role = $wp_roles->role_objects[ $role ]; /* * Don't let anyone with 'edit_users' (admins) edit their own role to something without it. * Multisite super admins can freely edit their blog roles -- they possess all caps. */ if ( ! ( is_multisite() && current_user_can( 'manage_sites' ) ) && get_current_user_id() === $user_id && ! $potential_role->has_cap( 'edit_users' ) ) { return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give users that role.' ), array( 'status' => rest_authorization_required_code() ) ); } // Include user admin functions to get access to get_editable_roles(). require_once ABSPATH . 'wp-admin/includes/user.php'; // The new role must be editable by the logged-in user. $editable_roles = get_editable_roles(); if ( empty( $editable_roles[ $role ] ) ) { return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give users that role.' ), array( 'status' => 403 ) ); } } return true; } public function reset_password( $request ) { $user_login = $request['user_login']; $reset = LP_Forms_Handler::retrieve_password( $user_login ); if ( is_wp_error( $reset ) ) { return $reset; } else { return rest_ensure_response( array( 'code' => 'success', 'message' => esc_html__( 'A link to reset your password has been emailed to you.', 'learnpress' ), ) ); } } public function delete_account( $request ) { $user_id = $request['id']; $password = $request['password']; $user = wp_get_current_user(); if ( ! $user || $user_id !== $user->ID ) { return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.', 'learnpress' ), array( 'status' => 400 ) ); } if ( ! wp_check_password( $password, $user->data->user_pass, $user->ID ) ) { return new WP_Error( 'rest_user_invalid_password', __( 'Invalid password.', 'learnpress' ), array( 'status' => 400 ) ); } if ( ! function_exists( 'wp_delete_user' ) ) { require_once ABSPATH . 'wp-admin/includes/user.php'; } $delete = wp_delete_user( $user_id ); if ( is_wp_error( $delete ) ) { return $delete; } else { return rest_ensure_response( array( 'code' => 'success', 'message' => esc_html__( 'Your account has been deleted.', 'learnpress' ), ) ); } } public function change_password( $request ) { $old_password = $request['old_password']; $new_password = $request['new_password']; $user = wp_get_current_user(); if ( ! $user || ! $user->ID || ( empty( $old_password ) || empty( $new_password ) ) ) { return new WP_Error( 'rest_user_cannot_change_password', __( 'Sorry, you are not allowed to change password.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( ! wp_check_password( $old_password, $user->user_pass, $user->ID ) ) { return new WP_Error( 'rest_user_incorrect_password', __( 'Your current password is incorrect.' ), array( 'status' => 403 ) ); } if ( apply_filters( 'learnpress_rest_api_user_change_password', true, $user ) ) { wp_set_password( $new_password, $user->ID ); } else { return new WP_Error( 'rest_user_cannot_change_password', __( 'Sorry, you are not allowed to change password.' ), array( 'status' => rest_authorization_required_code() ) ); } return rest_ensure_response( array( 'code' => 'success', 'message' => esc_html__( 'Your password has been updated. Please log in again to continue!', 'learnpress' ), ) ); } protected function get_user( $id ) { $error = new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) ); if ( (int) $id <= 0 ) { return $error; } $user = get_userdata( (int) $id ); if ( empty( $user ) || ! $user->exists() ) { return $error; } if ( is_multisite() && ! is_user_member_of_blog( $user->ID ) ) { return $error; } return $user; } /** * Updates a single user. * * @param WP_REST_Request $request Full details about the request. * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. */ public function update_item( $request ) { $user = $this->get_user( $request['id'] ); if ( is_wp_error( $user ) ) { return $user; } $id = $user->ID; if ( ! $user ) { return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) ); } $owner_id = email_exists( $request['email'] ); if ( $owner_id && $owner_id !== $id ) { return new WP_Error( 'rest_user_invalid_email', __( 'Invalid email address.' ), array( 'status' => 400 ) ); } if ( ! empty( $request['username'] ) && $request['username'] !== $user->user_login ) { return new WP_Error( 'rest_user_invalid_argument', __( "Username isn't editable." ), array( 'status' => 400 ) ); } if ( ! empty( $request['slug'] ) && $request['slug'] !== $user->user_nicename && get_user_by( 'slug', $request['slug'] ) ) { return new WP_Error( 'rest_user_invalid_slug', __( 'Invalid slug.' ), array( 'status' => 400 ) ); } if ( ! empty( $request['roles'] ) ) { $check_permission = $this->check_role_update( $id, $request['roles'] ); if ( is_wp_error( $check_permission ) ) { return $check_permission; } } $user = $this->prepare_item_for_database( $request ); // Ensure we're operating on the same user we already checked. $user->ID = $id; $user_id = wp_update_user( wp_slash( (array) $user ) ); if ( is_wp_error( $user_id ) ) { return $user_id; } $files = $request->get_file_params(); if ( ! empty( $files['lp_avatar_file'] ) ) { $file = $files['lp_avatar_file']; if ( ! empty( $file['name'] ) ) { list($width, $height) = getimagesize( $file['tmp_name'] ); $upload_size = learn_press_get_avatar_thumb_size(); if ( $width != $upload_size['width'] || $height != $upload_size['height'] ) { return new WP_Error( 'rest_user_invalid_avatar_dimensions', sprintf( __( 'Invalid avatar dimensions. Please upload a new avatar width size %1$1sx%2$2s' ), $upload_size['width'], $upload_size['height'] ), array( 'status' => 400 ) ); } $data = LP_WP_Filesystem::instance()->file_get_contents( $file['tmp_name'] ); $base64 = base64_encode( $data ); $controller = new LP_REST_Profile_Controller(); $request->set_param( 'file', $base64 ); $uploaded_avatar = $controller->upload_avatar( $request ); } } if ( ! empty( $request['avatar_url'] ) ) { $controller = new LP_REST_Profile_Controller(); $request->set_param( 'file', $request['avatar_url'] ); $uploaded_avatar = $controller->upload_avatar( $request ); } $user = get_user_by( 'id', $user_id ); do_action( 'lp_rest_insert_user', $user, $request, false ); if ( ! empty( $request['roles'] ) ) { array_map( array( $user, 'add_role' ), $request['roles'] ); } $schema = $this->get_item_schema(); if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) { $meta_update = $this->meta->update_value( $request['meta'], $user_id ); if ( is_wp_error( $meta_update ) ) { return $meta_update; } } $user = get_user_by( 'id', $user_id ); $fields_update = $this->update_additional_fields_for_object( $user, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $request->set_param( 'context', 'edit' ); do_action( 'lp_rest_after_insert_user', $user, $request, false ); $response = $this->prepare_item_for_response( $user, $request ); $response = rest_ensure_response( $response ); return $response; } /** * Prepares a single user for creation or update. * * @param WP_REST_Request $request Request object. * @return object User object. */ protected function prepare_item_for_database( $request ) { $prepared_user = new stdClass(); $schema = $this->get_item_schema(); // Required arguments. if ( isset( $request['email'] ) && ! empty( $schema['properties']['email'] ) ) { $prepared_user->user_email = $request['email']; } if ( isset( $request['username'] ) && ! empty( $schema['properties']['username'] ) ) { $prepared_user->user_login = $request['username']; } if ( isset( $request['password'] ) && ! empty( $schema['properties']['password'] ) ) { $prepared_user->user_pass = $request['password']; } // Optional arguments. if ( isset( $request['id'] ) ) { $prepared_user->ID = absint( $request['id'] ); } if ( isset( $request['name'] ) && ! empty( $schema['properties']['name'] ) ) { $prepared_user->display_name = $request['name']; } if ( isset( $request['first_name'] ) && ! empty( $schema['properties']['first_name'] ) ) { $prepared_user->first_name = $request['first_name']; } if ( isset( $request['last_name'] ) && ! empty( $schema['properties']['last_name'] ) ) { $prepared_user->last_name = $request['last_name']; } if ( isset( $request['nickname'] ) && ! empty( $schema['properties']['nickname'] ) ) { $prepared_user->nickname = $request['nickname']; } if ( isset( $request['slug'] ) && ! empty( $schema['properties']['slug'] ) ) { $prepared_user->user_nicename = $request['slug']; } if ( isset( $request['description'] ) && ! empty( $schema['properties']['description'] ) ) { $prepared_user->description = $request['description']; } if ( isset( $request['url'] ) && ! empty( $schema['properties']['url'] ) ) { $prepared_user->user_url = $request['url']; } if ( isset( $request['locale'] ) && ! empty( $schema['properties']['locale'] ) ) { $prepared_user->locale = $request['locale']; } // Setting roles will be handled outside of this function. if ( isset( $request['roles'] ) ) { $prepared_user->role = false; } /** * Filters user data before insertion via the REST API. * * @param object $prepared_user User object. * @param WP_REST_Request $request Request object. */ return apply_filters( 'lp_rest_pre_insert_user', $prepared_user, $request ); } public function get_overview_tab_contents( $user ) { $output = array(); $statistic = LP_Profile::instance( $user->get_id )->get_statistic_info(); $output['statistic'] = array_map( 'absint', $statistic ); $featured_query = new LP_Course_Query( array( 'paginate' => false, 'featured' => 'yes', 'return' => 'ids', 'author' => $user->ID, ) ); $output['featured'] = $featured_query->get_courses(); $latest_query = new LP_Course_Query( array( 'paginate' => false, 'return' => 'ids', 'author' => $user->get_id(), 'limit' => '-1', ) ); $output['latest'] = $latest_query->get_courses(); return $output; } public function get_course_tab_contents( $user, $request ) { $output = array( 'enrolled' => array(), 'created' => array(), ); $profile = learn_press_get_profile( $user->get_id() ); $filters_enrolled = array( 'all' => 'all', 'finished' => 'finished', 'passed' => 'passed', 'failed' => 'failed', 'in-progress' => 'in-progress', ); if ( method_exists( $profile, 'query_courses' ) ) { foreach ( $filters_enrolled as $key => $filter ) { $query_enrolled = $profile->query_courses( 'purchased', array( 'status' => $filter, 'limit' => $request['per_page'] ?? '100', 'paged' => $request['paged'] ?? 1, ) ); if ( empty( $query_enrolled->get_items() ) ) { continue; } $items = $query_enrolled->get_items(); $enrolled_ids = array(); foreach ( $items as $enrolled_item ) { $course_data = $user->get_course_data( $enrolled_item ); if ( $course_data ) { $post = get_post( $enrolled_item ); $enrolled_ids[] = array( 'id' => $enrolled_item ?? '', 'title' => $post->post_title, 'graduation' => ! empty( $course_data->get_graduation() ) ? $course_data->get_graduation() : '', 'status' => ! empty( $course_data->get_status() ) ? $course_data->get_status() : '', 'start_time' => lp_jwt_prepare_date_response( $course_data->get_start_time() ? $course_data->get_start_time()->toSql() : '' ), 'end_time' => lp_jwt_prepare_date_response( $course_data->get_end_time() ? $course_data->get_end_time()->toSql() : '' ), 'expiration' => lp_jwt_prepare_date_response( $course_data->get_expiration_time() ? $course_data->get_expiration_time()->toSql() : '' ), 'results' => $course_data->calculate_course_results(), ); } } $output['enrolled'][ $key ] = $enrolled_ids; } } $filters_created = array( 'all' => '', 'publish' => 'publish', 'pending' => 'pending', ); if ( method_exists( $profile, 'query_courses' ) ) { foreach ( $filters_created as $created_key => $filter ) { $query_created = $profile->query_courses( 'own', array( 'status' => $filter, 'limit' => $request['per_page'] ?? '100', 'paged' => $request['paged'] ?? 1, ) ); $created_ids = array(); if ( ! empty( $query_created->get_items() ) ) { foreach ( $query_created->get_items() as $created_item ) { $created_ids[] = $created_item; } } $output['created'][ $created_key ] = array_map( 'absint', $created_ids ); } } return $output; } /** * Get Profile Quiz Tab content * * @param [type] $request * @return void * * @author Nhamdv */ public function get_quiz_tab_contents( $user, $request ) { $output = array(); $user_profile = learn_press_get_user( $request['id'] ); $filters = array( 'all' => '', 'finished' => 'completed', 'passed' => 'passed', 'failed' => 'failed', 'in-progress' => 'in-progress', ); if ( method_exists( $user_profile, 'get_user_quizzes' ) ) { foreach ( $filters as $key => $quiz_filter ) { $filter = new LP_User_Items_Filter(); $filter->user_id = $request['id']; $filter->limit = 100; $filter->status = $quiz_filter === 'complete' ? 'complete' : ''; $filter->graduation = $quiz_filter !== 'complete' ? $quiz_filter : ''; $query = $user_profile->get_user_quizzes( $filter ); $ids = array(); if ( ! empty( $query->get_items() ) ) { foreach ( $query->get_items() as $item ) { $ids[] = array( 'id' => $item->get_id(), 'result' => $item->get_percent_result() ?? '', 'graduation' => $item->get_graduation() ?? '', 'start_time' => $item->get_start_time() ? lp_jwt_prepare_date_response( $item->get_start_time()->toSql( false ) ) : '', 'end_time' => $item->get_end_time() ? lp_jwt_prepare_date_response( $item->get_end_time()->toSql( false ) ) : '', 'data' => $filter !== 'in-progress' ? $item->calculate_quiz_result() : array(), 'attempt' => $filter !== 'in-progress' ? $item->get_attempts() : array(), ); } } $output[ $key ] = $ids; } } return $output; } /** * Get order by user id * * @param array $request [id: user ID] * @return array * * @author Nhamdv */ public function get_order_content_tab( $user, $request ) { $output = array(); $profile = learn_press_get_profile( $request['id'] ); if ( method_exists( $profile, 'query_orders' ) ) { $query_orders = $profile->query_orders( array( 'fields' => 'ids' ) ); if ( ! empty( $query_orders->get_items() ) ) { foreach ( $query_orders->get_items() as $order_id ) { $order = learn_press_get_order( $order_id ); $output[ $order_id ] = array( 'order_key' => $order->get_order_number() ?? '', 'total' => $order->get_total(), 'currency' => $order->get_currency(), 'status' => $order->get_status(), 'date' => $order->get_order_date( 'timestamp' ) ? lp_jwt_prepare_date_response( get_date_from_gmt( gmdate( 'Y-m-d H:i:s', $order->get_order_date( 'timestamp' ) ), 'Y-m-d H:i:s' ) ) : '', ); } } } return $output; } /** * Retrieves a single user. * * @since 4.7.0 * * @param WP_REST_Request $request Full details about the request. * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. */ public function get_item( $request ) { $user = $this->get_user( $request['id'] ); if ( is_wp_error( $user ) ) { return $user; } $user = $this->prepare_item_for_response( $user, $request ); $response = rest_ensure_response( $user ); return $response; } /** * Retrieves all users. * * @since 4.7.0 * * @param WP_REST_Request $request Full details about the request. * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. */ public function get_items( $request ) { // Fixed security, with request ?context=edit if ( isset( $_REQUEST['context'] ) ) { die(); } // Retrieve the list of registered collection query parameters. $registered = $this->get_collection_params(); /* * This array defines mappings between public API query parameters whose * values are accepted as-passed, and their internal WP_Query parameter * name equivalents (some are the same). Only values which are also * present in $registered will be set. */ $parameter_mappings = array( 'exclude' => 'exclude', 'include' => 'include', 'order' => 'order', 'per_page' => 'number', 'search' => 'search', 'roles' => 'role__in', 'slug' => 'nicename__in', ); $roles = $request->get_param( 'roles' ); if ( ! empty( $roles ) && $roles == [ UserModel::ROLE_ADMINISTRATOR ] ) { return new WP_Error( 'rest_forbidden', __( 'You are not allowed.' ), array( 'status' => rest_authorization_required_code() ) ); } // Always only get instructors and administrators. $request['roles'] = [ UserModel::ROLE_INSTRUCTOR, UserModel::ROLE_ADMINISTRATOR ]; $prepared_args = array(); /* * For each known parameter which is both registered and present in the request, * set the parameter's value on the query $prepared_args. */ foreach ( $parameter_mappings as $api_param => $wp_param ) { if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) { $prepared_args[ $wp_param ] = $request[ $api_param ]; } } if ( isset( $registered['offset'] ) && ! empty( $request['offset'] ) ) { $prepared_args['offset'] = $request['offset']; } else { $prepared_args['offset'] = ( $request['page'] - 1 ) * $prepared_args['number']; } if ( isset( $registered['orderby'] ) ) { $orderby_possibles = array( 'id' => 'ID', 'include' => 'include', 'name' => 'display_name', 'registered_date' => 'registered', 'slug' => 'user_nicename', 'include_slugs' => 'nicename__in', 'email' => 'user_email', 'url' => 'user_url', ); $prepared_args['orderby'] = $orderby_possibles[ $request['orderby'] ]; } if ( isset( $registered['who'] ) && ! empty( $request['who'] ) && 'authors' === $request['who'] ) { $prepared_args['who'] = 'authors'; } if ( ! empty( $prepared_args['search'] ) ) { $prepared_args['search'] = '*' . $prepared_args['search'] . '*'; } /** * Filters WP_User_Query arguments when querying users via the REST API. * * @link https://developer.wordpress.org/reference/classes/wp_user_query/ * * @since 4.7.0 * * @param array $prepared_args Array of arguments for WP_User_Query. * @param WP_REST_Request $request The REST API request. */ $prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request ); $users = array(); $lp_cache = new LP_Cache(); $key_cache_list_instructors = 'lp_get_instructors'; // Check cache with cache get instructors. if ( isset( $prepared_args['role__in'] ) ) { $users = $lp_cache->get_cache( $key_cache_list_instructors ); $total_users = $lp_cache->get_cache( $key_cache_list_instructors . '/total' ); } if ( $users === false ) { // Query max 10 instructors only. $prepared_args['number'] = 10; $query = new WP_User_Query( $prepared_args ); $users_result = $query->get_results(); $total_users = $query->get_total(); foreach ( $users_result as $user ) { $data = $this->prepare_item_for_response( $user, $request ); $user = $this->prepare_response_for_collection( $data ); unset( $user['custom_register'] ); unset( $user['is_super_admin'] ); $users[] = $user; } // Set cache with cache get instructors. $lp_cache->set_cache( $key_cache_list_instructors, $users ); $lp_cache->set_cache( $key_cache_list_instructors . '/total', $total_users ); } $response = rest_ensure_response( $users ); // Store pagination values for headers then unset for count query. $per_page = (int) $prepared_args['number']; $page = ceil( ( ( (int) $prepared_args['offset'] ) / $per_page ) + 1 ); $prepared_args['fields'] = 'ID'; if ( $total_users < 1 ) { // Out-of-bounds, run the query again without LIMIT for total count. unset( $prepared_args['number'], $prepared_args['offset'] ); $count_query = new WP_User_Query( $prepared_args ); $total_users = $count_query->get_total(); } $response->header( 'X-WP-Total', (int) $total_users ); $max_pages = ceil( $total_users / $per_page ); $response->header( 'X-WP-TotalPages', (int) $max_pages ); $base = add_query_arg( urlencode_deep( $request->get_query_params() ), rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ) ); if ( $page > 1 ) { $prev_page = $page - 1; if ( $prev_page > $max_pages ) { $prev_page = $max_pages; } $prev_link = add_query_arg( 'page', $prev_page, $base ); $response->link_header( 'prev', $prev_link ); } if ( $max_pages > $page ) { $next_page = $page + 1; $next_link = add_query_arg( 'page', $next_page, $base ); $response->link_header( 'next', $next_link ); } return $response; } /** * Prepares a single user output for response. * * @since 4.7.0 * * @param WP_User $user User object. * @param WP_REST_Request $request Request object. * @return WP_REST_Response Response object. */ public function prepare_item_for_response( $user, $request ) { $context = ! empty( $request['context'] ) ? $request['context'] : 'embed'; $data = $this->get_users_data( $user, $context, $request ); $data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->filter_response_by_context( $data, $context ); // Wrap the data in a response object. $response = rest_ensure_response( $data ); $response->add_links( $this->prepare_links( $user ) ); return apply_filters( 'lp_rest_prepare_user', $response, $user, $request ); } public function get_users_data( $user, $context = 'view' ) { $request = func_num_args() >= 2 ? func_get_arg( 2 ) : new WP_REST_Request( '', '', array( 'context' => $context ) ); $fields = $this->get_fields_for_response( $request ); $data = array(); foreach ( $fields as $field ) { switch ( $field ) { case 'id': $data['id'] = $user->ID; break; case 'username': if ( current_user_can( 'list_users' ) || current_user_can( 'edit_user', $user->ID ) ) { $data['username'] = $user->user_login; } break; case 'name': $data['name'] = $user->display_name; break; case 'first_name': $data['first_name'] = $user->first_name; break; case 'last_name': $data['last_name'] = $user->last_name; break; case 'email': if ( current_user_can( 'list_users' ) || current_user_can( 'edit_user', $user->ID ) ) { $data['email'] = $user->user_email; } break; case 'url': $data['url'] = $user->user_url; break; case 'description': $data['description'] = $user->description; break; case 'link': $data['link'] = get_author_posts_url( $user->ID, $user->user_nicename ); break; case 'locale': $data['locale'] = get_user_locale( $user ); break; case 'nickname': $data['nickname'] = $user->nickname; break; case 'slug': $data['slug'] = $user->user_nicename; break; case 'roles': $data['roles'] = array_values( $user->roles ); break; case 'registered_date': $data['registered_date'] = gmdate( 'c', strtotime( $user->user_registered ) ); break; case 'capabilities': $data['capabilities'] = (object) $user->allcaps; break; case 'extra_capabilities': $data['extra_capabilities'] = (object) $user->caps; break; case 'avatar_url': $data['avatar_url'] = $this->get_profile_avatar( $user->ID ); break; case 'avatar_size': $data['avatar_size']['width'] = learn_press_get_avatar_thumb_size()['width']; $data['avatar_size']['height'] = learn_press_get_avatar_thumb_size()['height']; break; case 'instructor_data': // $data['instructor_data'] = $this->get_instructor_data( $user->ID ); $data['instructor_data'] = LP_Profile::instance( $user->ID )->get_statistic_info(); break; case 'meta': $data['meta'] = $this->meta->get_value( $user->ID, $request ); break; case 'tabs': $data['tabs'] = $this->get_lp_data_tabs( $user, $request ); break; case 'custom_register': $data['custom_register'] = $this->custom_register( $user ); break; case 'social': $data['social'] = $this->get_social_data( $user->ID ); break; } } return $data; } public function get_social_data( $user_id ) { return learn_press_get_user_extra_profile_info( $user_id ); } /** * @since 4.1.4 * @version 1.0.1 */ public function get_profile_avatar( $user_id ): string { $user = learn_press_get_user( $user_id ); return $user->get_profile_avatar_url(); } /** * @editor tungnx * @deprecated 4.1.6 */ /* public function get_instructor_data( $user_id ) { $profile = learn_press_get_profile( $user_id ); $output = array(); if ( is_wp_error( $profile ) ) { return $output; } $query = $profile->query_courses( 'purchased' ); $counts = $query['counts']; $output = array( 'enrolled_courses' => isset( $counts['all'] ) ? absint( $counts['all'] ) : 0, 'completed_courses' => isset( $counts['finished'] ) ? absint( $counts['finished'] ) : 0, 'courses' => absint( count_user_posts( $user_id, LP_COURSE_CPT ) ), 'students' => absint( learn_press_count_instructor_users( $user_id ) ), ); return $output; }*/ /** * Get data tabs. * * @param $user * @param $request * * @return array */ public function get_lp_data_tabs( $user, $request ): array { $output = array(); if ( get_current_user_id() === $user->ID || current_user_can( 'list_users' ) ) { if ( function_exists( 'learn_press_get_user_profile_tabs' ) ) { $tabs = learn_press_get_user_profile_tabs(); $content = array( 'overview' => $this->get_overview_tab_contents( $user ), 'courses' => $this->get_course_tab_contents( $user, $request ), 'quizzes' => $this->get_quiz_tab_contents( $user, $request ), 'orders' => $this->get_order_content_tab( $user, $request ), ); /** * @var LP_Profile_Tab $tab */ foreach ( $tabs->get() as $key => $tab ) { $output[ $key ] = array( 'title' => $tab->get( 'title' ) ?? '', 'slug' => $tab->get( 'slug' ) ?? '', 'priority' => $tab->get( 'priority' ) ?? '', 'icon' => $tab->get( 'icon' ) ?? '', 'content' => $content[ $key ] ?? '', ); if ( ! empty( $tab->get( 'sections' ) ) ) { foreach ( $tab->get( 'sections' ) as $section_key => $section ) { $output[ $key ]['section'][ $section_key ] = array( 'title' => $section['title'] ?? '', 'slug' => $section['slug'] ?? '', 'priority' => $section['priority'] ?? '', ); } } } } } return $output; } /** * Display register cutom form in LearnPress Setting * * @param object $user * @return array */ public function custom_register( $user ) { $output = array(); if ( function_exists( 'lp_get_user_custom_register_fields' ) ) { $custom_fields = LP_Profile::get_register_fields_custom(); $custom_profile = lp_get_user_custom_register_fields( $user->ID ); if ( $custom_fields ) { foreach ( $custom_fields as $field ) { $value = $field['id']; $output[ $value ] = array( 'title' => $field['name'] ?? '', 'type' => $field['type'] ?? '', 'required' => $field['required'] ?? 'no', 'value' => $custom_profile[ $value ] ?? '', ); } } } return $output; } /** * Prepares links for the user request. * * @since 4.7.0 * * @param WP_User $user User object. * @return array Links for the given user. */ protected function prepare_links( $user ) { $links = array( 'self' => array( 'href' => rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $user->ID ) ), ), 'collection' => array( 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), ), ); return $links; } public function check_username( $value, $request, $param ) { $username = (string) $value; if ( ! validate_username( $username ) ) { return new WP_Error( 'rest_user_invalid_username', __( 'This username is invalid because it uses illegal characters. Please enter a valid username.' ), array( 'status' => 400 ) ); } /** This filter is documented in wp-includes/user.php */ $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); if ( in_array( strtolower( $username ), array_map( 'strtolower', $illegal_logins ), true ) ) { return new WP_Error( 'rest_user_invalid_username', __( 'Sorry, that username is not allowed.' ), array( 'status' => 400 ) ); } return $username; } /** * Check a user password for the REST API. * * Performs a couple of checks like edit_user() in wp-admin/includes/user.php. * * @since 4.7.0 * * @param string $value The password submitted in the request. * @param WP_REST_Request $request Full details about the request. * @param string $param The parameter name. * @return string|WP_Error The sanitized password, if valid, otherwise an error. */ public function check_user_password( $value, $request, $param ) { $password = (string) $value; if ( empty( $password ) ) { return new WP_Error( 'rest_user_invalid_password', __( 'Passwords cannot be empty.' ), array( 'status' => 400 ) ); } if ( false !== strpos( $password, '\\' ) ) { return new WP_Error( 'rest_user_invalid_password', sprintf( /* translators: %s: The '\' character. */ __( 'Passwords cannot contain the "%s" character.' ), '\\' ), array( 'status' => 400 ) ); } return $password; } public function get_item_schema() { $schema = array( '$schema' => 'http://json-schema.org/draft-04/schema#', 'title' => 'user', 'type' => 'object', 'properties' => array( 'id' => array( 'description' => __( 'Unique identifier for the user.' ), 'type' => 'integer', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), 'username' => array( 'description' => __( 'Login name for the user.' ), 'type' => 'string', 'context' => array( 'view', 'edit' ), 'required' => true, 'arg_options' => array( 'sanitize_callback' => array( $this, 'check_username' ), ), ), 'name' => array( 'description' => __( 'Display name for the user.' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'first_name' => array( 'description' => __( 'First name for the user.' ), 'type' => 'string', 'context' => array( 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'last_name' => array( 'description' => __( 'Last name for the user.' ), 'type' => 'string', 'context' => array( 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'email' => array( 'description' => __( 'The email address for the user.' ), 'type' => 'string', 'format' => 'email', 'context' => array( 'view', 'edit' ), 'required' => true, ), 'url' => array( 'description' => __( 'URL of the user.' ), 'type' => 'string', 'format' => 'uri', 'context' => array( 'embed', 'view', 'edit' ), ), 'description' => array( 'description' => __( 'Description of the user.' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), ), 'link' => array( 'description' => __( 'Author URL of the user.' ), 'type' => 'string', 'format' => 'uri', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), 'locale' => array( 'description' => __( 'Locale for the user.' ), 'type' => 'string', 'enum' => array_merge( array( '', 'en_US' ), get_available_languages() ), 'context' => array( 'edit' ), ), 'nickname' => array( 'description' => __( 'The nickname for the user.' ), 'type' => 'string', 'context' => array( 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'slug' => array( 'description' => __( 'An alphanumeric identifier for the user.' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => array( $this, 'sanitize_slug' ), ), ), 'registered_date' => array( 'description' => __( 'Registration date for the user.' ), 'type' => 'string', 'format' => 'date-time', 'context' => array( 'edit' ), 'readonly' => true, ), 'roles' => array( 'description' => __( 'Roles assigned to the user.' ), 'type' => 'array', 'items' => array( 'type' => 'string', ), 'context' => array( 'edit' ), ), 'password' => array( 'description' => __( 'Password for the user (never included).' ), 'type' => 'string', 'context' => array(), // Password is never displayed. 'required' => true, 'arg_options' => array( 'sanitize_callback' => array( $this, 'check_user_password' ), ), ), 'capabilities' => array( 'description' => __( 'All capabilities assigned to the user.' ), 'type' => 'object', 'context' => array( 'edit' ), 'readonly' => true, ), 'extra_capabilities' => array( 'description' => __( 'Any extra capabilities assigned to the user.' ), 'type' => 'object', 'context' => array( 'edit' ), 'readonly' => true, ), 'tabs' => array( 'description' => __( 'Get all items in user like course, lesson, quiz...' ), 'type' => 'array', 'context' => array( 'view' ), ), 'avatar_url' => array( 'description' => __( 'URL avatar' ), 'type' => 'string', 'context' => array( 'view', 'edit' ), ), 'avatar_size' => array( 'description' => __( 'URL avatar size' ), 'type' => 'array', 'context' => array( 'view' ), ), 'instructor_data' => array( 'description' => __( 'Instructor data' ), 'type' => 'array', 'context' => array( 'view' ), ), 'custom_register' => array( 'description' => __( 'Get custom register fields.' ), 'type' => 'object', 'context' => array( 'view' ), ), 'social' => array( 'description' => __( 'Get social fields.' ), 'type' => 'object', 'context' => array( 'view' ), ), ), ); $schema['properties']['meta'] = $this->meta->get_field_schema(); return $this->add_additional_fields_schema( $schema ); } public function get_collection_params() { $query_params = parent::get_collection_params(); $query_params['context']['default'] = 'view'; $query_params['exclude'] = array( 'description' => __( 'Ensure the result set excludes specific IDs.' ), 'type' => 'array', 'items' => array( 'type' => 'integer', ), 'default' => array(), ); $query_params['include'] = array( 'description' => __( 'Limit the result set to specific IDs.' ), 'type' => 'array', 'items' => array( 'type' => 'integer', ), 'default' => array(), ); $query_params['offset'] = array( 'description' => __( 'Offset the result set by a specific number of items.' ), 'type' => 'integer', ); $query_params['order'] = array( 'default' => 'asc', 'description' => __( 'Sorting attributes in ascending or descending order.' ), 'enum' => array( 'asc', 'desc' ), 'type' => 'string', ); $query_params['orderby'] = array( 'default' => 'name', 'description' => __( 'Sort collections by the object attribute.' ), 'enum' => array( 'id', 'include', 'name', 'registered_date', 'slug', 'include_slugs', 'email', 'url', ), 'type' => 'string', ); $query_params['slug'] = array( 'description' => __( 'Limit result set to users with one or more specific slugs.' ), 'type' => 'array', 'items' => array( 'type' => 'string', ), ); $query_params['roles'] = array( 'description' => __( 'Limit result set to users matching at least one specific role provided. Accepts csv list or single role.' ), 'type' => 'array', 'items' => array( 'type' => 'string', ), ); $query_params['who'] = array( 'description' => __( 'Limit result set to users who are considered authors.' ), 'type' => 'string', 'enum' => array( 'authors', ), ); /** * Filters REST API collection parameters for the users controller. * * This filter registers the collection parameter, but does not map the * collection parameter to an internal WP_User_Query parameter. Use the * `rest_user_query` filter to set WP_User_Query arguments. * * @since 4.7.0 * * @param array $query_params JSON Schema-formatted collection parameters. */ return apply_filters( 'rest_user_collection_params', $query_params ); } }