本文へ移動
cccskills
無料GitHub で公開

wcs-subscription-hooks

Curated WooCommerce Subscriptions hook and extension-point map for choosing the right action/filter around WC_Subscription creation, status transitions, date changes, renewal orders, scheduled payments, payment retries, gateway events, switching, gifting, related orders, REST/API responses, and account/admin UI. Use when the user asks for a Woo Subscriptions hook list, "where should I hook", "after renewal", "subscription status changed", or when code contains WC_Subscription, wcs_create_subscription, wcs_create_renewal_order, woocommerce_scheduled_subscription_payment, wcs_renewal_order_created, payment_retry, wcs_get_subscriptions, wcsg_, subscription_switch, _subscription_switch_data, _recipient_user, wcsg_recipient, or subscription switching.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md18.5 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

WooCommerce Subscriptions: hook map

Use this when building or reviewing an integration that needs to react to WooCommerce Subscriptions events. This is not an exhaustive dump of the 800+ hook calls in the plugin. It is a decision map for the hooks that are usually correct and the older/noisy hooks that AI agents tend to choose incorrectly.

Misconception this skill corrects

"Subscriptions are just orders, so hook woocommerce_order_status_changed or update _schedule_next_payment meta directly."

Subscriptions are WC_Subscription objects with their own lifecycle hooks, status transition hooks, date hooks, relation store, renewal order hooks, and scheduler bridge. Prefer WCS hooks and CRUD methods unless the task explicitly needs ordinary WC orders.

When to use this skill

Trigger when ANY of the following is true:

  • The user asks for WooCommerce Subscriptions actions/filters, lifecycle hooks, renewal hooks, status hooks, payment retry hooks, switching hooks, or gifting hooks.
  • You see WC_Subscription, wcs_get_subscription(), wcs_create_subscription(), wcs_create_renewal_order(), woocommerce_scheduled_subscription_payment, wcs_renewal_order_created, payment_retry, wcsg_, or subscription_switch.
  • You need to decide whether to hook at subscription creation, renewal order creation, gateway payment attempt, successful payment, failed payment, status change, or scheduled action time.

Workflow

  1. Identify the lifecycle point first: creation, status, date schedule, renewal order, gateway charge, retry, switch/gift, or UI/API.
  2. Prefer hooks that pass WC_Subscription or WC_Order objects over legacy hooks that pass subscription keys.
  3. For dynamic hooks, expand the real hook name from the runtime value: status, date type, payment method ID, or order relation type.
  4. Before implementing, inspect the exact source line in the installed plugin with:
rg -n "hook_name|function_name" wp-content/plugins/woocommerce-subscriptions/includes wp-content/plugins/woocommerce-subscriptions/src

Storage facts agents must not guess

Subscriptions registers shop_subscription as a WooCommerce order type. In CPT mode it appears as a post type; in HPOS it is an order type. Subscription product type slugs are subscription, variable-subscription, and subscription_variation.

Subscription prop meta keys include _billing_period, _billing_interval, _suspension_count, _cancelled_email_sent, _requires_manual_renewal, _trial_period, _last_order_date_created, _schedule_start, _schedule_trial_end, _schedule_next_payment, _schedule_cancelled, _schedule_end, _schedule_payment_retry, and _subscription_switch_data.

Related order meta keys are _subscription_renewal, _subscription_switch, and _subscription_resubscribe.

Switch cart items store subscription_switch cart item data. Gift cart items store wcsg_gift_recipients_email; gifted subscriptions use _recipient_user_email_address and _recipient_user, with parent order item meta wcsg_recipient.

Core hook map

