{"id":188,"date":"2017-01-27T13:15:46","date_gmt":"2017-01-27T13:15:46","guid":{"rendered":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards-new\/?p=188"},"modified":"2024-03-26T10:22:36","modified_gmt":"2024-03-26T10:22:36","slug":"widgets-shortcodes","status":"publish","type":"post","link":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/premium-version-settings\/widgets-shortcodes\/","title":{"rendered":"Shortcodes & Widgets"},"content":{"rendered":"\n

The plugin includes multiple shortcodes and widgets. <\/p>\n\n\n\n

    \n
  1. Shortcode – Customer rankings<\/li>\n\n\n\n
  2. Shorcode – Available points<\/a><\/li>\n\n\n\n
  3. Shortcode – My points<\/a><\/li>\n\n\n\n
  4. Shortcode – Product points<\/a><\/li>\n\n\n\n
  5. Shortcode – Points for cart total<\/a><\/li>\n\n\n\n
  6. Shortcode – Referral link<\/a><\/li>\n\n\n\n
  7. Widget – Customers points<\/a><\/li>\n\n\n\n
  8. Widget – Balance<\/a><\/li>\n\n\n\n
  9. Backend widgets<\/a><\/li>\n<\/ol>\n\n\n\n

    1. Customer rankings<\/h3>\n\n\n\n

    From the Ranking tab in YITH > Points & Rewards > Points options > Ranking<\/em>, you can find the 2 styles of the customer ranking shortcode ready to copy and paste, but let’s see all the available options.<\/p>\n\n\n\n

    \"Ranking<\/a><\/figure>\n\n\n\n

    This shortcode allows you to print the ranking of your customers wherever you want on your website. The ranking lists top users of your store who have collected the most points. <\/p>\n\n\n\n

    This is the shortcode: <\/p>\n\n\n\n

    [ywpar_customers_points style=\"simple\" tabs=\"yes\" num_of_customers=\"3\"]<\/code><\/p>\n\n\n\n

    Attributes available<\/h4>\n\n\n\n

    style<\/code><\/strong>: this can either be simple <\/strong>or boxed<\/strong>.<\/p>\n\n\n\n

    \"Simple<\/a>
    Simple style with tabs<\/figcaption><\/figure>\n\n\n\n
    \"Boxed<\/a>
    Boxed style without tabs<\/figcaption><\/figure>\n\n\n\n

    tabs<\/code><\/strong>: this can either be yes<\/strong> or no<\/strong>.
    If set to yes <\/em>it will show the tabs All time, last year, last 30 days, this week, today<\/strong>.
    If set to no<\/em>, it will show the list of users as All time with the number of points on the right. <\/p>\n\n\n\n

    \"Customers<\/a>
    With tabs<\/figcaption><\/figure>\n\n\n\n
    \"Customers<\/a>
    Without tabs<\/figcaption><\/figure>\n\n\n\n

    num_of_customers<\/code><\/strong>: here you can enter the number of customers to show in the rankings. It will automatically show only the ones with the most points. <\/p>\n\n\n\n

    The total number of points is calculated out of the total points they have earned in their history\/week\/month, regardless of how many points they have already redeemed (which would be instead their points balance).<\/p>\n\n\n\n

    So, for example, this week, Paul earns 1000 points, Mark 500 and Tony 300. Paul will be the first in the ranking, even if he has redeemed all his points to get a discount, while Mark and Tony still have not used them.<\/p>\n\n\n\n

    For the weekly ranking, the lists are updated every Monday.<\/p>\n\n\n\n

    2. Available points<\/h3>\n\n\n\n

    [yith_ywpar_points]<\/code><\/b>: shows remaining points to logged-in users;<\/p>\n\n\n\n

    \"shortcode<\/figure>\n\n\n\n

    Parameters are:<\/p>\n\n\n\n

    – label<\/code><\/strong>: default value “Your credit is “
    – show_worth<\/code><\/strong>: default value “no”<\/p>\n\n\n\n

    E.g. [yith_ywpar_points label=\"Your credit is \" show_worth=\"no\"]<\/code><\/p>\n\n\n\n

    3. My points<\/h3>\n\n\n\n

    [yith_ywpar_points_list]<\/strong><\/code>: shows the content of points as it appears in My Account, so points, levels, rank position recap tiles and the tabs with point history, target and get-point banners, and coupons.<\/p>\n\n\n\n

    \"\"<\/a><\/figure>\n\n\n\n

    4. Product points<\/h3>\n\n\n\n

    [yith_points_product_message]<\/strong><\/code>: shows points that will be earned if you purchase the displayed product.<\/p>\n\n\n\n

    \"Points<\/figure>\n\n\n\n

    You can either use it as is on a product page, and it will automatically show the points of that product, or use it on other pages and specify the product_id<\/strong><\/code> like this:<\/p>\n\n\n\n

    E.g. [yith_points_product_message product_id=\"488\"]<\/code><\/p>\n\n\n\n

    5. Points for cart total<\/h3>\n\n\n\n

    [yith_checkout_thresholds_message]<\/code><\/strong>: shows the number of assigned points based on the extra points rule for total in cart. Check here<\/a> for more details about how to set up this extra points rule. <\/p>\n\n\n\n

    \"Points<\/a><\/figure>\n\n\n\n

    Parameter:<\/p>\n\n\n\n

    title<\/code><\/strong>: default value “Checkout total thresholds”<\/p>\n\n\n\n

    E.g. [yith_checkout_thresholds_message title=\"Checkout total thresholds\"]<\/code><\/p>\n\n\n\n

    6. Referral link<\/h3>\n\n\n\n

    [ywpar_referral_link user_id=”]<\/strong>: shows the referral link by using the user ID or retrieving it automatically by setting the user_id as “auto” > [ywpar_referral_link user_id=auto]<\/strong><\/p>\n\n\n\n

    \"\"<\/figure>\n\n\n\n

    The available parameters are:<\/p>\n\n\n\n