Agentic
4 months ago
BlockTemplates
4 weeks ago
EmailImprovements
1 year ago
EmailPreview
4 weeks ago
Emails
1 year ago
ImportExport
1 year ago
Logging
1 year ago
Marketing
2 years ago
Notes
4 weeks ago
Onboarding
5 months ago
Orders
4 weeks ago
ProductForm
2 years ago
ProductReviews
4 weeks ago
RemoteFreeExtensions
4 weeks ago
Schedulers
4 weeks ago
Settings
2 weeks ago
Suggestions
4 weeks ago
WCPayPromotion
10 months ago
ActivityPanels.php
3 years ago
Analytics.php
4 weeks ago
CategoryLookup.php
4 years ago
Coupons.php
1 year ago
CouponsMovedTrait.php
5 months ago
CustomerEffortScoreTracks.php
7 months ago
Events.php
2 months ago
FeaturePlugin.php
4 months ago
Homescreen.php
1 month ago
Loader.php
4 weeks ago
Marketing.php
1 year ago
Marketplace.php
5 months ago
MobileAppBanner.php
4 years ago
OrderMilestoneEasterEgg.php
4 weeks ago
RemoteInboxNotifications.php
3 years ago
Settings.php
2 weeks ago
ShippingLabelBanner.php
1 year ago
ShippingLabelBannerDisplayRules.php
1 year ago
SiteHealth.php
3 years ago
Survey.php
4 years ago
SystemStatusReport.php
1 year ago
Translations.php
1 year ago
WCAdminAssets.php
2 weeks ago
WCAdminSharedSettings.php
1 year ago
WCAdminUser.php
9 months ago
WcPayWelcomePage.php
1 year ago
WCAdminUser.php
192 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Automattic\WooCommerce\Internal\Admin; |
| 4 | |
| 5 | /** |
| 6 | * WCAdminUser Class. |
| 7 | */ |
| 8 | class WCAdminUser { |
| 9 | |
| 10 | /** |
| 11 | * Class instance. |
| 12 | * |
| 13 | * @var WCAdminUser instance |
| 14 | */ |
| 15 | protected static $instance = null; |
| 16 | |
| 17 | /** |
| 18 | * Constructor. |
| 19 | */ |
| 20 | public function __construct() { |
| 21 | add_action( 'rest_api_init', array( $this, 'register_user_data' ) ); |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * Get class instance. |
| 26 | * |
| 27 | * @return object Instance. |
| 28 | */ |
| 29 | public static function get_instance() { |
| 30 | if ( null === self::$instance ) { |
| 31 | self::$instance = new self(); |
| 32 | } |
| 33 | return self::$instance; |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * Registers WooCommerce specific user data to the WordPress user API. |
| 38 | */ |
| 39 | public function register_user_data() { |
| 40 | register_rest_field( |
| 41 | 'user', |
| 42 | 'is_super_admin', |
| 43 | array( |
| 44 | 'get_callback' => function( $user ) { |
| 45 | if ( ! isset( $user['id'] ) || 0 === $user['id'] ) { |
| 46 | return false; |
| 47 | } |
| 48 | |
| 49 | return is_super_admin( $user['id'] ); |
| 50 | }, |
| 51 | 'schema' => null, |
| 52 | ) |
| 53 | ); |
| 54 | register_rest_field( |
| 55 | 'user', |
| 56 | 'woocommerce_meta', |
| 57 | array( |
| 58 | 'get_callback' => array( $this, 'get_user_data_values' ), |
| 59 | 'update_callback' => array( $this, 'update_user_data_values' ), |
| 60 | 'schema' => null, |
| 61 | ) |
| 62 | ); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * For all the registered user data fields ( Loader::get_user_data_fields ), fetch the data |
| 67 | * for returning via the REST API. |
| 68 | * |
| 69 | * @param WP_User $user Current user. |
| 70 | */ |
| 71 | public function get_user_data_values( $user ) { |
| 72 | $values = array(); |
| 73 | foreach ( $this->get_user_data_fields() as $field ) { |
| 74 | $values[ $field ] = self::get_user_data_field( $user['id'], $field ); |
| 75 | } |
| 76 | return $values; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * For all the registered user data fields ( Loader::get_user_data_fields ), update the data |
| 81 | * for the REST API. |
| 82 | * |
| 83 | * @param array $values The new values for the meta. |
| 84 | * @param WP_User $user The current user. |
| 85 | * @param string $field_id The field id for the user meta. |
| 86 | */ |
| 87 | public function update_user_data_values( $values, $user, $field_id ) { |
| 88 | if ( empty( $values ) || ! is_array( $values ) || 'woocommerce_meta' !== $field_id ) { |
| 89 | return; |
| 90 | } |
| 91 | $fields = $this->get_user_data_fields(); |
| 92 | $updates = array(); |
| 93 | foreach ( $values as $field => $value ) { |
| 94 | if ( in_array( $field, $fields, true ) ) { |
| 95 | $updates[ $field ] = $value; |
| 96 | self::update_user_data_field( $user->ID, $field, $value ); |
| 97 | } |
| 98 | } |
| 99 | return $updates; |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * We store some WooCommerce specific user meta attached to users endpoint, |
| 104 | * so that we can track certain preferences or values such as the inbox activity panel last open time. |
| 105 | * Additional fields can be added in the function below, and then used via wc-admin's currentUser data. |
| 106 | * |
| 107 | * @return array Fields to expose over the WP user endpoint. |
| 108 | */ |
| 109 | public function get_user_data_fields() { |
| 110 | /** |
| 111 | * Filter user data fields exposed over the WordPress user endpoint. |
| 112 | * |
| 113 | * @since 4.0.0 |
| 114 | * @param array $fields Array of fields to expose over the WP user endpoint. |
| 115 | */ |
| 116 | return apply_filters( 'woocommerce_admin_get_user_data_fields', array( 'variable_product_tour_shown' ) ); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Helper to update user data fields. |
| 121 | * |
| 122 | * @param int $user_id User ID. |
| 123 | * @param string $field Field name. |
| 124 | * @param mixed $value Field value. |
| 125 | */ |
| 126 | public static function update_user_data_field( $user_id, $field, $value ) { |
| 127 | update_user_meta( $user_id, 'woocommerce_admin_' . $field, $value ); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Helper to retrieve user data fields. |
| 132 | * |
| 133 | * Migrates old key prefixes as well. |
| 134 | * |
| 135 | * @param int $user_id User ID. |
| 136 | * @param string $field Field name. |
| 137 | * @return mixed The user field value. |
| 138 | */ |
| 139 | public static function get_user_data_field( $user_id, $field ) { |
| 140 | $meta_value = get_user_meta( $user_id, 'woocommerce_admin_' . $field, true ); |
| 141 | |
| 142 | // Migrate old meta values (prefix changed from `wc_admin_` to `woocommerce_admin_`). |
| 143 | if ( '' === $meta_value ) { |
| 144 | $old_meta_value = get_user_meta( $user_id, 'wc_admin_' . $field, true ); |
| 145 | |
| 146 | if ( '' !== $old_meta_value ) { |
| 147 | self::update_user_data_field( $user_id, $field, $old_meta_value ); |
| 148 | delete_user_meta( $user_id, 'wc_admin_' . $field ); |
| 149 | |
| 150 | $meta_value = $old_meta_value; |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | return $meta_value; |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Get the current user data. |
| 159 | * |
| 160 | * @return array User data. |
| 161 | */ |
| 162 | public static function get_user_data() { |
| 163 | $user_controller = new \WP_REST_Users_Controller(); |
| 164 | $request = new \WP_REST_Request(); |
| 165 | $request->set_query_params( array( 'context' => 'edit' ) ); |
| 166 | $user_response = $user_controller->get_current_item( $request ); |
| 167 | $current_user_data = is_wp_error( $user_response ) ? (object) array() : $user_response->get_data(); |
| 168 | $current_user_data = self::filter_user_capabilities( $current_user_data ); |
| 169 | |
| 170 | return $current_user_data; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Filter user capabilities to respect file modification restrictions. |
| 175 | * |
| 176 | * @param array $user_data User data. |
| 177 | * @return array Filtered user data. |
| 178 | */ |
| 179 | private static function filter_user_capabilities( $user_data ) { |
| 180 | if ( ! is_array( $user_data ) || ! isset( $user_data['capabilities'] ) ) { |
| 181 | return $user_data; |
| 182 | } |
| 183 | |
| 184 | // If the user has install_plugins capability, check if file modifications are allowed. |
| 185 | if ( isset( $user_data['capabilities']->install_plugins ) && $user_data['capabilities']->install_plugins ) { |
| 186 | $user_data['capabilities']->install_plugins = wp_is_file_mod_allowed( 'woocommerce' ); |
| 187 | } |
| 188 | |
| 189 | return $user_data; |
| 190 | } |
| 191 | } |
| 192 |