Edit File by line
/home/zeestwma/richards.../wp-conte.../plugins/woocomme.../src/Admin/API
File: Notes.php
<?php
[0] Fix | Delete
/**
[1] Fix | Delete
* REST API Admin Notes controller
[2] Fix | Delete
*
[3] Fix | Delete
* Handles requests to the admin notes endpoint.
[4] Fix | Delete
*/
[5] Fix | Delete
[6] Fix | Delete
namespace Automattic\WooCommerce\Admin\API;
[7] Fix | Delete
[8] Fix | Delete
defined( 'ABSPATH' ) || exit;
[9] Fix | Delete
[10] Fix | Delete
use Automattic\WooCommerce\Admin\Notes\Note;
[11] Fix | Delete
use Automattic\WooCommerce\Admin\Notes\Notes as NotesRepository;
[12] Fix | Delete
[13] Fix | Delete
/**
[14] Fix | Delete
* REST API Admin Notes controller class.
[15] Fix | Delete
*
[16] Fix | Delete
* @internal
[17] Fix | Delete
* @extends WC_REST_CRUD_Controller
[18] Fix | Delete
*/
[19] Fix | Delete
class Notes extends \WC_REST_CRUD_Controller {
[20] Fix | Delete
[21] Fix | Delete
/**
[22] Fix | Delete
* Endpoint namespace.
[23] Fix | Delete
*
[24] Fix | Delete
* @var string
[25] Fix | Delete
*/
[26] Fix | Delete
protected $namespace = 'wc-analytics';
[27] Fix | Delete
[28] Fix | Delete
/**
[29] Fix | Delete
* Route base.
[30] Fix | Delete
*
[31] Fix | Delete
* @var string
[32] Fix | Delete
*/
[33] Fix | Delete
protected $rest_base = 'admin/notes';
[34] Fix | Delete
[35] Fix | Delete
/**
[36] Fix | Delete
* Register the routes for admin notes.
[37] Fix | Delete
*/
[38] Fix | Delete
public function register_routes() {
[39] Fix | Delete
register_rest_route(
[40] Fix | Delete
$this->namespace,
[41] Fix | Delete
'/' . $this->rest_base,
[42] Fix | Delete
array(
[43] Fix | Delete
array(
[44] Fix | Delete
'methods' => \WP_REST_Server::READABLE,
[45] Fix | Delete
'callback' => array( $this, 'get_items' ),
[46] Fix | Delete
'permission_callback' => array( $this, 'get_items_permissions_check' ),
[47] Fix | Delete
'args' => $this->get_collection_params(),
[48] Fix | Delete
),
[49] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[50] Fix | Delete
)
[51] Fix | Delete
);
[52] Fix | Delete
[53] Fix | Delete
register_rest_route(
[54] Fix | Delete
$this->namespace,
[55] Fix | Delete
'/' . $this->rest_base . '/(?P<id>[\d-]+)',
[56] Fix | Delete
array(
[57] Fix | Delete
'args' => array(
[58] Fix | Delete
'id' => array(
[59] Fix | Delete
'description' => __( 'Unique ID for the resource.', 'woocommerce' ),
[60] Fix | Delete
'type' => 'integer',
[61] Fix | Delete
),
[62] Fix | Delete
),
[63] Fix | Delete
array(
[64] Fix | Delete
'methods' => \WP_REST_Server::READABLE,
[65] Fix | Delete
'callback' => array( $this, 'get_item' ),
[66] Fix | Delete
'permission_callback' => array( $this, 'get_item_permissions_check' ),
[67] Fix | Delete
),
[68] Fix | Delete
array(
[69] Fix | Delete
'methods' => \WP_REST_Server::EDITABLE,
[70] Fix | Delete
'callback' => array( $this, 'update_item' ),
[71] Fix | Delete
'permission_callback' => array( $this, 'update_items_permissions_check' ),
[72] Fix | Delete
),
[73] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[74] Fix | Delete
)
[75] Fix | Delete
);
[76] Fix | Delete
[77] Fix | Delete
register_rest_route(
[78] Fix | Delete
$this->namespace,
[79] Fix | Delete
'/' . $this->rest_base . '/delete/(?P<id>[\d-]+)',
[80] Fix | Delete
array(
[81] Fix | Delete
array(
[82] Fix | Delete
'methods' => \WP_REST_Server::DELETABLE,
[83] Fix | Delete
'callback' => array( $this, 'delete_item' ),
[84] Fix | Delete
'permission_callback' => array( $this, 'update_items_permissions_check' ),
[85] Fix | Delete
),
[86] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[87] Fix | Delete
)
[88] Fix | Delete
);
[89] Fix | Delete
[90] Fix | Delete
register_rest_route(
[91] Fix | Delete
$this->namespace,
[92] Fix | Delete
'/' . $this->rest_base . '/delete/all',
[93] Fix | Delete
array(
[94] Fix | Delete
array(
[95] Fix | Delete
'methods' => \WP_REST_Server::DELETABLE,
[96] Fix | Delete
'callback' => array( $this, 'delete_all_items' ),
[97] Fix | Delete
'permission_callback' => array( $this, 'update_items_permissions_check' ),
[98] Fix | Delete
'args' => array(
[99] Fix | Delete
'status' => array(
[100] Fix | Delete
'description' => __( 'Status of note.', 'woocommerce' ),
[101] Fix | Delete
'type' => 'array',
[102] Fix | Delete
'sanitize_callback' => 'wp_parse_slug_list',
[103] Fix | Delete
'validate_callback' => 'rest_validate_request_arg',
[104] Fix | Delete
'items' => array(
[105] Fix | Delete
'enum' => Note::get_allowed_statuses(),
[106] Fix | Delete
'type' => 'string',
[107] Fix | Delete
),
[108] Fix | Delete
),
[109] Fix | Delete
),
[110] Fix | Delete
),
[111] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[112] Fix | Delete
)
[113] Fix | Delete
);
[114] Fix | Delete
[115] Fix | Delete
register_rest_route(
[116] Fix | Delete
$this->namespace,
[117] Fix | Delete
'/' . $this->rest_base . '/tracker/(?P<note_id>[\d-]+)/user/(?P<user_id>[\d-]+)',
[118] Fix | Delete
array(
[119] Fix | Delete
array(
[120] Fix | Delete
'methods' => \WP_REST_Server::READABLE,
[121] Fix | Delete
'callback' => array( $this, 'track_opened_email' ),
[122] Fix | Delete
'permission_callback' => '__return_true',
[123] Fix | Delete
),
[124] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[125] Fix | Delete
)
[126] Fix | Delete
);
[127] Fix | Delete
[128] Fix | Delete
register_rest_route(
[129] Fix | Delete
$this->namespace,
[130] Fix | Delete
'/' . $this->rest_base . '/update',
[131] Fix | Delete
array(
[132] Fix | Delete
array(
[133] Fix | Delete
'methods' => \WP_REST_Server::EDITABLE,
[134] Fix | Delete
'callback' => array( $this, 'batch_update_items' ),
[135] Fix | Delete
'permission_callback' => array( $this, 'update_items_permissions_check' ),
[136] Fix | Delete
),
[137] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[138] Fix | Delete
)
[139] Fix | Delete
);
[140] Fix | Delete
[141] Fix | Delete
register_rest_route(
[142] Fix | Delete
$this->namespace,
[143] Fix | Delete
'/' . $this->rest_base . '/experimental-activate-promo/(?P<promo_note_name>[\w-]+)',
[144] Fix | Delete
array(
[145] Fix | Delete
array(
[146] Fix | Delete
'methods' => \WP_REST_Server::EDITABLE,
[147] Fix | Delete
'callback' => array( $this, 'activate_promo_note' ),
[148] Fix | Delete
'permission_callback' => array( $this, 'update_items_permissions_check' ),
[149] Fix | Delete
),
[150] Fix | Delete
'schema' => array( $this, 'get_public_item_schema' ),
[151] Fix | Delete
)
[152] Fix | Delete
);
[153] Fix | Delete
}
[154] Fix | Delete
[155] Fix | Delete
/**
[156] Fix | Delete
* Get a single note.
[157] Fix | Delete
*
[158] Fix | Delete
* @param WP_REST_Request $request Request data.
[159] Fix | Delete
* @return WP_REST_Response|WP_Error
[160] Fix | Delete
*/
[161] Fix | Delete
public function get_item( $request ) {
[162] Fix | Delete
$note = NotesRepository::get_note( $request->get_param( 'id' ) );
[163] Fix | Delete
[164] Fix | Delete
if ( ! $note ) {
[165] Fix | Delete
return new \WP_Error(
[166] Fix | Delete
'woocommerce_note_invalid_id',
[167] Fix | Delete
__( 'Sorry, there is no resource with that ID.', 'woocommerce' ),
[168] Fix | Delete
array( 'status' => 404 )
[169] Fix | Delete
);
[170] Fix | Delete
}
[171] Fix | Delete
[172] Fix | Delete
if ( is_wp_error( $note ) ) {
[173] Fix | Delete
return $note;
[174] Fix | Delete
}
[175] Fix | Delete
[176] Fix | Delete
$data = $this->prepare_note_data_for_response( $note, $request );
[177] Fix | Delete
[178] Fix | Delete
return rest_ensure_response( $data );
[179] Fix | Delete
}
[180] Fix | Delete
[181] Fix | Delete
/**
[182] Fix | Delete
* Get all notes.
[183] Fix | Delete
*
[184] Fix | Delete
* @param WP_REST_Request $request Request data.
[185] Fix | Delete
* @return WP_REST_Response
[186] Fix | Delete
*/
[187] Fix | Delete
public function get_items( $request ) {
[188] Fix | Delete
$query_args = $this->prepare_objects_query( $request );
[189] Fix | Delete
[190] Fix | Delete
$notes = NotesRepository::get_notes( 'edit', $query_args );
[191] Fix | Delete
[192] Fix | Delete
$data = array();
[193] Fix | Delete
foreach ( (array) $notes as $note_obj ) {
[194] Fix | Delete
$note = $this->prepare_item_for_response( $note_obj, $request );
[195] Fix | Delete
$note = $this->prepare_response_for_collection( $note );
[196] Fix | Delete
$data[] = $note;
[197] Fix | Delete
}
[198] Fix | Delete
[199] Fix | Delete
$response = rest_ensure_response( $data );
[200] Fix | Delete
$response->header( 'X-WP-Total', count( $data ) );
[201] Fix | Delete
[202] Fix | Delete
return $response;
[203] Fix | Delete
}
[204] Fix | Delete
[205] Fix | Delete
/**
[206] Fix | Delete
* Checks if user is in tasklist experiment.
[207] Fix | Delete
*
[208] Fix | Delete
* @return bool Whether remote inbox notifications are enabled.
[209] Fix | Delete
*/
[210] Fix | Delete
private function is_tasklist_experiment_assigned_treatment() {
[211] Fix | Delete
$anon_id = isset( $_COOKIE['tk_ai'] ) ? sanitize_text_field( wp_unslash( $_COOKIE['tk_ai'] ) ) : '';
[212] Fix | Delete
$allow_tracking = 'yes' === get_option( 'woocommerce_allow_tracking' );
[213] Fix | Delete
$abtest = new \WooCommerce\Admin\Experimental_Abtest(
[214] Fix | Delete
$anon_id,
[215] Fix | Delete
'woocommerce',
[216] Fix | Delete
$allow_tracking
[217] Fix | Delete
);
[218] Fix | Delete
[219] Fix | Delete
$date = new \DateTime();
[220] Fix | Delete
$date->setTimeZone( new \DateTimeZone( 'UTC' ) );
[221] Fix | Delete
[222] Fix | Delete
$experiment_name = sprintf(
[223] Fix | Delete
'woocommerce_tasklist_progression_headercard_%s_%s',
[224] Fix | Delete
$date->format( 'Y' ),
[225] Fix | Delete
$date->format( 'm' )
[226] Fix | Delete
);
[227] Fix | Delete
[228] Fix | Delete
$experiment_name_2col = sprintf(
[229] Fix | Delete
'woocommerce_tasklist_progression_headercard_2col_%s_%s',
[230] Fix | Delete
$date->format( 'Y' ),
[231] Fix | Delete
$date->format( 'm' )
[232] Fix | Delete
);
[233] Fix | Delete
[234] Fix | Delete
return $abtest->get_variation( $experiment_name ) === 'treatment' ||
[235] Fix | Delete
$abtest->get_variation( $experiment_name_2col ) === 'treatment';
[236] Fix | Delete
}
[237] Fix | Delete
[238] Fix | Delete
/**
[239] Fix | Delete
* Prepare objects query.
[240] Fix | Delete
*
[241] Fix | Delete
* @param WP_REST_Request $request Full details about the request.
[242] Fix | Delete
* @return array
[243] Fix | Delete
*/
[244] Fix | Delete
protected function prepare_objects_query( $request ) {
[245] Fix | Delete
$args = array();
[246] Fix | Delete
$args['order'] = $request['order'];
[247] Fix | Delete
$args['orderby'] = $request['orderby'];
[248] Fix | Delete
$args['per_page'] = $request['per_page'];
[249] Fix | Delete
$args['page'] = $request['page'];
[250] Fix | Delete
$args['type'] = isset( $request['type'] ) ? $request['type'] : array();
[251] Fix | Delete
$args['status'] = isset( $request['status'] ) ? $request['status'] : array();
[252] Fix | Delete
$args['source'] = isset( $request['source'] ) ? $request['source'] : array();
[253] Fix | Delete
$args['is_deleted'] = 0;
[254] Fix | Delete
[255] Fix | Delete
if ( isset( $request['is_read'] ) ) {
[256] Fix | Delete
$args['is_read'] = filter_var( $request['is_read'], FILTER_VALIDATE_BOOLEAN );
[257] Fix | Delete
}
[258] Fix | Delete
[259] Fix | Delete
if ( 'date' === $args['orderby'] ) {
[260] Fix | Delete
$args['orderby'] = 'date_created';
[261] Fix | Delete
}
[262] Fix | Delete
[263] Fix | Delete
/**
[264] Fix | Delete
* Filter the query arguments for a request.
[265] Fix | Delete
*
[266] Fix | Delete
* Enables adding extra arguments or setting defaults for a post
[267] Fix | Delete
* collection request.
[268] Fix | Delete
*
[269] Fix | Delete
* @param array $args Key value array of query var to query value.
[270] Fix | Delete
* @param WP_REST_Request $request The request used.
[271] Fix | Delete
* @since 3.9.0
[272] Fix | Delete
*/
[273] Fix | Delete
$args = apply_filters( 'woocommerce_rest_notes_object_query', $args, $request );
[274] Fix | Delete
[275] Fix | Delete
return $args;
[276] Fix | Delete
}
[277] Fix | Delete
[278] Fix | Delete
/**
[279] Fix | Delete
* Check whether a given request has permission to read a single note.
[280] Fix | Delete
*
[281] Fix | Delete
* @param WP_REST_Request $request Full details about the request.
[282] Fix | Delete
* @return WP_Error|boolean
[283] Fix | Delete
*/
[284] Fix | Delete
public function get_item_permissions_check( $request ) {
[285] Fix | Delete
if ( ! wc_rest_check_manager_permissions( 'system_status', 'read' ) ) {
[286] Fix | Delete
return new \WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
[287] Fix | Delete
}
[288] Fix | Delete
[289] Fix | Delete
return true;
[290] Fix | Delete
}
[291] Fix | Delete
[292] Fix | Delete
/**
[293] Fix | Delete
* Check whether a given request has permission to read notes.
[294] Fix | Delete
*
[295] Fix | Delete
* @param WP_REST_Request $request Full details about the request.
[296] Fix | Delete
* @return WP_Error|boolean
[297] Fix | Delete
*/
[298] Fix | Delete
public function get_items_permissions_check( $request ) {
[299] Fix | Delete
if ( ! wc_rest_check_manager_permissions( 'system_status', 'read' ) ) {
[300] Fix | Delete
return new \WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
[301] Fix | Delete
}
[302] Fix | Delete
[303] Fix | Delete
return true;
[304] Fix | Delete
}
[305] Fix | Delete
[306] Fix | Delete
/**
[307] Fix | Delete
* Update a single note.
[308] Fix | Delete
*
[309] Fix | Delete
* @param WP_REST_Request $request Full details about the request.
[310] Fix | Delete
* @return WP_REST_Request|WP_Error
[311] Fix | Delete
*/
[312] Fix | Delete
public function update_item( $request ) {
[313] Fix | Delete
$note = NotesRepository::get_note( $request->get_param( 'id' ) );
[314] Fix | Delete
[315] Fix | Delete
if ( ! $note ) {
[316] Fix | Delete
return new \WP_Error(
[317] Fix | Delete
'woocommerce_note_invalid_id',
[318] Fix | Delete
__( 'Sorry, there is no resource with that ID.', 'woocommerce' ),
[319] Fix | Delete
array( 'status' => 404 )
[320] Fix | Delete
);
[321] Fix | Delete
}
[322] Fix | Delete
[323] Fix | Delete
NotesRepository::update_note( $note, $this->get_requested_updates( $request ) );
[324] Fix | Delete
return $this->get_item( $request );
[325] Fix | Delete
}
[326] Fix | Delete
[327] Fix | Delete
/**
[328] Fix | Delete
* Delete a single note.
[329] Fix | Delete
*
[330] Fix | Delete
* @param WP_REST_Request $request Full details about the request.
[331] Fix | Delete
* @return WP_REST_Request|WP_Error
[332] Fix | Delete
*/
[333] Fix | Delete
public function delete_item( $request ) {
[334] Fix | Delete
$note = NotesRepository::get_note( $request->get_param( 'id' ) );
[335] Fix | Delete
[336] Fix | Delete
if ( ! $note ) {
[337] Fix | Delete
return new \WP_Error(
[338] Fix | Delete
'woocommerce_note_invalid_id',
[339] Fix | Delete
__( 'Sorry, there is no note with that ID.', 'woocommerce' ),
[340] Fix | Delete
array( 'status' => 404 )
[341] Fix | Delete
);
[342] Fix | Delete
}
[343] Fix | Delete
[344] Fix | Delete
NotesRepository::delete_note( $note );
[345] Fix | Delete
$data = $this->prepare_note_data_for_response( $note, $request );
[346] Fix | Delete
return rest_ensure_response( $data );
[347] Fix | Delete
}
[348] Fix | Delete
[349] Fix | Delete
/**
[350] Fix | Delete
* Delete all notes.
[351] Fix | Delete
*
[352] Fix | Delete
* @param WP_REST_Request $request Request object.
[353] Fix | Delete
* @return WP_REST_Request|WP_Error
[354] Fix | Delete
*/
[355] Fix | Delete
public function delete_all_items( $request ) {
[356] Fix | Delete
$args = array();
[357] Fix | Delete
if ( isset( $request['status'] ) ) {
[358] Fix | Delete
$args['status'] = $request['status'];
[359] Fix | Delete
}
[360] Fix | Delete
$notes = NotesRepository::delete_all_notes( $args );
[361] Fix | Delete
$data = array();
[362] Fix | Delete
foreach ( (array) $notes as $note_obj ) {
[363] Fix | Delete
$data[] = $this->prepare_note_data_for_response( $note_obj, $request );
[364] Fix | Delete
}
[365] Fix | Delete
[366] Fix | Delete
$response = rest_ensure_response( $data );
[367] Fix | Delete
$response->header( 'X-WP-Total', NotesRepository::get_notes_count( array( 'info', 'warning' ), array() ) );
[368] Fix | Delete
return $response;
[369] Fix | Delete
}
[370] Fix | Delete
[371] Fix | Delete
/**
[372] Fix | Delete
* Prepare note data.
[373] Fix | Delete
*
[374] Fix | Delete
* @param Note $note Note data.
[375] Fix | Delete
* @param WP_REST_Request $request Request object.
[376] Fix | Delete
*
[377] Fix | Delete
* @return WP_REST_Response $response Response data.
[378] Fix | Delete
*/
[379] Fix | Delete
public function prepare_note_data_for_response( $note, $request ) {
[380] Fix | Delete
$note = $note->get_data();
[381] Fix | Delete
$note = $this->prepare_item_for_response( $note, $request );
[382] Fix | Delete
return $this->prepare_response_for_collection( $note );
[383] Fix | Delete
}
[384] Fix | Delete
[385] Fix | Delete
/**
[386] Fix | Delete
* Prepare an array with the requested updates.
[387] Fix | Delete
*
[388] Fix | Delete
* @param WP_REST_Request $request Request object.
[389] Fix | Delete
* @return array A list of the requested updates values.
[390] Fix | Delete
*/
[391] Fix | Delete
protected function get_requested_updates( $request ) {
[392] Fix | Delete
$requested_updates = array();
[393] Fix | Delete
if ( ! is_null( $request->get_param( 'status' ) ) ) {
[394] Fix | Delete
$requested_updates['status'] = $request->get_param( 'status' );
[395] Fix | Delete
}
[396] Fix | Delete
[397] Fix | Delete
if ( ! is_null( $request->get_param( 'date_reminder' ) ) ) {
[398] Fix | Delete
$requested_updates['date_reminder'] = $request->get_param( 'date_reminder' );
[399] Fix | Delete
}
[400] Fix | Delete
[401] Fix | Delete
if ( ! is_null( $request->get_param( 'is_deleted' ) ) ) {
[402] Fix | Delete
$requested_updates['is_deleted'] = $request->get_param( 'is_deleted' );
[403] Fix | Delete
}
[404] Fix | Delete
[405] Fix | Delete
if ( ! is_null( $request->get_param( 'is_read' ) ) ) {
[406] Fix | Delete
$requested_updates['is_read'] = $request->get_param( 'is_read' );
[407] Fix | Delete
}
[408] Fix | Delete
[409] Fix | Delete
return $requested_updates;
[410] Fix | Delete
}
[411] Fix | Delete
[412] Fix | Delete
/**
[413] Fix | Delete
* Batch update a set of notes.
[414] Fix | Delete
*
[415] Fix | Delete
* @param WP_REST_Request $request Request object.
[416] Fix | Delete
* @return WP_REST_Request|WP_Error
[417] Fix | Delete
*/
[418] Fix | Delete
public function batch_update_items( $request ) {
[419] Fix | Delete
$data = array();
[420] Fix | Delete
$note_ids = $request->get_param( 'noteIds' );
[421] Fix | Delete
[422] Fix | Delete
if ( ! isset( $note_ids ) || ! is_array( $note_ids ) ) {
[423] Fix | Delete
return new \WP_Error(
[424] Fix | Delete
'woocommerce_note_invalid_ids',
[425] Fix | Delete
__( 'Please provide an array of IDs through the noteIds param.', 'woocommerce' ),
[426] Fix | Delete
array( 'status' => 422 )
[427] Fix | Delete
);
[428] Fix | Delete
}
[429] Fix | Delete
[430] Fix | Delete
foreach ( (array) $note_ids as $note_id ) {
[431] Fix | Delete
$note = NotesRepository::get_note( (int) $note_id );
[432] Fix | Delete
if ( $note ) {
[433] Fix | Delete
NotesRepository::update_note( $note, $this->get_requested_updates( $request ) );
[434] Fix | Delete
$data[] = $this->prepare_note_data_for_response( $note, $request );
[435] Fix | Delete
}
[436] Fix | Delete
}
[437] Fix | Delete
[438] Fix | Delete
$response = rest_ensure_response( $data );
[439] Fix | Delete
$response->header( 'X-WP-Total', NotesRepository::get_notes_count( array( 'info', 'warning' ), array() ) );
[440] Fix | Delete
return $response;
[441] Fix | Delete
}
[442] Fix | Delete
[443] Fix | Delete
/**
[444] Fix | Delete
* Activate a promo note, create if not exist.
[445] Fix | Delete
*
[446] Fix | Delete
* @param WP_REST_Request $request Request object.
[447] Fix | Delete
* @return WP_REST_Request|WP_Error
[448] Fix | Delete
*/
[449] Fix | Delete
public function activate_promo_note( $request ) {
[450] Fix | Delete
/**
[451] Fix | Delete
* Filter allowed promo notes for experimental-activate-promo.
[452] Fix | Delete
*
[453] Fix | Delete
* @param array $promo_notes Array of allowed promo notes.
[454] Fix | Delete
* @since 7.8.0
[455] Fix | Delete
*/
[456] Fix | Delete
$allowed_promo_notes = apply_filters( 'woocommerce_admin_allowed_promo_notes', [] );
[457] Fix | Delete
[458] Fix | Delete
$promo_note_name = $request->get_param( 'promo_note_name' );
[459] Fix | Delete
[460] Fix | Delete
if ( ! in_array( $promo_note_name, $allowed_promo_notes, true ) ) {
[461] Fix | Delete
return new \WP_Error(
[462] Fix | Delete
'woocommerce_note_invalid_promo_note_name',
[463] Fix | Delete
__( 'Please provide a valid promo note name.', 'woocommerce' ),
[464] Fix | Delete
array( 'status' => 422 )
[465] Fix | Delete
);
[466] Fix | Delete
}
[467] Fix | Delete
[468] Fix | Delete
$data_store = NotesRepository::load_data_store();
[469] Fix | Delete
$note_ids = $data_store->get_notes_with_name( $promo_note_name );
[470] Fix | Delete
[471] Fix | Delete
if ( empty( $note_ids ) ) {
[472] Fix | Delete
// Promo note doesn't exist, this could happen in cases where
[473] Fix | Delete
// user might have disabled RemoteInboxNotications via disabling
[474] Fix | Delete
// marketing suggestions. Thus we'd have to manually add the note.
[475] Fix | Delete
$note = new Note();
[476] Fix | Delete
$note->set_name( $promo_note_name );
[477] Fix | Delete
$note->set_status( Note::E_WC_ADMIN_NOTE_ACTIONED );
[478] Fix | Delete
$data_store->create( $note );
[479] Fix | Delete
} else {
[480] Fix | Delete
$note = NotesRepository::get_note( $note_ids[0] );
[481] Fix | Delete
NotesRepository::update_note(
[482] Fix | Delete
$note,
[483] Fix | Delete
[
[484] Fix | Delete
'status' => Note::E_WC_ADMIN_NOTE_ACTIONED,
[485] Fix | Delete
]
[486] Fix | Delete
);
[487] Fix | Delete
}
[488] Fix | Delete
[489] Fix | Delete
return rest_ensure_response(
[490] Fix | Delete
array(
[491] Fix | Delete
'success' => true,
[492] Fix | Delete
)
[493] Fix | Delete
);
[494] Fix | Delete
}
[495] Fix | Delete
[496] Fix | Delete
/**
[497] Fix | Delete
* Makes sure the current user has access to WRITE the settings APIs.
[498] Fix | Delete
*
[499] Fix | Delete
12
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
Function