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

620 lines
18 KiB
PHP

<?php
/**
* Mutation - createProduct
*
* Registers mutation for creating a product.
*
* @package WPGraphQL\WooCommerce\Mutation
* @since 1.0.0
*/
namespace WPGraphQL\WooCommerce\Mutation;
use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ResolveInfo;
use WPGraphQL\AppContext;
use WPGraphQL\WooCommerce\Data\Mutation\Product_Mutation;
use WPGraphQL\WooCommerce\Model\Product;
/**
* Class Product_Create
*/
class Product_Create {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
register_graphql_mutation(
'createProduct',
[
'inputFields' => self::get_input_fields(),
'outputFields' => self::get_output_fields(),
'mutateAndGetPayload' => [ self::class, 'mutate_and_get_payload' ],
]
);
}
/**
* Defines the mutation input field configuration
*
* @return array
*/
public static function get_input_fields() {
return [
'name' => [
'type' => [ 'non_null' => 'String' ],
'description' => static function () {
return __( 'Name of the product.', 'graphql-for-ecommerce' );
},
],
'slug' => [
'type' => 'String',
'description' => static function () {
return __( 'Product slug.', 'graphql-for-ecommerce' );
},
],
'type' => [
'type' => 'ProductTypesEnum',
'description' => static function () {
return __( 'Type of the product.', 'graphql-for-ecommerce' );
},
],
'status' => [
'type' => 'PostStatusEnum',
'description' => static function () {
return __( 'Status of the product.', 'graphql-for-ecommerce' );
},
],
'featured' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Featured product.', 'graphql-for-ecommerce' );
},
],
'catalogVisibility' => [
'type' => 'CatalogVisibilityEnum',
'description' => static function () {
return __( 'Catalog visibility.', 'graphql-for-ecommerce' );
},
],
'description' => [
'type' => 'String',
'description' => static function () {
return __( 'Product description.', 'graphql-for-ecommerce' );
},
],
'shortDescription' => [
'type' => 'String',
'description' => static function () {
return __( 'Product short description.', 'graphql-for-ecommerce' );
},
],
'sku' => [
'type' => 'String',
'description' => static function () {
return __( 'Product SKU.', 'graphql-for-ecommerce' );
},
],
'regularPrice' => [
'type' => 'Float',
'description' => static function () {
return __( 'Product regular price.', 'graphql-for-ecommerce' );
},
],
'salePrice' => [
'type' => 'Float',
'description' => static function () {
return __( 'Product sale price.', 'graphql-for-ecommerce' );
},
],
'dateOnSaleFrom' => [
'type' => 'String',
'description' => static function () {
return __( 'Product sale start date.', 'graphql-for-ecommerce' );
},
],
'dateOnSaleTo' => [
'type' => 'String',
'description' => static function () {
return __( 'Product sale end date.', 'graphql-for-ecommerce' );
},
],
'virtual' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Product virtual.', 'graphql-for-ecommerce' );
},
],
'downloadable' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Product downloadable.', 'graphql-for-ecommerce' );
},
],
'downloads' => [
'type' => [ 'list_of' => 'ProductDownloadInput' ],
'description' => static function () {
return __( 'Product downloads.', 'graphql-for-ecommerce' );
},
],
'downloadLimit' => [
'type' => 'Int',
'description' => static function () {
return __( 'Product download limit.', 'graphql-for-ecommerce' );
},
],
'downloadExpiry' => [
'type' => 'Int',
'description' => static function () {
return __( 'Number of days until download access expires.', 'graphql-for-ecommerce' );
},
],
'externalUrl' => [
'type' => 'String',
'description' => static function () {
return __( 'Product external URL. (External products only)', 'graphql-for-ecommerce' );
},
],
'buttonText' => [
'type' => 'String',
'description' => static function () {
return __( 'Product button text. (External products only)', 'graphql-for-ecommerce' );
},
],
'taxStatus' => [
'type' => 'TaxStatusEnum',
'description' => static function () {
return __( 'Tax status.', 'graphql-for-ecommerce' );
},
],
'taxClass' => [
'type' => 'TaxClassEnum',
'description' => static function () {
return __( 'Tax class.', 'graphql-for-ecommerce' );
},
],
'manageStock' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Manage stock.', 'graphql-for-ecommerce' );
},
],
'stockQuantity' => [
'type' => 'Int',
'description' => static function () {
return __( 'Stock quantity.', 'graphql-for-ecommerce' );
},
],
'stockStatus' => [
'type' => 'StockStatusEnum',
'description' => static function () {
return __( 'Stock status.', 'graphql-for-ecommerce' );
},
],
'backorders' => [
'type' => 'BackordersEnum',
'description' => static function () {
return __( 'Backorders.', 'graphql-for-ecommerce' );
},
],
'soldIndividually' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Sold individually.', 'graphql-for-ecommerce' );
},
],
'weight' => [
'type' => 'String',
'description' => static function () {
return __( 'Product weight.', 'graphql-for-ecommerce' );
},
],
'dimensions' => [
'type' => 'ProductDimensionsInput',
'description' => static function () {
return __( 'Product dimensions.', 'graphql-for-ecommerce' );
},
],
'shippingClass' => [
'type' => 'String',
'description' => static function () {
return __( 'Shipping class.', 'graphql-for-ecommerce' );
},
],
'reviewsAllowed' => [
'type' => 'Boolean',
'description' => static function () {
return __( 'Allow reviews. Default is true', 'graphql-for-ecommerce' );
},
],
'upsellIds' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Upsell product IDs.', 'graphql-for-ecommerce' );
},
],
'crossSellIds' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Cross-sell product IDs.', 'graphql-for-ecommerce' );
},
],
'parentId' => [
'type' => 'Int',
'description' => static function () {
return __( 'Parent product ID.', 'graphql-for-ecommerce' );
},
],
'purchaseNote' => [
'type' => 'String',
'description' => static function () {
return __( 'Purchase note.', 'graphql-for-ecommerce' );
},
],
'categories' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Product categories.', 'graphql-for-ecommerce' );
},
],
'tags' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Product tags.', 'graphql-for-ecommerce' );
},
],
'images' => [
'type' => [ 'list_of' => 'ProductImageInput' ],
'description' => static function () {
return __( 'Product images.', 'graphql-for-ecommerce' );
},
],
'attributes' => [
'type' => [ 'list_of' => 'ProductAttributesInput' ],
'description' => static function () {
return __( 'Product attributes.', 'graphql-for-ecommerce' );
},
],
'defaultAttributes' => [
'type' => [ 'list_of' => 'ProductAttributeInput' ],
'description' => static function () {
return __( 'Product default attributes.', 'graphql-for-ecommerce' );
},
],
'groupedProducts' => [
'type' => [ 'list_of' => 'Int' ],
'description' => static function () {
return __( 'Grouped product IDs.', 'graphql-for-ecommerce' );
},
],
'menuOrder' => [
'type' => 'Int',
'description' => static function () {
return __( 'Menu order.', 'graphql-for-ecommerce' );
},
],
'metaData' => [
'type' => [ 'list_of' => 'MetaDataInput' ],
'description' => static function () {
return __( 'Meta data.', 'graphql-for-ecommerce' );
},
],
];
}
/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields() {
return [
'product' => [
'type' => 'Product',
'resolve' => static function ( $payload ) {
return new Product( $payload['id'] );
},
],
'productId' => [
'type' => 'Int',
'resolve' => static function ( $payload ) {
return $payload['id'];
},
],
];
}
/**
* Defines the mutation data modification closure.
*
* @param array $input Mutation input.
* @param \WPGraphQL\AppContext $context AppContext instance.
* @param \GraphQL\Type\Definition\ResolveInfo $info ResolveInfo instance. Can be
* use to get info about the current node in the GraphQL tree.
*
* @throws \GraphQL\Error\UserError Invalid ID provided | Lack of capabilities.
*
* @return array
*/
public static function mutate_and_get_payload( $input, AppContext $context, ResolveInfo $info ) {
$product_id = ! empty( $input['id'] ) ? $input['id'] : 0;
$type = ! empty( $input['type'] ) ? $input['type'] : 'simple';
if ( 0 !== $product_id ) {
/**
* @var \WC_Product $product
*/
$product = \wc_get_product( $product_id );
if ( $product && ! wc_rest_check_post_permissions( 'product', 'edit', $product->get_id() ) ) {
throw new UserError( __( 'You do not have permission to edit this product', 'graphql-for-ecommerce' ) );
}
} else {
$classname = \WC_Product_Factory::get_classname_from_product_type( $type );
if ( ! $classname || ! class_exists( $classname ) ) {
$classname = '\WC_Product_Simple';
}
/**
* @var \WC_Product $product
*/
$product = new $classname( $product_id );
/**
* @var \WP_Post_Type $post_type_object
*/
$post_type_object = get_post_type_object( 'product' );
if ( ! current_user_can( $post_type_object->cap->edit_posts ) ) {
throw new UserError( __( 'You do not have permission to create products', 'graphql-for-ecommerce' ) );
}
}
if ( ! empty( $input['name'] ) ) {
$product->set_name( wp_filter_post_kses( $input['name'] ) );
}
if ( ! empty( $input['description'] ) ) {
$product->set_description( wp_filter_post_kses( $input['description'] ) );
}
if ( ! empty( $input['shortDescription'] ) ) {
$product->set_short_description( wp_filter_post_kses( $input['shortDescription'] ) );
}
if ( ! empty( $input['status'] ) ) {
$product->set_status( get_post_status_object( $input['status'] ) ? $input['status'] : 'draft' );
}
if ( ! empty( $input['slug'] ) ) {
$product->set_slug( $input['slug'] );
}
if ( ! empty( $input['menuOrder'] ) ) {
$product->set_menu_order( $input['menuOrder'] );
}
if ( isset( $input['reviewsAllowed'] ) ) {
$product->set_reviews_allowed( $input['reviewsAllowed'] );
}
if ( isset( $input['virtual'] ) ) {
$product->set_virtual( $input['virtual'] );
}
if ( ! empty( $input['taxStatus'] ) ) {
$product->set_tax_status( $input['taxStatus'] );
}
if ( ! empty( $input['taxClass'] ) ) {
$product->set_tax_class( $input['taxClass'] );
}
if ( ! empty( $input['catalogVisibility'] ) ) {
$product->set_catalog_visibility( $input['catalogVisibility'] );
}
if ( ! empty( $input['purchaseNote'] ) ) {
$product->set_purchase_note( wp_filter_post_kses( $input['purchaseNote'] ) );
}
if ( isset( $input['featured'] ) ) {
$product->set_featured( $input['featured'] );
}
$product = Product_Mutation::save_product_shipping_data( $product, $input );
if ( ! empty( $input['sku'] ) ) {
/**
* @var string $sku
*/
$sku = wc_clean( $input['sku'] );
$product->set_sku( $sku );
}
if ( ! empty( $input['attributes'] ) ) {
$attributes = [];
foreach ( $input['attributes'] as $attribute ) {
$attribute_object = Product_Mutation::prepare_attribute( $attribute );
if ( $attribute_object ) {
$attributes[] = $attribute_object;
}
}
$product->set_attributes( $attributes );
}
if ( in_array( $type, [ 'variable', 'grouped' ], true ) ) {
$product->set_regular_price( '' );
$product->set_sale_price( '' );
$product->set_date_on_sale_to( '' );
$product->set_date_on_sale_from( '' );
$product->set_price( '' );
} else {
if ( ! empty( $input['regularPrice'] ) ) {
$product->set_regular_price( $input['regularPrice'] );
}
if ( ! empty( $input['salePrice'] ) ) {
$product->set_sale_price( $input['salePrice'] );
}
if ( ! empty( $input['dateOnSaleFrom'] ) ) {
$product->set_date_on_sale_from( $input['dateOnSaleFrom'] );
}
if ( ! empty( $input['dateOnSaleTo'] ) ) {
$product->set_date_on_sale_to( $input['dateOnSaleTo'] );
}
}
if ( ! empty( $input['parentId'] ) ) {
$product->set_parent_id( $input['parentId'] );
}
if ( isset( $input['soldIndividually'] ) ) {
$product->set_sold_individually( $input['soldIndividually'] );
}
if ( isset( $input['stockStatus'] ) ) {
/**
* @var string $stock_status
*/
$stock_status = wc_clean( $input['stockStatus'] );
} else {
$stock_status = $product->get_stock_status();
}
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
if ( isset( $input['manageStock'] ) ) {
/**
* @var bool $manage_stock
*/
$manage_stock = $input['manageStock'];
$product->set_manage_stock( $manage_stock );
}
if ( isset( $input['backorders'] ) ) {
$product->set_backorders( $input['backorders'] );
}
if ( $product->is_type( 'grouped' ) ) {
$product->set_manage_stock( false );
$product->set_backorders( 'no' );
$product->set_stock_quantity( null );
$product->set_stock_status( $stock_status );
} elseif ( $product->is_type( 'external' ) ) {
$product->set_manage_stock( false );
$product->set_backorders( 'no' );
$product->set_stock_quantity( null );
$product->set_stock_status( 'instock' );
} elseif ( $product->get_manage_stock() ) {
// Stock status is always determined by children so sync later.
if ( ! $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
}
// Stock quantity.
if ( isset( $input['stockQuantity'] ) ) {
$product->set_stock_quantity( wc_stock_amount( $input['stockQuantity'] ) );
}
} else {
// Don't manage stock.
$product->set_manage_stock( false );
$product->set_stock_quantity( null );
$product->set_stock_status( $stock_status );
}
} elseif ( $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
}
if ( ! empty( $input['upsellIds'] ) ) {
$product->set_upsell_ids( $input['upsellIds'] );
}
if ( ! empty( $input['crossSellIds'] ) ) {
$product->set_cross_sell_ids( $input['crossSellIds'] );
}
if ( ! empty( $input['categories'] ) ) {
$product = Product_Mutation::save_taxonomy_terms( $product, $input['categories'] );
}
if ( ! empty( $input['tags'] ) ) {
$product = Product_Mutation::save_taxonomy_terms( $product, $input['tags'], 'tag' );
}
if ( isset( $input['downloadable'] ) ) {
$product->set_downloadable( $input['downloadable'] );
}
if ( $product->get_downloadable() ) {
if ( ! empty( $input['downloads'] ) ) {
$product = Product_Mutation::save_downloadable_files( $product, $input['downloads'] );
}
if ( isset( $input['downloadLimit'] ) ) {
$product->set_download_limit( $input['downloadLimit'] );
}
if ( isset( $input['downloadExpiry'] ) ) {
$product->set_download_expiry( $input['downloadExpiry'] );
}
}
if ( $product->is_type( 'external' ) ) {
if ( ! empty( $input['externalUrl'] ) ) {
/**
* @var \WC_Product_External $product
*/
$product->set_product_url( $input['externalUrl'] );
}
if ( ! empty( $input['buttonText'] ) ) {
/**
* @var \WC_Product_External $product
*/
$product->set_button_text( $input['buttonText'] );
}
}
if ( $product->is_type( 'variable' ) ) {
$product = Product_Mutation::save_default_attributes( $product, $input );
}
if ( $product->is_type( 'grouped' ) && isset( $input['groupedProducts'] ) ) {
/**
* @var \WC_Product_Grouped $product
*/
$product->set_children( $input['groupedProducts'] );
}
if ( ! empty( $input['images'] ) ) {
$product = Product_Mutation::set_product_images( $product, $input['images'] );
}
if ( ! empty( $input['metaData'] ) ) {
foreach ( $input['metaData'] as $meta ) {
$product->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
/**
* Filters an object before it is inserted via the GraphQL API.
*
* The dynamic portion of the hook name, `$this->post_type`,
* refers to the object type slug.
*
* @param \WC_Product $product Object object.
* @param array $input GraphQL input object.
* @param bool $creating If is creating a new object.
*/
$product = apply_filters( 'graphql_woocommerce_pre_insert_product_object', $product, $input, true );
$product_id = $product->save();
return [ 'id' => $product_id ];
}
}