Files
wp-graphql-woocommerce/includes/mutation/class-review-delete-restore.php
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

178 lines
4.6 KiB
PHP

<?php
/**
* Mutation - deleteReview
*
* Registers mutations for trashing/deleting/restore a product review.
*
* @package WPGraphQL\WooCommerce\Mutation
* @since 0.5.1
*/
namespace WPGraphQL\WooCommerce\Mutation;
use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ResolveInfo;
use GraphQLRelay\Relay;
use WPGraphQL\AppContext;
use WPGraphQL\Utils\Utils;
/**
* Class Review_Delete_Restore
*/
class Review_Delete_Restore {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
// Trash/Delete mutation.
register_graphql_mutation(
'deleteReview',
[
'inputFields' => self::get_input_fields( true ),
'outputFields' => self::get_output_fields(),
'mutateAndGetPayload' => self::mutate_and_get_payload(),
]
);
// Restore mutation.
register_graphql_mutation(
'restoreReview',
[
'inputFields' => self::get_input_fields(),
'outputFields' => self::get_output_fields( true ),
'mutateAndGetPayload' => self::mutate_and_get_payload(),
]
);
}
/**
* Defines the mutation input field configuration.
*
* @param bool $delete Whether the `forceDelete` flag should be included.
*
* @return array
*/
public static function get_input_fields( $delete = false ) {
$fields = [
'id' => [
'type' => [
'non_null' => 'ID',
],
'description' => static function () {
return __( 'The ID of the target product review', 'graphql-for-ecommerce' );
},
],
];
if ( $delete ) {
$fields['forceDelete'] = [
'type' => 'Boolean',
'description' => static function () {
return __( 'Whether the product review should be force deleted instead of being moved to the trash', 'graphql-for-ecommerce' );
},
];
}
return $fields;
}
/**
* Defines the mutation output field configuration.
*
* @param bool $restore Whether the restored review should be resolved.
*
* @return array
*/
public static function get_output_fields( $restore = false ) {
return [
'rating' => [
'type' => 'Float',
'description' => static function () {
return __( 'The product rating of the affected product review', 'graphql-for-ecommerce' );
},
'resolve' => static function ( $payload ) {
if ( ! isset( $payload['rating'] ) ) {
return null;
}
return floatval( $payload['rating'] );
},
],
'affectedId' => [
'type' => 'Id',
'description' => static function () {
return __( 'The affected product review ID', 'graphql-for-ecommerce' );
},
'resolve' => static function ( $payload ) {
$deleted = (object) $payload['commentObject'];
return ! empty( $deleted->comment_ID ) ? Relay::toGlobalId( 'comment', (string) $deleted->comment_ID ) : null;
},
],
'review' => [
'type' => 'Comment',
'description' => static function () {
return __( 'The affected product review', 'graphql-for-ecommerce' );
},
'resolve' => static function ( $payload, $args, AppContext $context ) use ( $restore ) {
if ( empty( $payload['commentObject'] ) ) {
return null;
}
if ( $restore ) {
return ! empty( $payload['commentObject']->comment_ID )
? $context->get_loader( 'comment' )->load_deferred( $payload['commentObject']->comment_ID )
: null;
}
return $payload['commentObject'];
},
],
];
}
/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload() {
return static function ( $input, AppContext $context, ResolveInfo $info ) {
// Retrieve the product review rating for the payload.
$id = Utils::get_database_id_from_id( $input['id'] );
if ( ! $id ) {
throw new UserError( __( 'Invalid Product Review ID provided', 'graphql-for-ecommerce' ) );
}
$rating = get_comment_meta( absint( $id ), 'rating', true );
// @codingStandardsIgnoreLine
switch ( $info->fieldName ) {
case 'deleteReview':
$classname = '\WPGraphQL\Mutation\CommentDelete';
break;
case 'restoreReview':
$classname = '\WPGraphQL\Mutation\CommentRestore';
break;
}
if ( empty( $classname ) || ! class_exists( $classname ) ) {
throw new UserError( __( 'Failed to find mutation resolver. Please contact site adminstrator', 'graphql-for-ecommerce' ) );
}
// Get the comment mutation resolver.
$resolver = $classname::mutate_and_get_payload();
// Execute and retrieve payload.
$payload = $resolver( $input, $context, $info );
// Add rating to payload.
$payload['rating'] = $rating;
return $payload;
};
}
}