NeedHookTypeArgsUse
Detect a loaded subscription objectwcs_get_subscriptionfilter`WC_Subscriptionfalse $subscription`
Create subscription programmaticallywcs_created_subscriptionfilterWC_Subscription $subscriptionModify the newly saved object before the post-create action.
Run after subscription creationwcs_create_subscriptionactionWC_Subscription $subscriptionAttach metadata, external IDs, logs, or provisioning.
Change default new statuswoocommerce_default_subscription_statusfilterstring $statusDefault is pending; return status without wc-.
Add/rename statuseswcs_subscription_statusesfilterarray $statusesKeys must use wc- prefix, e.g. wc-paused.
Allow status transitionwoocommerce_can_subscription_be_updated_to_{status}filterbool $can, WC_Subscription $subscriptionPermit a custom or normally blocked transition.
Before status updatewoocommerce_subscription_pre_update_statusaction$old_status, $new_status, WC_Subscription $subscriptionValidate/log before WCS mutates dates and saves.
Status reachedwoocommerce_subscription_status_{to}actionWC_Subscription $subscriptionReact to a specific target status, e.g. woocommerce_subscription_status_active.
Specific transitionwoocommerce_subscription_status_{from}_to_{to}actionWC_Subscription $subscriptionUse for exact transitions such as on-hold_to_active.
Generic status updatewoocommerce_subscription_status_updatedactionWC_Subscription $subscription, string $to, string $fromBest general hook for lifecycle integration.
WC-like status changedwoocommerce_subscription_status_changedactionint $subscription_id, string $from, string $to, WC_Subscription $subscriptionUseful when porting code shaped like woocommerce_order_status_changed.
Read a stored datewoocommerce_subscription_get_{date_type}_datefilter$date, WC_Subscription $subscription, string $timezoneDisplay/read override; do not use to reschedule.
Calculate a future datewoocommerce_subscription_calculated_{date_type}_datefilter$date, WC_Subscription $subscriptionChange calculated next_payment, trial_end, end, or end_of_prepaid_term.
Date changedwoocommerce_subscription_date_updatedactionWC_Subscription $subscription, string $date_type, string $datetimeScheduler listens here; good place for external sync.
Date deletedwoocommerce_subscription_date_deletedactionWC_Subscription $subscription, string $date_typeClean up external schedule/state.
Can date be changedwoocommerce_subscription_can_date_be_updatedfilterbool $can, string $date_type, WC_Subscription $subscriptionOpen/close date editing rules.
Query subscriptionswoocommerce_get_subscriptions_query_argsfilter$query_args, $working_argsModify wcs_get_subscriptions() query before execution.
After querywoocommerce_got_subscriptionsfilter$subscriptions, $working_argsPost-filter subscription results.
Related orderswoocommerce_subscription_related_ordersfilter$orders, WC_Subscription $subscription, $return_fields, $order_typeAdd/adjust parent, renewal, switch, resubscribe relations.

Renewal and scheduled payment hooks

NeedHookTypeArgsUse
Scheduled renewal is duewoocommerce_scheduled_subscription_paymentactionint $subscription_idFired by Action Scheduler/admin action. WCS prepares renewal at priority 1 and gateway processing runs at priority 10.
Renewal order creation failedwcs_failed_to_create_renewal_orderactionWP_Error $error, WC_Subscription $subscriptionAlert/log/retry externally.
Renewal order createdwcs_renewal_order_createdfilterWC_Order $renewal_order, WC_Subscription $subscriptionAdd order meta, line item data, external IDs. Return a WC_Order.
Gateway charge hookwoocommerce_scheduled_subscription_payment_{gateway_id}actionfloat $amount, WC_Order $renewal_orderPayment gateways implement recurring charge here, e.g. _stripe or _paypal.
Manual renewal order generatedwoocommerce_generated_manual_renewal_orderactionint $renewal_order_id, WC_Subscription $subscriptionNotify, adjust pending manual renewal order.
Renewal payment completewoocommerce_subscription_renewal_payment_completeactionWC_Subscription $subscription, WC_Order $last_orderProvision after a successful renewal, not before gateway payment.
Renewal payment failedwoocommerce_subscription_renewal_payment_failedactionWC_Subscription $subscription, WC_Order $related_orderHandle failed renewal consequences.
Any subscription payment completewoocommerce_subscription_payment_completeactionWC_Subscription $subscriptionFires for parent or renewal payment completion.
Any subscription payment failedwoocommerce_subscription_payment_failedactionWC_Subscription $subscription, string $new_statusReact to failure and resulting status.
Paid failed renewalwoocommerce_subscriptions_paid_for_failed_renewal_orderactionWC_Order $renewal_order, WC_Subscription $subscriptionUpdate failing payment method or clear retry state after customer pays a failed renewal.

Scheduler hooks

WCS uses Action Scheduler with group wc_subscription_scheduled_event, but the public integration point is the subscription date/status API. The scheduler listens to woocommerce_subscription_date_updated, woocommerce_subscription_date_deleted, and woocommerce_subscription_status_updated.

