- added REST API version;

- avoid the conflicts (added prefixes for query vars);
This commit is contained in:
nikitasinelnikov
2019-04-10 15:00:13 +03:00
parent 8f60eef636
commit dcfb9b0566
7 changed files with 1721 additions and 1163 deletions
@@ -1073,6 +1073,16 @@ if ( ! class_exists( 'um\admin\core\Admin_Settings' ) ) {
'label' => __( 'Enable Gutenberg Blocks', 'ultimate-member' ),
'tooltip' => __( 'Check this box if you would like to use Ultimate Member blocks in Gutenberg editor. Important some themes have the conflicts with Gutenberg editor.', 'ultimate-member' ),
),
array(
'id' => 'rest_api_version',
'type' => 'select',
'label' => __( 'REST API version','ultimate-member' ),
'tooltip' => __( 'This controls the REST API version, we recommend to use the last version', 'ultimate-member' ),
'options' => array(
'1.0' => __( '1.0 version', 'ultimate-member' ),
'2.0' => __( '2.0 version', 'ultimate-member' ),
),
),
array(
'id' => 'uninstall_on_delete',
'type' => 'checkbox',
+2 -1
View File
@@ -535,7 +535,8 @@ if ( ! class_exists( 'um\Config' ) ) {
'profile_photo_max_size' => 999999999,
'cover_photo_max_size' => 999999999,
'custom_roles_increment' => 1,
'um_profile_object_cache_stop' => 0
'um_profile_object_cache_stop' => 0,
'rest_api_version' => '2.0'
);
$tabs = UM()->profile()->tabs_primary();
+13 -2
View File
@@ -469,6 +469,8 @@ if ( ! class_exists( 'UM' ) ) {
if ( ! get_option( 'show_avatars' ) ) {
update_option( 'show_avatars', 1 );
}
} else {
UM()->options()->update( 'rest_api_version', '1.0' );
}
if ( $version != ultimatemember_version ) {
@@ -937,11 +939,20 @@ if ( ! class_exists( 'UM' ) ) {
/**
* @since 2.0
*
* @return um\core\REST_API
* @return um\core\rest\API_v1|um\core\rest\API_v2
*/
function rest_api() {
$api_version = $this->options()->get( 'rest_api_version' );
if ( empty( $this->classes['rest_api'] ) ) {
$this->classes['rest_api'] = new um\core\REST_API();
if ( '1.0' === $api_version ) {
$this->classes['rest_api'] = new um\core\rest\API_v1();
} elseif ( '2.0' === $api_version ) {
$this->classes['rest_api'] = new um\core\rest\API_v2();
} else {
$this->classes['rest_api'] = new um\core\rest\API_v1();
}
}
return $this->classes['rest_api'];
File diff suppressed because it is too large Load Diff
+541
View File
@@ -0,0 +1,541 @@
<?php
namespace um\core\rest;
if ( ! defined( 'ABSPATH' ) ) exit;
if ( ! class_exists( 'um\core\rest\API_v1' ) ) {
/**
* Class REST_API
* @package um\core
*/
class API_v1 extends API {
/**
*
*/
const VERSION = '1.0';
/**
* REST_API constructor.
*/
public function __construct() {
parent::__construct();
add_filter( 'query_vars', array( $this, 'query_vars' ) );
}
/**
* Registers query vars for API access
*
* @param $vars
*
* @return array
*/
public function query_vars( $vars ) {
$vars[] = 'key';
$vars[] = 'token';
$vars[] = 'format';
$vars[] = 'query';
$vars[] = 'type';
$vars[] = 'data';
$vars[] = 'fields';
$vars[] = 'value';
$vars[] = 'number';
$vars[] = 'id';
$vars[] = 'email';
$vars[] = 'orderby';
$vars[] = 'order';
$vars[] = 'include';
$vars[] = 'exclude';
$this->vars = $vars;
return $vars;
}
/**
* Validate the API request
*/
protected function validate_request() {
global $wp_query;
$this->override = false;
// Make sure we have both user and api key
if ( ! empty( $wp_query->query_vars['um-api'] ) ) {
if ( empty( $wp_query->query_vars['token'] ) || empty( $wp_query->query_vars['key'] ) ) {
$this->missing_auth();
}
// Retrieve the user by public API key and ensure they exist
if ( ! ( $user = $this->get_user( $wp_query->query_vars['key'] ) ) ) {
$this->invalid_key();
} else {
$token = urldecode( $wp_query->query_vars['token'] );
$secret = get_user_meta( $user, 'um_user_secret_key', true );
$public = urldecode( $wp_query->query_vars['key'] );
if ( hash_equals( md5( $secret . $public ), $token ) ) {
$this->is_valid_request = true;
} else {
$this->invalid_auth();
}
}
}
}
/**
* Retrieve the user ID based on the public key provided
*
* @param string $key
*
* @return bool|mixed|null|string
*/
public function get_user( $key = '' ) {
global $wpdb, $wp_query;
if ( empty( $key ) ) {
$key = urldecode( $wp_query->query_vars['key'] );
}
if ( empty( $key ) ) {
return false;
}
$user = get_transient( md5( 'um_api_user_' . $key ) );
if ( false === $user ) {
$user = $wpdb->get_var( $wpdb->prepare(
"SELECT user_id
FROM $wpdb->usermeta
WHERE meta_key = 'um_user_public_key' AND
meta_value = %s
LIMIT 1",
$key
) );
set_transient( md5( 'um_api_user_' . $key ) , $user, DAY_IN_SECONDS );
}
if ( $user != null ) {
$this->user_id = $user;
return $user;
}
return false;
}
/**
* Process Get users API Request
*
* @param $args
*
* @return array
*/
public function get_users( $args ) {
/**
* @var int $number
* @var string $orderby
* @var string $order
* @var string $include
* @var string $exclude
*/
extract( $args );
$response = array();
if ( ! $number ) {
$number = 10;
}
if ( ! $orderby ) {
$orderby = 'user_registered';
}
if ( ! $order ) {
$order = 'desc';
}
$loop_a = array( 'number' => $number, 'orderby' => $orderby, 'order' => $order );
if ( $include ) {
$include = explode(',', $include );
$loop_a['include'] = $include;
}
if ( $exclude ) {
$exclude = explode(',', $exclude );
$loop_a['exclude'] = $exclude;
}
$loop = get_users( $loop_a );
foreach ( $loop as $user ) {
unset( $user->data->user_status );
unset( $user->data->user_activation_key );
unset( $user->data->user_pass );
um_fetch_user( $user->ID );
foreach ( $user as $key => $val ) {
if ( $key != 'data' ) {
continue;
}
$key = 'profile';
$val->roles = $user->roles;
$val->first_name = um_user('first_name');
$val->last_name = um_user('last_name');
$val->account_status = um_user('account_status');
$val->profile_pic_original = um_get_user_avatar_url('', 'original');
$val->profile_pic_normal = um_get_user_avatar_url('', 200);
$val->profile_pic_small = um_get_user_avatar_url('', 40);
$val->cover_photo = $this->getsrc( um_user('cover_photo', 1000) );
/**
* UM hook
*
* @type filter
* @title um_rest_userdata
* @description Change output data for Rest API userdata call
* @input_vars
* [{"var":"$value","type":"array","desc":"Output Data"},
* {"var":"$user_id","type":"string","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_userdata', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_rest_userdata', 'my_rest_userdata', 10, 2 );
* function my_rest_userdata( $value, $user_id ) {
* // your code here
* return $value;
* }
* ?>
*/
$val = apply_filters( 'um_rest_userdata', $val, $user->ID );
$response[ $user->ID ] = $val;
}
}
return $response;
}
/**
* Update user API query
*
* @param $args
*
* @return array
*/
public function update_user( $args ) {
/**
* @var int $id
* @var string $data
* @var string $value
*/
extract( $args );
$response = array();
$error = array();
if ( ! $id ) {
$error['error'] = __( 'You must provide a user ID', 'ultimate-member' );
return $error;
}
if ( ! $data ) {
$error['error'] = __( 'You need to provide data to update', 'ultimate-member' );
return $error;
}
um_fetch_user( $id );
switch ( $data ) {
case 'status':
UM()->user()->set_status( $value );
$response['success'] = __( 'User status has been changed.', 'ultimate-member' );
break;
case 'role':
$wp_user_object = new \WP_User( $id );
$old_roles = $wp_user_object->roles;
$wp_user_object->set_role( $value );
/**
* UM hook
*
* @type action
* @title um_after_member_role_upgrade
* @description Action after user role was changed
* @input_vars
* [{"var":"$new_roles","type":"array","desc":"New User Roles"},
* {"var":"$old_roles","type":"array","desc":"Old roles"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_member_role_upgrade', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_after_member_role_upgrade', 'my_after_member_role_upgrade', 10, 2 );
* function my_after_member_role_upgrade( $new_roles, $old_roles ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_member_role_upgrade', array( $value ), $old_roles, $id );
$response['success'] = __( 'User role has been changed.', 'ultimate-member' );
break;
default:
update_user_meta( $id, $data, esc_attr( $value ) );
$response['success'] = __( 'User meta has been changed.', 'ultimate-member' );
break;
}
return $response;
}
/**
* Process delete user via API
*
* @param $args
*
* @return array
*/
public function delete_user( $args ) {
/**
* @var int $id
*/
extract( $args );
$response = array();
$error = array();
if ( ! isset( $id ) ) {
$error['error'] = __( 'You must provide a user ID', 'ultimate-member' );
return $error;
}
$user = get_userdata( $id );
if ( ! $user ) {
$error['error'] = __( 'Invalid user specified', 'ultimate-member' );
return $error;
}
um_fetch_user( $id );
UM()->user()->delete();
$response['success'] = __( 'User has been successfully deleted.', 'ultimate-member' );
return $response;
}
/**
* Process Get user API Request
*
* @param $args
*
* @return array|mixed
*/
public function get_auser( $args ) {
/**
* @var int $um_id
* @var string $um_fields
*/
extract( $args );
$response = array();
$error = array();
if ( ! isset( $id ) ) {
$error['error'] = __('You must provide a user ID','ultimate-member');
return $error;
}
$user = get_userdata( $id );
if ( ! $user ) {
$error['error'] = __('Invalid user specified','ultimate-member');
return $error;
}
unset( $user->data->user_status );
unset( $user->data->user_activation_key );
unset( $user->data->user_pass );
um_fetch_user( $user->ID );
if ( isset( $fields ) && $fields ) {
$fields = explode(',', $fields );
$response['ID'] = $user->ID;
$response['username'] = $user->user_login;
foreach ( $fields as $field ) {
switch ( $field ) {
default:
$response[ $field ] = ( um_profile( $field ) ) ? um_profile( $field ) : '';
/**
* UM hook
*
* @type filter
* @title um_rest_get_auser
* @description Change output data for Rest API user authentification call
* @input_vars
* [{"var":"$response","type":"array","desc":"Output Data"},
* {"var":"$field","type":"string","desc":"Field Key"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_get_auser', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_rest_get_auser', 'my_rest_get_auser', 10, 3 );
* function my_rest_get_auser( $response, $field, $user_id ) {
* // your code here
* return $response;
* }
* ?>
*/
$response = apply_filters( 'um_rest_get_auser', $response, $field, $user->ID );
break;
case 'cover_photo':
$response['cover_photo'] = $this->getsrc( um_user('cover_photo', 1000) );
break;
case 'profile_pic':
$response['profile_pic_original'] = um_get_user_avatar_url('', 'original');
$response['profile_pic_normal'] = um_get_user_avatar_url('', 200);
$response['profile_pic_small'] = um_get_user_avatar_url('', 40);
break;
case 'status':
$response['status'] = um_user('account_status');
break;
case 'role':
//get priority role here
$response['role'] = um_user( 'role' );
break;
case 'email':
case 'user_email':
$response['email'] = um_user('user_email');
break;
}
}
} else {
foreach ( $user as $key => $val ) {
if ( $key != 'data' ) {
continue;
}
$key = 'profile';
$val->roles = $user->roles;
$val->first_name = um_user( 'first_name' );
$val->last_name = um_user('last_name' );
$val->account_status = um_user( 'account_status' );
$val->profile_pic_original = um_get_user_avatar_url( '', 'original' );
$val->profile_pic_normal = um_get_user_avatar_url( '', 200 );
$val->profile_pic_small = um_get_user_avatar_url( '', 40 );
$val->cover_photo = $this->getsrc( um_user( 'cover_photo', 1000 ) );
/**
* UM hook
*
* @type filter
* @title um_rest_userdata
* @description Change output data for Rest API userdata call
* @input_vars
* [{"var":"$value","type":"array","desc":"Output Data"},
* {"var":"$user_id","type":"string","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_userdata', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_rest_userdata', 'my_rest_userdata', 10, 2 );
* function my_rest_userdata( $value, $user_id ) {
* // your code here
* return $value;
* }
* ?>
*/
$val = apply_filters( 'um_rest_userdata', $val, $user->ID );
$response = $val;
}
}
return $response;
}
/**
* Get source
*
* @param $image
*
* @return string
*/
public function getsrc( $image ) {
if (preg_match('/<img.+?src(?: )*=(?: )*[\'"](.*?)[\'"]/si', $image, $arrResult)) {
return $arrResult[1];
}
return '';
}
/**
* Retrieve the output format
*/
public function get_output_format() {
global $wp_query;
$format = isset( $wp_query->query_vars['format'] ) ? $wp_query->query_vars['format'] : 'json';
/**
* UM hook
*
* @type filter
* @title um_api_output_format
* @description UM Rest API output format
* @input_vars
* [{"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_format', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_format', 'my_api_output_format', 10, 1 );
* function my_api_output_format( $format ) {
* // your code here
* return $format;
* }
* ?>
*/
return apply_filters( 'um_api_output_format', $format );
}
}
}
+540
View File
@@ -0,0 +1,540 @@
<?php
namespace um\core\rest;
if ( ! defined( 'ABSPATH' ) ) exit;
if ( ! class_exists( 'um\core\rest\API_v2' ) ) {
/**
* Class API_v2
* @package um\core\rest
*/
class API_v2 extends API {
/**
*
*/
const VERSION = '2.0';
/**
* REST_API constructor.
*/
public function __construct() {
parent::__construct();
add_filter( 'query_vars', array( $this, 'query_vars' ) );
}
/**
* Registers query vars for API access
*
* @param $vars
*
* @return array
*/
public function query_vars( $vars ) {
$vars[] = 'um_key';
$vars[] = 'um_token';
$vars[] = 'um_format';
$vars[] = 'um_query';
$vars[] = 'um_type';
$vars[] = 'um_data';
$vars[] = 'um_fields';
$vars[] = 'um_value';
$vars[] = 'um_number';
$vars[] = 'um_id';
$vars[] = 'um_email';
$vars[] = 'um_orderby';
$vars[] = 'um_order';
$vars[] = 'um_include';
$vars[] = 'um_exclude';
$this->vars = $vars;
return $vars;
}
/**
* Validate the API request
*/
protected function validate_request() {
global $wp_query;
$this->override = false;
// Make sure we have both user and api key
if ( ! empty( $wp_query->query_vars['um-api'] ) ) {
if ( empty( $wp_query->query_vars['um_token'] ) || empty( $wp_query->query_vars['um_key'] ) ) {
$this->missing_auth();
}
// Retrieve the user by public API key and ensure they exist
if ( ! ( $user = $this->get_user( $wp_query->query_vars['um_key'] ) ) ) {
$this->invalid_key();
} else {
$token = urldecode( $wp_query->query_vars['um_token'] );
$secret = get_user_meta( $user, 'um_user_secret_key', true );
$public = urldecode( $wp_query->query_vars['um_key'] );
if ( hash_equals( md5( $secret . $public ), $token ) ) {
$this->is_valid_request = true;
} else {
$this->invalid_auth();
}
}
}
}
/**
* Retrieve the user ID based on the public key provided
*
* @param string $key
*
* @return bool|mixed|null|string
*/
public function get_user( $key = '' ) {
global $wpdb, $wp_query;
if ( empty( $key ) ) {
$key = urldecode( $wp_query->query_vars['um_key'] );
}
if ( empty( $key ) ) {
return false;
}
$user = get_transient( md5( 'um_api_user_' . $key ) );
if ( false === $user ) {
$user = $wpdb->get_var( $wpdb->prepare(
"SELECT user_id
FROM $wpdb->usermeta
WHERE meta_key = 'um_user_public_key' AND
meta_value = %s
LIMIT 1",
$key
) );
set_transient( md5( 'um_api_user_' . $key ) , $user, DAY_IN_SECONDS );
}
if ( $user != NULL ) {
$this->user_id = $user;
return $user;
}
return false;
}
/**
* Process Get users API Request
*
* @param $args
*
* @return array
*/
public function get_users( $args ) {
/**
* @var int $um_number
* @var string $um_orderby
* @var string $um_order
* @var string $um_include
* @var string $um_exclude
*/
extract( $args );
$response = array();
if ( ! $um_number ) {
$um_number = 10;
}
if ( ! $um_orderby ) {
$um_orderby = 'user_registered';
}
if ( ! $um_order ) {
$um_order = 'desc';
}
$loop_a = array( 'number' => $um_number, 'orderby' => $um_orderby, 'order' => $um_order );
if ( $um_include ) {
$um_include = explode(',', $um_include );
$loop_a['include'] = $um_include;
}
if ( $um_exclude ) {
$um_exclude = explode(',', $um_exclude );
$loop_a['exclude'] = $um_exclude;
}
$loop = get_users( $loop_a );
foreach ( $loop as $user ) {
unset( $user->data->user_status );
unset( $user->data->user_activation_key );
unset( $user->data->user_pass );
um_fetch_user( $user->ID );
foreach ( $user as $key => $val ) {
if ( $key != 'data' ) {
continue;
}
$key = 'profile';
$val->roles = $user->roles;
$val->first_name = um_user( 'first_name' );
$val->last_name = um_user( 'last_name' );
$val->account_status = um_user( 'account_status' );
$val->profile_pic_original = um_get_user_avatar_url( '', 'original' );
$val->profile_pic_normal = um_get_user_avatar_url( '', 200 );
$val->profile_pic_small = um_get_user_avatar_url( '', 40 );
$val->cover_photo = $this->getsrc( um_user( 'cover_photo', 1000 ) );
/**
* UM hook
*
* @type filter
* @title um_rest_userdata
* @description Change output data for Rest API userdata call
* @input_vars
* [{"var":"$value","type":"array","desc":"Output Data"},
* {"var":"$user_id","type":"string","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_userdata', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_rest_userdata', 'my_rest_userdata', 10, 2 );
* function my_rest_userdata( $value, $user_id ) {
* // your code here
* return $value;
* }
* ?>
*/
$val = apply_filters( 'um_rest_userdata', $val, $user->ID );
$response[ $user->ID ] = $val;
}
}
return $response;
}
/**
* Update user API query
*
* @param $args
*
* @return array
*/
public function update_user( $args ) {
/**
* @var int $um_id
* @var string $um_data
* @var string $um_value
*/
extract( $args );
$response = array();
$error = array();
if ( ! $um_id ) {
$error['error'] = __( 'You must provide a user ID', 'ultimate-member' );
return $error;
}
if ( ! $um_data ) {
$error['error'] = __( 'You need to provide data to update', 'ultimate-member' );
return $error;
}
um_fetch_user( $um_id );
switch ( $um_data ) {
case 'status':
UM()->user()->set_status( $um_value );
$response['success'] = __( 'User status has been changed.', 'ultimate-member' );
break;
case 'role':
$wp_user_object = new \WP_User( $um_id );
$old_roles = $wp_user_object->roles;
$wp_user_object->set_role( $um_value );
/**
* UM hook
*
* @type action
* @title um_after_member_role_upgrade
* @description Action after user role was changed
* @input_vars
* [{"var":"$new_roles","type":"array","desc":"New User Roles"},
* {"var":"$old_roles","type":"array","desc":"Old roles"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_member_role_upgrade', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_after_member_role_upgrade', 'my_after_member_role_upgrade', 10, 2 );
* function my_after_member_role_upgrade( $new_roles, $old_roles ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_member_role_upgrade', array( $um_value ), $old_roles, $um_id );
$response['success'] = __( 'User role has been changed.', 'ultimate-member' );
break;
default:
update_user_meta( $um_id, $um_data, esc_attr( $um_value ) );
$response['success'] = __( 'User meta has been changed.', 'ultimate-member' );
break;
}
return $response;
}
/**
* Process delete user via API
*
* @param $args
*
* @return array
*/
public function delete_user( $args ) {
/**
* @var int $um_id
*/
extract( $args );
$response = array();
$error = array();
if ( ! isset( $um_id ) ) {
$error['error'] = __( 'You must provide a user ID', 'ultimate-member' );
return $error;
}
$user = get_userdata( $um_id );
if ( ! $user ) {
$error['error'] = __( 'Invalid user specified', 'ultimate-member' );
return $error;
}
um_fetch_user( $um_id );
UM()->user()->delete();
$response['success'] = __( 'User has been successfully deleted.', 'ultimate-member' );
return $response;
}
/**
* Process Get user API Request
*
* @param $args
*
* @return array
*/
public function get_auser( $args ) {
/**
* @var int $um_id
* @var string $um_fields
*/
extract( $args );
$response = array();
$error = array();
if ( ! isset( $um_id ) ) {
$error['error'] = __( 'You must provide a user ID', 'ultimate-member' );
return $error;
}
$user = get_userdata( $um_id );
if ( ! $user ) {
$error['error'] = __('Invalid user specified','ultimate-member');
return $error;
}
unset( $user->data->user_status );
unset( $user->data->user_activation_key );
unset( $user->data->user_pass );
um_fetch_user( $user->ID );
if ( isset( $um_fields ) && $um_fields ) {
$um_fields = explode(',', $um_fields );
$response['ID'] = $user->ID;
$response['username'] = $user->user_login;
foreach ( $um_fields as $field ) {
switch ( $field ) {
default:
$response[ $field ] = ( um_profile( $field ) ) ? um_profile( $field ) : '';
/**
* UM hook
*
* @type filter
* @title um_rest_get_auser
* @description Change output data for Rest API user authentification call
* @input_vars
* [{"var":"$response","type":"array","desc":"Output Data"},
* {"var":"$field","type":"string","desc":"Field Key"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_get_auser', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_rest_get_auser', 'my_rest_get_auser', 10, 3 );
* function my_rest_get_auser( $response, $field, $user_id ) {
* // your code here
* return $response;
* }
* ?>
*/
$response = apply_filters( 'um_rest_get_auser', $response, $field, $user->ID );
break;
case 'cover_photo':
$response['cover_photo'] = $this->getsrc( um_user( 'cover_photo', 1000 ) );
break;
case 'profile_pic':
$response['profile_pic_original'] = um_get_user_avatar_url( '', 'original' );
$response['profile_pic_normal'] = um_get_user_avatar_url( '', 200 );
$response['profile_pic_small'] = um_get_user_avatar_url( '', 40 );
break;
case 'status':
$response['status'] = um_user( 'account_status' );
break;
case 'role':
//get priority role here
$response['role'] = um_user( 'role' );
break;
case 'email':
case 'user_email':
$response['email'] = um_user( 'user_email' );
break;
}
}
} else {
foreach ( $user as $key => $val ) {
if ( $key != 'data' ) {
continue;
}
if ( $key == 'data' ) {
$key = 'profile';
$val->roles = $user->roles;
$val->first_name = um_user( 'first_name' );
$val->last_name = um_user( 'last_name' );
$val->account_status = um_user( 'account_status' );
$val->profile_pic_original = um_get_user_avatar_url( '', 'original' );
$val->profile_pic_normal = um_get_user_avatar_url( '', 200 );
$val->profile_pic_small = um_get_user_avatar_url( '', 40 );
$val->cover_photo = $this->getsrc( um_user( 'cover_photo', 1000 ) );
/**
* UM hook
*
* @type filter
* @title um_rest_userdata
* @description Change output data for Rest API userdata call
* @input_vars
* [{"var":"$value","type":"array","desc":"Output Data"},
* {"var":"$user_id","type":"string","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_userdata', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_rest_userdata', 'my_rest_userdata', 10, 2 );
* function my_rest_userdata( $value, $user_id ) {
* // your code here
* return $value;
* }
* ?>
*/
$val = apply_filters( 'um_rest_userdata', $val, $user->ID );
}
$response = $val;
}
}
return $response;
}
/**
* Get source
*
* @param $image
*
* @return string
*/
public function getsrc( $image ) {
if (preg_match('/<img.+?src(?: )*=(?: )*[\'"](.*?)[\'"]/si', $image, $arrResult)) {
return $arrResult[1];
}
return '';
}
/**
* Retrieve the output format
*/
public function get_output_format() {
global $wp_query;
$format = isset( $wp_query->query_vars['um_format'] ) ? $wp_query->query_vars['um_format'] : 'json';
/**
* UM hook
*
* @type filter
* @title um_api_output_format
* @description UM Rest API output format
* @input_vars
* [{"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_format', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_format', 'my_api_output_format', 10, 1 );
* function my_api_output_format( $format ) {
* // your code here
* return $format;
* }
* ?>
*/
return apply_filters( 'um_api_output_format', $format );
}
}
}
+615
View File
@@ -0,0 +1,615 @@
<?php
namespace um\core\rest;
if ( ! defined( 'ABSPATH' ) ) exit;
if ( ! class_exists( 'um\core\rest\API' ) ) {
/**
* Class API
*
* @package um\core\rest
*/
class API {
/**
* @var bool|int|null
*/
protected $pretty_print = false;
/**
* @var bool|mixed|void
*/
public $log_requests = true;
/**
* @var bool
*/
protected $is_valid_request = false;
/**
* @var int
*/
protected $user_id = 0;
/**
* @var
*/
protected $stats;
/**
* @var array
*/
protected $data = array();
/**
* @var bool
*/
protected $override = true;
/**
* @var array
*/
protected $vars = array();
/**
* REST_API constructor.
*/
public function __construct() {
add_action( 'init', array( $this, 'add_endpoint' ) );
add_action( 'template_redirect', array( $this, 'process_query' ), -1 );
// Determine if JSON_PRETTY_PRINT is available
$this->pretty_print = defined( 'JSON_PRETTY_PRINT' ) ? JSON_PRETTY_PRINT : null;
/**
* UM hook
*
* @type filter
* @title um_api_log_requests
* @description Allow API request logging to be turned off
* @input_vars
* [{"var":"$allow_log","type":"bool","desc":"Enable api logs"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_log_requests', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_log_requests', 'my_api_log_requests', 10, 1 );
* function my_api_log_requests( $allow_log ) {
* // your code here
* return $allow_log;
* }
* ?>
*/
$this->log_requests = apply_filters( 'um_api_log_requests', $this->log_requests );
}
/**
* Registers a new rewrite endpoint for accessing the API
*
* @param $rewrite_rules
*/
public function add_endpoint( $rewrite_rules ) {
add_rewrite_endpoint( 'um-api', EP_ALL );
}
/**
* Listens for the API and then processes the API requests
*/
public function process_query() {
global $wp_query;
// Check for um-api var. Get out if not present
if ( ! isset( $wp_query->query_vars['um-api'] ) ) {
return;
}
// Check for a valid user and set errors if necessary
$this->validate_request();
// Only proceed if no errors have been noted
if ( ! $this->is_valid_request ) {
return;
}
if ( ! defined( 'UM_DOING_API' ) ) {
define( 'UM_DOING_API', true );
}
// Determine the kind of query
$args = array();
$query_mode = $this->get_query_mode();
foreach ( $this->vars as $k ) {
$args[ $k ] = isset( $wp_query->query_vars[ $k ] ) ? $wp_query->query_vars[ $k ] : null;
}
$data = array();
switch ( $query_mode ) {
case 'get.stats':
$data = $this->get_stats( $args );
break;
case 'get.users':
$data = $this->get_users( $args );
break;
case 'get.user':
$data = $this->get_auser( $args );
break;
case 'update.user':
$data = $this->update_user( $args );
break;
case 'delete.user':
$data = $this->delete_user( $args );
break;
default:
/**
* UM hook
*
* @type filter
* @title um_rest_query_mode
* @description Change query attributes
* @input_vars
* [{"var":"$data","type":"array","desc":"Query Data"},
* {"var":"$query_mode","type":"string","desc":"Query Mode"},
* {"var":"$args","type":"array","desc":"Query Arguments"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_query_mode', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_rest_query_mode', 'my_rest_query_mode', 10, 3 );
* function um_rest_query_mode( $data, $query_mode, $args ) {
* // your code here
* return $data;
* }
* ?>
*/
$data = apply_filters( 'um_rest_query_mode', $data, $query_mode, $args );
break;
}
/**
* UM hook
*
* @type filter
* @title um_api_output_data
* @description Change output data for Rest API call
* @input_vars
* [{"var":"$data","type":"array","desc":"Output Data"},
* {"var":"$query_mode","type":"string","desc":"Query Mode"},
* {"var":"$api_class","type":"REST_API","desc":"REST_API instance"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_data', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_data', 'my_api_output_data', 10, 3 );
* function my_api_output_data( $data, $query_mode, $api_class ) {
* // your code here
* return $data;
* }
* ?>
*/
$this->data = apply_filters( 'um_api_output_data', $data, $query_mode, $this );
// Log this API request, if enabled. We log it here because we have access to errors.
$this->log_request( $this->data );
// Send out data to the output function
$this->output();
}
/**
* Validate the API request
*/
protected function validate_request() {
}
/**
* Retrieve the user ID based on the public key provided
*
* @param string $key
*
* @return bool
*/
public function get_user( $key = '' ) {
return false;
}
/**
* Displays a missing authentication error if all the parameters aren't
* provided
*/
protected function missing_auth() {
$error = array();
$error['error'] = __( 'You must specify both a token and API key!', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Displays an authentication failed error if the user failed to provide valid credentials
*/
protected function invalid_auth() {
$error = array();
$error['error'] = __( 'Your request could not be authenticated', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Displays an invalid API key error if the API key provided couldn't be validated
*/
protected function invalid_key() {
$error = array();
$error['error'] = __( 'Invalid API key', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Get some stats
*
* @param $args
*
* @return array
*/
public function get_stats( $args ) {
global $wpdb;
$response = array();
$count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}users" ) );
$response['stats']['total_users'] = $count;
$pending = UM()->user()->get_pending_users_count();
$response['stats']['pending_users'] = absint( $pending );
/**
* UM hook
*
* @type filter
* @title um_rest_api_get_stats
* @description Change output data for Rest API get stats call
* @input_vars
* [{"var":"$response","type":"array","desc":"Output Data"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_api_get_stats', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_rest_api_get_stats', 'my_rest_api_get_stats', 10, 1 );
* function my_rest_api_get_stats( $response ) {
* // your code here
* return $response;
* }
* ?>
*/
$response = apply_filters( 'um_rest_api_get_stats', $response );
return $response;
}
/**
* Process Get users API Request
*
* @param $args
*
* @return array
*/
public function get_users( $args ) {
return array();
}
/**
* Update user API query
*
* @param $args
*
* @return array
*/
public function update_user( $args ) {
return array();
}
/**
* Process delete user via API
*
* @param $args
*
* @return array
*/
public function delete_user( $args ) {
return array();
}
/**
* Process Get user API Request
*
* @param $args
*
* @return array
*/
public function get_auser( $args ) {
return array();
}
/**
* Get source
*
* @param $image
*
* @return string
*/
protected function getsrc( $image ) {
if ( preg_match( '/<img.+?src(?: )*=(?: )*[\'"](.*?)[\'"]/si', $image, $arrResult ) ) {
return $arrResult[1];
}
return '';
}
/**
* Determines the kind of query requested and also ensure it is a valid query
*
* @return null
*/
public function get_query_mode() {
global $wp_query;
/**
* UM hook
*
* @type filter
* @title um_api_valid_query_modes
* @description Whitelist UM query options
* @input_vars
* [{"var":"$list","type":"array","desc":"Whitelist"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_valid_query_modes', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_valid_query_modes', 'my_api_valid_query_modes', 10, 1 );
* function my_api_valid_query_modes( $list ) {
* // your code here
* return $list;
* }
* ?>
*/
$accepted = apply_filters( 'um_api_valid_query_modes', array(
'get.users',
'get.user',
'update.user',
'delete.user',
'get.following',
'get.followers',
'get.stats',
) );
$query = isset( $wp_query->query_vars['um-api'] ) ? $wp_query->query_vars['um-api'] : null;
$error = array();
// Make sure our query is valid
if ( ! in_array( $query, $accepted ) ) {
$error['error'] = __( 'Invalid query!', 'ultimate-member' );
$this->data = $error;
$this->output();
}
return $query;
}
/**
* Get page number
*/
public function get_paged() {
global $wp_query;
return isset( $wp_query->query_vars['page'] ) ? $wp_query->query_vars['page'] : 1;
}
/**
* Retrieve the output format
*/
public function get_output_format() {
/**
* UM hook
*
* @type filter
* @title um_api_output_format
* @description UM Rest API output format
* @input_vars
* [{"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_format', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_format', 'my_api_output_format', 10, 1 );
* function my_api_output_format( $format ) {
* // your code here
* return $format;
* }
* ?>
*/
return apply_filters( 'um_api_output_format', 'json' );
}
/**
* Log each API request, if enabled
*
* @param array $data
*/
protected function log_request( $data = array() ) {
if ( ! $this->log_requests ) {
return;
}
}
/**
* Retrieve the output data
*/
public function get_output() {
return $this->data;
}
/**
* Output Query in either JSON/XML. The query data is outputted as JSON
* by default
*
* @param int $status_code
*/
public function output( $status_code = 200 ) {
$format = $this->get_output_format();
status_header( $status_code );
/**
* UM hook
*
* @type action
* @title um_api_output_before
* @description Action before API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"},
* {"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_before', 'function_name', 10, 3 );
* @example
* <?php
* add_action( 'um_api_output_before', 'my_api_output_before', 10, 3 );
* function my_api_output_before( $data, $rest_api, $format ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_before', $this->data, $this, $format );
switch ( $format ) {
case 'xml' :
require_once um_path . 'includes/lib/array2xml.php';
$xml = \Array2XML::createXML( 'um', $this->data );
echo $xml->saveXML();
break;
case 'json' :
case '' :
header( 'Content-Type: application/json' );
if ( ! empty( $this->pretty_print ) ) {
echo json_encode( $this->data, $this->pretty_print );
} else {
echo json_encode( $this->data );
}
break;
default :
// Allow other formats to be added via extensions
/**
* UM hook
*
* @type action
* @title um_api_output_{$format}
* @description Action before API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_{$format}', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_api_output_{$format}', 'my_api_output', 10, 2 );
* function my_api_output( $data, $rest_api ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_' . $format, $this->data, $this );
break;
}
/**
* UM hook
*
* @type action
* @title um_api_output_after
* @description Action after API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"},
* {"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_after', 'function_name', 10, 3 );
* @example
* <?php
* add_action( 'um_api_output_after', 'my_api_output_after', 10, 3 );
* function my_api_output_after( $data, $rest_api, $format ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_after', $this->data, $this, $format );
die();
}
}
}