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

158 lines
4.4 KiB
PHP

<?php
/**
* Connection - Coupons
*
* Registers connections to Coupon
*
* @package WPGraphQL\WooCommerce\Connection
*/
namespace WPGraphQL\WooCommerce\Connection;
use WPGraphQL\Data\Connection\PostObjectConnectionResolver;
/**
* Class - Coupons
*/
class Coupons {
/**
* Registers the various connections from other Types to Coupon
*
* @return void
*/
public static function register_connections() {
// From RootQuery.
register_graphql_connection( self::get_connection_config() );
}
/**
* Given an array of $args, this returns the connection config, merging the provided args
* with the defaults.
*
* @param array $args - Connection configuration.
* @return array
*/
public static function get_connection_config( $args = [] ): array {
return array_merge(
[
'fromType' => 'RootQuery',
'toType' => 'Coupon',
'fromFieldName' => 'coupons',
'connectionArgs' => self::get_connection_args(),
'resolve' => static function ( $source, $args, $context, $info ) {
$resolver = new PostObjectConnectionResolver( $source, $args, $context, $info, 'shop_coupon' );
if ( ! self::should_execute() ) {
return [
'edges' => [],
'nodes' => [],
];
}
return $resolver->get_connection();
},
],
$args
);
}
/**
* Confirms the uses has the privileges to query Coupons
*
* @return bool
*/
public static function should_execute() {
/**
* Get coupon post type.
*
* @var \WP_Post_Type $post_type_obj
*/
$post_type_obj = get_post_type_object( 'shop_coupon' );
switch ( true ) {
case current_user_can( $post_type_obj->cap->edit_posts ):
return true;
default:
return false;
}
}
/**
* Returns array of where args.
*
* @return array
*/
public static function get_connection_args(): array {
return array_merge(
get_wc_cpt_connection_args(),
[
'code' => [
'type' => 'String',
'description' => static function () {
return __( 'Limit result set to resources with a specific code.', 'graphql-for-ecommerce' );
},
],
]
);
}
/**
* This allows plugins/themes to hook in and alter what $args should be allowed to be passed
* from a GraphQL Query to the WP_Query
*
* @param array $query_args The mapped query arguments.
* @param array $where_args Query "where" args.
* @param mixed $source The query results for a query calling this.
* @param array $args All of the arguments for the query (not just the "where" args).
* @param \WPGraphQL\AppContext $context The AppContext object.
* @param \GraphQL\Type\Definition\ResolveInfo $info The ResolveInfo object.
* @param mixed|string|array $post_type The post type for the query.
*
* @return array Query arguments.
*/
public static function map_input_fields_to_wp_query( $query_args, $where_args, $source, $args, $context, $info, $post_type ) {
$not_coupon_query = is_string( $post_type )
? 'shop_coupon' !== $post_type
: ! in_array( 'shop_coupon', $post_type, true );
if ( $not_coupon_query ) {
return $query_args;
}
$query_args = array_merge(
$query_args,
map_shared_input_fields_to_wp_query( $where_args )
);
if ( ! empty( $where_args['code'] ) ) {
$id = \wc_get_coupon_id_by_code( $where_args['code'] );
$ids = $id ? [ $id ] : [ '0' ];
$query_args['post__in'] = ! empty( $query_args['post__in'] )
? array_intersect( $ids, $query_args['post__in'] )
: $ids;
}
/**
* Filter the input fields
* This allows plugins/themes to hook in and alter what $args should be allowed to be passed
* from a GraphQL Query to the WP_Query
*
* @param array $args The mapped query arguments
* @param array $where_args Query "where" args
* @param mixed $source The query results for a query calling this
* @param array $all_args All of the arguments for the query (not just the "where" args)
* @param \WPGraphQL\AppContext $context The AppContext object
* @param \GraphQL\Type\Definition\ResolveInfo $info The ResolveInfo object
*/
$query_args = apply_filters(
'graphql_map_input_fields_to_coupon_query',
$query_args,
$where_args,
$source,
$args,
$context,
$info
);
return $query_args;
}
}