NeedHookTypeArgsUse
Add/remove date types to schedulewoocommerce_subscriptions_date_types_to_schedulefilterstring[] $date_typesInclude custom subscription date types.
Change scheduled action hookwoocommerce_subscriptions_scheduled_action_hookfilterstring $hook, string $date_typeRoute a date type to a custom action.
Change scheduled argswoocommerce_subscriptions_scheduled_action_argsfilterarray $args, string $date_type, WC_Subscription $subscriptionAdd deterministic args for custom scheduled actions.
Change Action Scheduler prioritywoocommerce_subscriptions_scheduled_action_priorityfilterint $priority, string $action_hookDefault is priority 1.
Trial endedwoocommerce_subscription_trial_endedactionint $subscription_idFired from scheduled trial end handler.
Expiration/end hookswoocommerce_scheduled_subscription_expiration, woocommerce_scheduled_subscription_end_of_prepaid_termactionint $subscription_idInternal status handlers run here; attach after them if you need post-status side effects.

Payment retry hooks

NeedHookTypeArgsUse
Enable/disable retrieswcs_is_retry_enabledfilterbool $enabledFeature-level gate.
Replace default retry ruleswcs_default_retry_rulesfilterarray $rulesConfigure retry cadence/statuses.
Alter one retry rulewcs_get_retry_rule_raw, wcs_get_retry_rulefilter$rule, $retry_number, $order_idFine-grained retry rule customization.
Before/after applying rulewoocommerce_subscriptions_before_apply_retry_rule, woocommerce_subscriptions_after_apply_retry_ruleactionWCS_Retry_Rule $rule, WC_Order $last_order, WC_Subscription $subscriptionObserve scheduled retry creation.
Retry action is about to chargewoocommerce_subscriptions_before_payment_retryactionWCS_Retry $retry, WC_Order $last_orderPrepare/log before retry payment.
Retry charge finishedwoocommerce_subscriptions_after_payment_retryactionWCS_Retry $retry, WC_Order $last_orderRecord retry result.
Retry status/date changedwoocommerce_subscriptions_retry_status_updated, woocommerce_subscriptions_retry_date_updatedactionWCS_Retry ...External sync for retry objects.

Switching, early renewal, gifting

AreaHooksUse
Switch eligibilitywcs_is_product_switchable, woocommerce_subscriptions_can_item_be_switched, woocommerce_subscriptions_can_item_be_switched_by_userAllow/block switching by product, item, or user.
Switch pricingwcs_switch_should_prorate_recurring_price, wcs_switch_should_prorate_sign_up_fee, wcs_switch_sign_up_fee, wcs_switch_proration_extra_to_payAdjust proration math.
Switch completionwoocommerce_subscriptions_switch_completedReact after switch order flow completes.
Early renewalwcs_is_early_renewal_enabled, woocommerce_subscriptions_can_user_renew_early, woocommerce_subscriptions_get_early_renewal_urlEnable/disable and route early renewal.
Gifting product/checkoutwcsg_enable_gifting, wcsg_is_enabled_for_all_products, wcsg_is_giftable_product, wcsg_cart_item_dataControl whether gifting is available and persisted in cart.
Gifting recipientwcsg_recipient_details_updated, woocommerce_subscriptions_gifting_recipient_changedSync recipient changes.

Gateway hooks

NeedHookTypeArgsUse
Gateway support checkwoocommerce_subscription_payment_gateway_supportsfilterbool $supports, string $feature, WC_Subscription $subscriptionAdd support for features like subscription_date_changes.
Status changed for gatewaywoocommerce_subscription_activated_{gateway_id}, woocommerce_subscription_on-hold_{gateway_id}, woocommerce_subscription_pending-cancel_{gateway_id}, woocommerce_subscription_cancelled_{gateway_id}, woocommerce_subscription_expired_{gateway_id}actionWC_Subscription $subscriptionGateway-specific remote profile updates.
Payment method updatedwoocommerce_subscription_payment_method_updatedactionWC_Subscription $subscription, string $new, string $oldSync token/payment method changes.
Payment method updated to/from gatewaywoocommerce_subscription_payment_method_updated_to_{gateway_id}, woocommerce_subscription_payment_method_updated_from_{gateway_id}actionWC_Subscription $subscription, string $other_gateway_idGateway-specific migration logic.
Failing method updatedwoocommerce_subscription_failing_payment_method_updated and ..._{gateway_id}actionWC_Subscription $subscription, WC_Order $renewal_orderAfter customer changes method for a failed renewal.
Payment meta fieldswoocommerce_subscription_payment_metafilterarray $payment_meta, WC_Subscription $subscriptionAdd fields to payment-method change UI.
Validate payment metawoocommerce_subscription_validate_payment_meta and ..._{gateway_id}actionarray $payment_meta, WC_Subscription $subscriptionThrow/notice on invalid payment details.

