Files
Geoff TaylorandGitHub 088d337ef5 fix: address WordPress.org plugin review (rename + prefixing + headers) (#1019)
* fix: address WordPress.org plugin review feedback

- Prefix the session transaction queue transient with the plugin's
  graphql_woocommerce_ namespace instead of the generic "woo_" word, to
  avoid collisions (Plugin Directory: prefix data storage).
- Declare the WooCommerce dependency via the "Requires Plugins: woocommerce"
  plugin header.
- Bump README.txt "Tested up to" to 7.0.
- Ship composer.json in the distributed plugin (drop it, and composer.lock,
  from composer archive excludes) so the build is reproducible/reviewable.

* chore: rename plugin to "GraphQL for eCommerce" for trademark compliance

The WordPress.org plugin review flagged the display name/slug for beginning
with the "WPGraphQL" trademark (and the "WooGraphQL" portmanteau of the
WooCommerce mark), which can imply official affiliation.

- Display name (plugin header + readme title) -> "GraphQL for eCommerce".
- Slug/text domain -> "graphql-for-ecommerce" (header, all i18n string
  literals, and the PHPCS WordPress.WP.I18n text_domain config).
- Update user-facing notices/errors that named the old plugin.

"WooGraphQL" remains the project's informal nickname (repo, docs, community),
just not in the WordPress.org directory's official name/slug. Internal file
names and GitHub URLs are unchanged.

* fix: keep test-only dev deps out of the committed composer.json

The committed manifest mirrors develop (lint/stan dev deps only); CI adds the
test suite deps at runtime via `composer installTestEnv`. A previous commit
captured the installTestEnv-modified composer.json, desyncing it from
composer.lock and breaking `composer install` in CI.

* chore: regenerate composer.lock (refresh dev dependencies)

Regenerate the lock from the manifest so it is in sync (fixes the CI
`composer install` failure) and refresh dependencies in the process —
firebase/php-jwt v7.0.4 -> v7.1.0 plus 11 others, with vendor-prefixed
re-strauss'd to match. Full wpunit suite passes against the updated deps
(305 tests, 835 assertions).

* chore: rename text domain in createdVia/attribution strings from #1018

#1018 (createdVia + order attribution) merged into develop after the rename
commit was authored, so its new i18n strings still used the old
'wp-graphql-woocommerce' text domain. Update them to 'graphql-for-ecommerce'
to match the rename.
2026-06-30 10:16:21 -04:00

150 lines
3.8 KiB
PHP

<?php
/**
* Mutation - deleteOrderNote
*
* Registers mutation for delete an order note.
*
* @package WPGraphQL\WooCommerce\Mutation
* @since 1.0.0
*/
namespace WPGraphQL\WooCommerce\Mutation;
use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ResolveInfo;
use WPGraphQL\AppContext;
use WPGraphQL\Model\Comment;
use WPGraphQL\Utils\Utils;
use WPGraphQL\WooCommerce\Data\Mutation\Order_Mutation;
use WPGraphQL\WooCommerce\Model\Order;
/**
* Class Order_Note_Delete
*/
class Order_Note_Delete {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
register_graphql_mutation(
'deleteOrderNote',
[
'inputFields' => self::get_input_fields(),
'outputFields' => self::get_output_fields(),
'mutateAndGetPayload' => self::mutate_and_get_payload(),
]
);
}
/**
* Defines the mutation input field configuration
*
* @return array
*/
public static function get_input_fields() {
return [
'id' => [
'type' => 'ID',
'description' => static function () {
return __( 'Database ID or global ID of the order note', 'graphql-for-ecommerce' );
},
],
'orderId' => [
'type' => 'ID',
'description' => static function () {
return __( 'Database ID or global ID of the order', 'graphql-for-ecommerce' );
},
],
'force' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Delete or simply place in trash.', 'graphql-for-ecommerce' );
},
],
];
}
/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields() {
return [
'orderNote' => [
'type' => 'OrderNote',
'resolve' => static function ( $payload ) {
return new Comment( $payload['note'] );
},
],
'order' => [
'type' => 'Order',
'resolve' => static function ( $payload ) {
return new Order( $payload['order_id'] );
},
],
];
}
/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload() {
return static function ( $input, AppContext $context, ResolveInfo $info ) {
// Retrieve order ID.
$order_id = Utils::get_database_id_from_id( $input['orderId'] );
if ( ! $order_id ) {
throw new UserError( __( 'Order ID provided is invalid. Please check input and try again.', 'graphql-for-ecommerce' ) );
}
// Check if authorized to delete this order note.
if ( ! Order_Mutation::authorized( $input, $context, $info, 'delete', $order_id ) ) {
throw new UserError( __( 'User does not have the capabilities necessary to delete an order.', 'graphql-for-ecommerce' ) );
}
if ( isset( $input['forceDelete'] ) && false === $input['forceDelete'] ) {
throw new UserError( __( 'woocommerce_rest_trash_not_supported', 'graphql-for-ecommerce' ) );
}
/**
* Get Order model instance for output.
*
* @var \WC_Order $order
*/
$order = new Order( $order_id );
if ( ! $order ) {
throw new UserError( __( 'Invalid order ID.', 'graphql-for-ecommerce' ) );
}
$id = Utils::get_database_id_from_id( $input['id'] );
if ( ! $id ) {
throw new UserError( __( 'Order note ID provided is invalid. Please check input and try again.', 'graphql-for-ecommerce' ) );
}
$note = get_comment( $id );
if ( empty( $note ) || intval( $note->comment_post_ID ) !== intval( $order->get_id() ) ) {
throw new UserError( __( 'Invalid resource ID.', 'graphql-for-ecommerce' ) );
}
$comment_id = absint( $note->comment_ID );
$result = wc_delete_order_note( $comment_id );
if ( ! $result ) {
throw new UserError( __( 'Unable to delete order note.', 'graphql-for-ecommerce' ) );
}
return [
'order_id' => $order_id,
'note' => $note,
];
};
}
}