init_query_vars(); add_filter( 'woocommerce_account_settings', array( $this, 'add_endpoint_account_settings' ) ); } /** * Init query vars by loading options. * * @since 2.0 */ public function init_query_vars() { $this->query_vars = array( 'view-subscription' => $this->get_view_subscription_endpoint(), ); if ( ! WC_Subscriptions::is_woocommerce_pre( '2.6' ) ) { $this->query_vars['subscriptions'] = get_option( 'woocommerce_myaccount_subscriptions_endpoint', 'subscriptions' ); } } /** * Adds endpoint breadcrumb when viewing subscription * * @param array $crumbs already assembled breadcrumb data * @return array $crumbs if we're on a view-subscription page, then augmented breadcrumb data */ public function add_breadcrumb( $crumbs ) { foreach ( $this->query_vars as $key => $query_var ) { if ( $this->is_query( $query_var ) ) { $crumbs[] = array( $this->get_endpoint_title( $key ) ); } } return $crumbs; } /** * Changes page title on view subscription page * * @param string $title original title * @return string changed title */ public function change_endpoint_title( $title ) { if ( in_the_loop() && is_account_page() ) { foreach ( $this->query_vars as $key => $query_var ) { if ( $this->is_query( $query_var ) ) { $title = $this->get_endpoint_title( $key ); // unhook after we've returned our title to prevent it from overriding others remove_filter( 'the_title', array( $this, __FUNCTION__ ), 11 ); } } } return $title; } /** * Set the subscription page title when viewing a subscription. * * @since 2.0 * @param $title */ public function get_endpoint_title( $endpoint ) { global $wp; switch ( $endpoint ) { case 'view-subscription': $subscription = wcs_get_subscription( $wp->query_vars['view-subscription'] ); $title = ( $subscription ) ? sprintf( _x( 'Subscription #%s', 'hash before order number', 'woocommerce-subscriptions' ), $subscription->get_order_number() ) : ''; break; case 'subscriptions': $title = __( 'Subscriptions', 'woocommerce-subscriptions' ); break; default: $title = ''; break; } return $title; } /** * Insert the new endpoint into the My Account menu. * * @param array $items * @return array */ public function add_menu_items( $menu_items ) { if ( 1 == count( wcs_get_users_subscriptions() ) ) { $label = __( 'My Subscription', 'woocommerce-subscriptions' ); } else { $label = __( 'Subscriptions', 'woocommerce-subscriptions' ); } // Add our menu item after the Orders tab if it exists, otherwise just add it to the end if ( array_key_exists( 'orders', $menu_items ) ) { $menu_items = wcs_array_insert_after( 'orders', $menu_items, 'subscriptions', $label ); } else { $menu_items['subscriptions'] = $label; } return $menu_items; } /** * Changes the URL for the subscriptions endpoint when there's only one user subscription. * * @since 2.2.17 * @param string $url * @param string $endpoint * @return string */ public function maybe_redirect_to_only_subscription( $url, $endpoint ) { if ( 'subscriptions' == $endpoint ) { $subscriptions = wcs_get_users_subscriptions(); if ( 1 == count( $subscriptions ) ) { $subscription = reset( $subscriptions ); $url = $subscription->get_view_order_url(); } } return $url; } /** * Endpoint HTML content. */ public function endpoint_content() { wc_get_template( 'myaccount/subscriptions.php', array(), '', plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'templates/' ); } /** * Check if the current query is for a type we want to override. * * @param string $query_var the string for a query to check for * @return bool */ protected function is_query( $query_var ) { global $wp; if ( is_main_query() && is_page() && isset( $wp->query_vars[ $query_var ] ) ) { $is_view_subscription_query = true; } else { $is_view_subscription_query = false; } return apply_filters( 'wcs_query_is_query', $is_view_subscription_query, $query_var ); } /** * Fix for endpoints on the homepage * * Based on WC_Query->pre_get_posts(), but only applies the fix for endpoints on the homepage from it * instead of duplicating all the code to handle the main product query. * * @param mixed $q query object */ public function pre_get_posts( $q ) { // We only want to affect the main query if ( ! $q->is_main_query() ) { return; } if ( $q->is_home() && 'page' === get_option( 'show_on_front' ) && absint( get_option( 'page_on_front' ) ) !== absint( $q->get( 'page_id' ) ) ) { $_query = wp_parse_args( $q->query ); if ( ! empty( $_query ) && array_intersect( array_keys( $_query ), array_keys( $this->query_vars ) ) ) { $q->is_page = true; $q->is_home = false; $q->is_singular = true; $q->set( 'page_id', (int) get_option( 'page_on_front' ) ); add_filter( 'redirect_canonical', '__return_false' ); } } } /** * Reset the woocommerce_myaccount_view_subscriptions_endpoint option name to woocommerce_myaccount_view_subscription_endpoint * * @return mixed Value set for the option * @since 2.2.18 */ private function get_view_subscription_endpoint() { $value = get_option( 'woocommerce_myaccount_view_subscriptions_endpoint', null ); if ( isset( $value ) ) { wcs_doing_it_wrong( 'woocommerce_myaccount_view_subscriptions_endpoint', sprintf( '%1$s option is deprecated. Use %2$s option instead.', 'woocommerce_myaccount_view_subscriptions_endpoint', 'woocommerce_myaccount_view_subscription_endpoint' ), '2.2.17' ); // Update the current option name with the value that was set in the deprecated option name update_option( 'woocommerce_myaccount_view_subscription_endpoint', $value ); // Now that things are upto date, do away with the deprecated option name delete_option( 'woocommerce_myaccount_view_subscriptions_endpoint' ); } return get_option( 'woocommerce_myaccount_view_subscription_endpoint', 'view-subscription' ); } /** * Add UI option for changing Subscription endpoints in WC settings * * @param mixed $account_settings * @return mixed $account_settings */ public function add_endpoint_account_settings( $settings ) { $new_settings = array(); $order_endpoint_found = false; $subscriptions_endpoint_setting = array( 'title' => __( 'Subscriptions', 'woocommerce-subscriptions' ), 'desc' => __( 'Endpoint for the My Account → Subscriptions page', 'woocommerce-subscriptions' ), 'id' => 'woocommerce_myaccount_subscriptions_endpoint', 'type' => 'text', 'default' => 'subscriptions', 'desc_tip' => true, ); $view_subscription_endpoint_setting = array( 'title' => __( 'View subscription', 'woocommerce-subscriptions' ), 'desc' => __( 'Endpoint for the My Account → View Subscription page', 'woocommerce-subscriptions' ), 'id' => 'woocommerce_myaccount_view_subscription_endpoint', 'type' => 'text', 'default' => 'view-subscription', 'desc_tip' => true, ); // Loop over and look for View Order Endpoint and include Subscriptions endpoint options after that. foreach ( $settings as $value ) { if ( 'woocommerce_myaccount_view_order_endpoint' === $value['id'] ) { $order_endpoint_found = true; $new_settings[] = $value; $new_settings[] = $subscriptions_endpoint_setting; $new_settings[] = $view_subscription_endpoint_setting; continue; } elseif ( ! $order_endpoint_found && 'sectionend' === $value['type'] && 'account_endpoint_options' === $value['id'] ) { // If we got to the end of the settings and didn't add our endpoints, add them to the end. $new_settings[] = $subscriptions_endpoint_setting; $new_settings[] = $view_subscription_endpoint_setting; } $new_settings[] = $value; } return $new_settings; } /** * Get endpoint URL. * * Gets the URL for an endpoint, which varies depending on permalink settings. * * @param string $endpoint * @param string $value * @param string $permalink * * @return string $url */ public function get_endpoint_url( $url, $endpoint, $value = '', $permalink = '') { if ( ! empty( $this->query_vars[ $endpoint ] ) ) { remove_filter( 'woocommerce_get_endpoint_url', array( $this, 'get_endpoint_url' ) ); $url = wc_get_endpoint_url( $this->query_vars[ $endpoint ], $value, $permalink ); add_filter( 'woocommerce_get_endpoint_url', array( $this, 'get_endpoint_url' ), 10, 4 ); } return $url; } } new WCS_Query();