Files
wp-graphql-woocommerce/includes/mutation/class-shipping-zone-locations-update.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

145 lines
3.8 KiB
PHP

<?php
/**
* Mutation - clearShippingZoneLocations
*
* Registers mutation for update the registered shipping locations on a shipping zone.
*
* @package WPGraphQL\WooCommerce\Mutation
* @since 0.20.0
*/
namespace WPGraphQL\WooCommerce\Mutation;
use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ResolveInfo;
use WPGraphQL\AppContext;
/**
* Class - Shipping_Zone_Locations_Update
*/
class Shipping_Zone_Locations_Update {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
register_graphql_mutation(
'updateShippingZoneLocations',
[
'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 [
'zoneId' => [
'type' => [ 'non_null' => 'Int' ],
'description' => static function () {
return __( 'The ID of the shipping zone to delete.', 'graphql-for-ecommerce' );
},
],
'locations' => [
'type' => [ 'list_of' => 'ShippingLocationInput' ],
'description' => static function () {
return __( 'The locations to add to the shipping zone.', 'graphql-for-ecommerce' );
},
],
];
}
/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields() {
return [
'shippingZone' => [
'type' => 'ShippingZone',
'resolve' => static function ( $payload, array $args, AppContext $context ) {
return $context->get_loader( 'shipping_zone' )->load( $payload['zone_id'] );
},
],
'locations' => [
'type' => [ 'list_of' => 'ShippingLocation' ],
'resolve' => static function ( $payload ) {
return ! empty( $payload['locations'] )
? array_map(
static function ( $location ) {
return (object) $location;
},
$payload['locations'],
)
: [];
},
],
];
}
/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload() {
return static function ( $input, AppContext $context, ResolveInfo $info ) {
if ( ! \wc_shipping_enabled() ) {
throw new UserError( __( 'Shipping is disabled.', 'graphql-for-ecommerce' ), 404 );
}
if ( ! \wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
throw new UserError( __( 'Sorry, you are not allowed to update shipping location', 'graphql-for-ecommerce' ), \rest_authorization_required_code() );
}
$zone_id = $input['zoneId'];
/** @var \WC_Shipping_Zone|false $zone */
$zone = \WC_Shipping_Zones::get_zone_by( 'zone_id', $zone_id );
if ( false === $zone ) {
throw new UserError( __( 'Invalid shipping zone ID.', 'graphql-for-ecommerce' ) );
}
if ( 0 === $zone->get_id() ) {
throw new UserError( __( 'Invalid shipping zone ID.', 'graphql-for-ecommerce' ) );
}
$raw_locations = ! empty( $input['locations'] ) ? $input['locations'] : [];
$locations = [];
foreach ( $raw_locations as $location ) {
$type = ! empty( $location['type'] ) ? $location['type'] : 'country';
$locations[] = [
'type' => $type,
'code' => $location['code'],
];
}
/**
* Filter zone object before add the locations.
*
* @param \WC_Shipping_Zone $zone The response object.
* @param array $locations Locations to be saved.
* @param array $input Request input.
*/
$zone = apply_filters( 'graphql_woocommerce_shipping_zone_locations_update', $zone, $locations, $input );
$zone->set_locations( $locations );
$zone->save();
return [
'zone_id' => $zone_id,
'locations' => $locations,
];
};
}
}