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

167 lines
4.0 KiB
PHP

<?php
/**
* Mutation - updateWCSetting
*
* Registers mutation for updating a single WooCommerce setting.
*
* @package WPGraphQL\WooCommerce\Mutation
* @since 1.0.0
*/
namespace WPGraphQL\WooCommerce\Mutation;
use GraphQL\Error\UserError;
use WPGraphQL\WooCommerce\Data\Mutation\Settings_Mutation;
/**
* Class Setting_Update
*/
class Setting_Update {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
register_graphql_mutation(
'updateWCSetting',
[
'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 [
'group' => [
'type' => [ 'non_null' => 'String' ],
'description' => static function () {
return __( 'Settings group ID.', 'graphql-for-ecommerce' );
},
],
'id' => [
'type' => [ 'non_null' => 'String' ],
'description' => static function () {
return __( 'Setting ID.', 'graphql-for-ecommerce' );
},
],
'value' => [
'type' => [ 'non_null' => 'String' ],
'description' => static function () {
return __( 'Setting value.', 'graphql-for-ecommerce' );
},
],
];
}
/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields() {
return [
'setting' => [
'type' => 'WCSetting',
'description' => static function () {
return __( 'The updated setting.', 'graphql-for-ecommerce' );
},
'resolve' => static function ( $payload ) {
return $payload['setting'];
},
],
];
}
/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload() {
return static function ( $input ) {
if ( ! \wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
throw new UserError( __( 'Sorry, you cannot update settings.', 'graphql-for-ecommerce' ) );
}
$group_id = $input['group'];
$setting_id = $input['id'];
$value = $input['value'];
$controller = new \WC_REST_Setting_Options_Controller();
/** @var array|\WP_Error $setting */
$setting = $controller->get_setting( $group_id, $setting_id );
if ( is_wp_error( $setting ) ) {
throw new UserError( $setting->get_error_message() );
}
$validated = self::validate_value( $value, $setting );
self::save_setting( $setting, $validated );
/** @var array|\WP_Error $updated */
$updated = $controller->get_setting( $group_id, $setting_id );
if ( is_wp_error( $updated ) ) {
throw new UserError( $updated->get_error_message() );
}
return [ 'setting' => $updated ];
};
}
/**
* Validate a setting value based on its type.
*
* @param mixed $value Value to validate.
* @param array $setting Setting definition.
*
* @throws \GraphQL\Error\UserError If validation fails.
*
* @return mixed
*/
public static function validate_value( $value, $setting ) {
$type = $setting['type'];
$method = 'validate_setting_' . $type . '_field';
if ( method_exists( Settings_Mutation::class, $method ) ) {
return Settings_Mutation::$method( $value, $setting );
}
return Settings_Mutation::validate_setting_text_field( $value, $setting );
}
/**
* Save a validated setting value.
*
* @param array $setting Setting definition.
* @param mixed $value Validated value.
*
* @return void
*/
public static function save_setting( $setting, $value ) {
$option_key = $setting['option_key'];
if ( is_array( $option_key ) ) {
$option = get_option( $option_key[0], [] );
if ( ! is_array( $option ) ) {
$option = [];
}
$option[ $option_key[1] ] = $value;
update_option( $option_key[0], $option );
} else {
\WC_Admin_Settings::save_fields(
[ $setting ],
[ $setting['id'] => $value ]
);
}
}
}