Customer action guardrails

For custom customer account actions, do not expose WCS admin REST writes directly. Load the subscription object, verify the current user owns it, then use WCS capabilities and object methods.

Status actions:

  • Check $subscription->get_user_id() === get_current_user_id() unless this is trusted admin/server code.
  • Check $subscription->can_be_updated_to( $target_status ) before calling $subscription->update_status( $target_status, $note, true ).
  • Prefer domain statuses: cancel to pending-cancel when the prepaid term should continue; cancel to cancelled only when immediate cancellation is intended and allowed.
  • Let WCS status hooks run; do not update post_status or order status meta directly.

Payment-method actions:

  • Verify the selected payment token belongs to the same WP user and gateway customer.
  • Do not update only payment meta/source IDs. Use WC_Subscriptions_Change_Payment_Gateway::update_payment_method() or the gateway's change-payment flow so hooks and remote gateway side effects run.
  • Preserve woocommerce_subscriptions_pre_update_payment_method and woocommerce_subscription_payment_method_updated; gateways use them for remote profile cleanup and migration.

Switch actions:

  • Use WC_Subscriptions_Switcher::can_item_be_switched_by_user() for eligibility.
  • Wrap the switch cart/checkout flow or reproduce _subscription_switch_data deliberately. Direct line-item replacement is not a subscription switch.

Common mistakes

// WRONG: catches many normal orders and misses WCS-specific semantics.
add_action( 'woocommerce_order_status_changed', 'my_sync' );

// RIGHT: subscription transition with object.
add_action( 'woocommerce_subscription_status_updated', function ( WC_Subscription $subscription, string $to, string $from ): void {
    my_sync_subscription_status( $subscription->get_id(), $from, $to );
}, 10, 3 );

// WRONG: changing the schedule by writing meta bypasses validation and can desync Action Scheduler.
update_post_meta( $subscription_id, '_schedule_next_payment', '2026-05-01 00:00:00' );

// RIGHT: CRUD date update; WCS validates and reschedules via date hooks.
$subscription = wcs_get_subscription( $subscription_id );
if ( $subscription ) {
    $subscription->update_dates( array( 'next_payment' => '2026-05-01 00:00:00' ), 'gmt' );
}

// WRONG: use the scheduled-payment hook for fulfillment.
add_action( 'woocommerce_scheduled_subscription_payment', 'ship_box' );

// RIGHT: fulfill only after renewal payment is complete.
add_action( 'woocommerce_subscription_renewal_payment_complete', function ( WC_Subscription $subscription, WC_Order $order ): void {
    ship_box_for_renewal( $subscription, $order );
}, 10, 2 );

What this skill does NOT cover

  • Building a payment gateway from scratch.
  • HPOS order CRUD beyond the WCS-specific hooks here. Use wc-hpos-compatibility for general order storage issues.
  • Exhaustive hook cataloging. For full local discovery, run rg -n "do_action\\(|apply_filters\\(" wp-content/plugins/woocommerce-subscriptions.

Cross-references

  • Run wcs-data-model-switching-gifting when exact Subscriptions meta names, product type slugs, switch payloads, switched item meta/types, or WCS Gifting recipient storage matters.
  • Run wcs-renewal-scheduler for changes to next payment dates, renewal order creation, scheduled actions, or payment retry timing.
  • Run wc-hpos-compatibility if the integration queries orders/subscriptions directly.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

Control a headless browser to navigate URLs, click elements, fill forms, extract content from JavaScript-rendered pages, take screenshots, and automate end-to-end web workflows.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

Create beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

Review code for quality, simplicity, and maintainability. Identifies unnecessary abstractions, duplicated logic, oversized functions, missing error handling, and naming issues — then fixes them automatically before presenting the result.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

WooCommerce store operations through NV oOS Pro — product research, catalog cross-referencing, inventory lookups, and Shopify or Flowhub comparisons where integrations are configured.

日本語の概要は準備中です。原文の説明を表示しています。

nvdigitalsolutions/mcp-ai-wpoos72026年10月13日 更新

nvdigitalsolutions のスキルをすべて見る

このスキルの問題を報告する