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

153 lines
4.1 KiB
PHP

<?php
/**
* Define common connection arguments for CPT connections.
*
* @package WPGraphQL\WooCommerce\Connection
* @since 0.2.2
*/
namespace WPGraphQL\WooCommerce\Connection;
/**
* Returns argument definitions for argument common on CPT connections.
*
* @return array
*/
function get_wc_cpt_connection_args(): array {
return [
'search' => [
'type' => 'String',
'description' => static function () {
return __( 'Limit results to those matching a string.', 'graphql-for-ecommerce' );
},
],
'exclude' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Ensure result set excludes specific IDs.', 'graphql-for-ecommerce' );
},
],
'include' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Limit result set to specific ids.', 'graphql-for-ecommerce' );
},
],
'orderby' => [
'type' => [ 'list_of' => 'PostTypeOrderbyInput' ],
'description' => static function () {
return __( 'What paramater to use to order the objects by.', 'graphql-for-ecommerce' );
},
],
'dateQuery' => [
'type' => 'DateQueryInput',
'description' => static function () {
return __( 'Filter the connection based on dates.', 'graphql-for-ecommerce' );
},
],
'parent' => [
'type' => 'Int',
'description' => static function () {
return __( 'Use ID to return only children. Use 0 to return only top-level items.', 'graphql-for-ecommerce' );
},
],
'parentIn' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Specify objects whose parent is in an array.', 'graphql-for-ecommerce' );
},
],
'parentNotIn' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Specify objects whose parent is not in an array.', 'graphql-for-ecommerce' );
},
],
];
}
/**
* Sanitizes common post-type connection query input.
*
* @param array $input Input to be sanitize.
* @param array $ordering_meta Meta types used for ordering results.
*
* @return array
*/
function map_shared_input_fields_to_wp_query( array $input, $ordering_meta = [] ) {
$args = [];
if ( ! empty( $input['include'] ) ) {
$args['post__in'] = $input['include'];
}
if ( ! empty( $input['exclude'] ) ) {
$args['post__not_in'] = $input['exclude'];
}
if ( ! empty( $input['parent'] ) ) {
$args['post_parent'] = $input['parent'];
}
if ( ! empty( $input['parentIn'] ) ) {
$args['post_parent__in'] = $input['parentIn'];
}
if ( ! empty( $input['parentNotIn'] ) ) {
$args['post_parent__not_in'] = $input['parentNotIn'];
}
if ( ! empty( $input['search'] ) ) {
$args['s'] = $input['search'];
}
/**
* Map the orderby inputArgs to the WP_Query
*/
if ( ! empty( $input['orderby'] ) && is_array( $input['orderby'] ) ) {
$args['orderby'] = [];
foreach ( $input['orderby'] as $orderby_input ) {
/**
* Stores orderby field
*
* @var null|string $orderby_field
*/
$orderby_field = isset( $orderby_input['field'] ) ? (string) $orderby_input['field'] : null;
if ( null === $orderby_field ) {
continue;
}
$default_order = 'ASC';
/**
* Stores orderby direction
*
* @var string $orderby_order
*/
$orderby_order = isset( $orderby_input['order'] ) ? $orderby_input['order'] : $default_order;
/**
* These orderby options should not include the order parameter.
*/
$post_fields = [ 'post__in', 'post_name__in', 'post_parent__in' ];
if ( in_array( $orderby_field, $post_fields, true ) ) {
$args['orderby'][ $orderby_field ] = $orderby_order;
// Handle meta fields.
} elseif ( in_array( $orderby_field, $ordering_meta, true ) ) {
$args['orderby']['meta_value_num'] = $orderby_order;
// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
$args['meta_key'] = $orderby_field;
} else {
$args['orderby'][ $orderby_field ] = $orderby_order;
}
}//end foreach
}//end if
if ( ! empty( $input['dateQuery'] ) ) {
$args['date_query'] = $input['dateQuery'];
}
return $args;
}