<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* WCAdminUser Class.

[5] Fix | Delete

*/

[6] Fix | Delete

class WCAdminUser {

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class instance.

[10] Fix | Delete

*

[11] Fix | Delete

* @var WCAdminUser instance

[12] Fix | Delete

*/

[13] Fix | Delete

protected static $instance = null;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Constructor.

[17] Fix | Delete

*/

[18] Fix | Delete

public function __construct() {

[19] Fix | Delete

add_action( 'rest_api_init', array( $this, 'register_user_data' ) );

[20] Fix | Delete

}

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Get class instance.

[24] Fix | Delete

*

[25] Fix | Delete

* @return object Instance.

[26] Fix | Delete

*/

[27] Fix | Delete

public static function get_instance() {

[28] Fix | Delete

if ( null === self::$instance ) {

[29] Fix | Delete

self::$instance = new self();

[30] Fix | Delete

}

[31] Fix | Delete

return self::$instance;

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Registers WooCommerce specific user data to the WordPress user API.

[36] Fix | Delete

*/

[37] Fix | Delete

public function register_user_data() {

[38] Fix | Delete

register_rest_field(

[39] Fix | Delete

'user',

[40] Fix | Delete

'is_super_admin',

[41] Fix | Delete

array(

[42] Fix | Delete

'get_callback' => function( $user ) {

[43] Fix | Delete

if ( ! isset( $user['id'] ) || 0 === $user['id'] ) {

[44] Fix | Delete

return false;

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

return is_super_admin( $user['id'] );

[48] Fix | Delete

},

[49] Fix | Delete

'schema' => null,

[50] Fix | Delete

)

[51] Fix | Delete

);

[52] Fix | Delete

register_rest_field(

[53] Fix | Delete

'user',

[54] Fix | Delete

'woocommerce_meta',

[55] Fix | Delete

array(

[56] Fix | Delete

'get_callback' => array( $this, 'get_user_data_values' ),

[57] Fix | Delete

'update_callback' => array( $this, 'update_user_data_values' ),

[58] Fix | Delete

'schema' => null,

[59] Fix | Delete

)

[60] Fix | Delete

);

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* For all the registered user data fields ( Loader::get_user_data_fields ), fetch the data

[65] Fix | Delete

* for returning via the REST API.

[66] Fix | Delete

*

[67] Fix | Delete

* @param WP_User $user Current user.

[68] Fix | Delete

*/

[69] Fix | Delete

public function get_user_data_values( $user ) {

[70] Fix | Delete

$values = array();

[71] Fix | Delete

foreach ( $this->get_user_data_fields() as $field ) {

[72] Fix | Delete

$values[ $field ] = self::get_user_data_field( $user['id'], $field );

[73] Fix | Delete

}

[74] Fix | Delete

return $values;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* For all the registered user data fields ( Loader::get_user_data_fields ), update the data

[79] Fix | Delete

* for the REST API.

[80] Fix | Delete

*

[81] Fix | Delete

* @param array $values The new values for the meta.

[82] Fix | Delete

* @param WP_User $user The current user.

[83] Fix | Delete

* @param string $field_id The field id for the user meta.

[84] Fix | Delete

*/

[85] Fix | Delete

public function update_user_data_values( $values, $user, $field_id ) {

[86] Fix | Delete

if ( empty( $values ) || ! is_array( $values ) || 'woocommerce_meta' !== $field_id ) {

[87] Fix | Delete

return;

[88] Fix | Delete

}

[89] Fix | Delete

$fields = $this->get_user_data_fields();

[90] Fix | Delete

$updates = array();

[91] Fix | Delete

foreach ( $values as $field => $value ) {

[92] Fix | Delete

if ( in_array( $field, $fields, true ) ) {

[93] Fix | Delete

$updates[ $field ] = $value;

[94] Fix | Delete

self::update_user_data_field( $user->ID, $field, $value );

[95] Fix | Delete

}

[96] Fix | Delete

}

[97] Fix | Delete

return $updates;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* We store some WooCommerce specific user meta attached to users endpoint,

[102] Fix | Delete

* so that we can track certain preferences or values such as the inbox activity panel last open time.

[103] Fix | Delete

* Additional fields can be added in the function below, and then used via wc-admin's currentUser data.

[104] Fix | Delete

*

[105] Fix | Delete

* @return array Fields to expose over the WP user endpoint.

[106] Fix | Delete

*/

[107] Fix | Delete

public function get_user_data_fields() {

[108] Fix | Delete

/**

[109] Fix | Delete

* Filter user data fields exposed over the WordPress user endpoint.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 4.0.0

[112] Fix | Delete

* @param array $fields Array of fields to expose over the WP user endpoint.

[113] Fix | Delete

*/

[114] Fix | Delete

return apply_filters( 'woocommerce_admin_get_user_data_fields', array( 'variable_product_tour_shown' ) );

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Helper to update user data fields.

[119] Fix | Delete

*

[120] Fix | Delete

* @param int $user_id User ID.

[121] Fix | Delete

* @param string $field Field name.

[122] Fix | Delete

* @param mixed $value Field value.

[123] Fix | Delete

*/

[124] Fix | Delete

public static function update_user_data_field( $user_id, $field, $value ) {

[125] Fix | Delete

update_user_meta( $user_id, 'woocommerce_admin_' . $field, $value );

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Helper to retrieve user data fields.

[130] Fix | Delete

*

[131] Fix | Delete

* Migrates old key prefixes as well.

[132] Fix | Delete

*

[133] Fix | Delete

* @param int $user_id User ID.

[134] Fix | Delete

* @param string $field Field name.

[135] Fix | Delete

* @return mixed The user field value.

[136] Fix | Delete

*/

[137] Fix | Delete

public static function get_user_data_field( $user_id, $field ) {

[138] Fix | Delete

$meta_value = get_user_meta( $user_id, 'woocommerce_admin_' . $field, true );

[139] Fix | Delete

[140] Fix | Delete

// Migrate old meta values (prefix changed from `wc_admin_` to `woocommerce_admin_`).

[141] Fix | Delete

if ( '' === $meta_value ) {

[142] Fix | Delete

$old_meta_value = get_user_meta( $user_id, 'wc_admin_' . $field, true );

[143] Fix | Delete

[144] Fix | Delete

if ( '' !== $old_meta_value ) {

[145] Fix | Delete

self::update_user_data_field( $user_id, $field, $old_meta_value );

[146] Fix | Delete

delete_user_meta( $user_id, 'wc_admin_' . $field );

[147] Fix | Delete

[148] Fix | Delete

$meta_value = $old_meta_value;

[149] Fix | Delete

}

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

return $meta_value;

[153] Fix | Delete

}

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete