Development

Filters

Home > Development

includes/class-yith-wcwl-admin.php

Copied!
Copy

Filter the capability used to access the plugin panel

Params
 string $capability Capability


Return
 string

includes/class-yith-wcwl-ajax-handler.php

Copied!
Copy

Filter the message shown when an item has been added to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter whether to show the links in the popup after an item has been added to the wishlist

Params
 bool $show_links Whether to show links or not in the popup


Return
 bool
Copied!
Copy

Filter the error message shown when adding an item to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the parameters sent in the Ajax response

Params
 array $params Array of parameters sent in the response


Return
 array
Copied!
Copy

Filter the message when an item has been removed from the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the message when an item has been removed from the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the message shown when an item has been added to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the output when reloading fragments

Params
 string $output  Fragment output
 int    $id      Fragment ID
 array  $options Fragment options


Return
 string

includes/class-yith-wcwl-cron-extended.php

Copied!
Copy

Filter the additional cron tasks created in the plugin

Params
 array $crons Plugin crons


Return
 array
Copied!
Copy

Filter the execution limit of the 'Back in stock' email

Params
 int $limit Execution limit


Return
 int

includes/class-yith-wcwl-cron-premium.php

Copied!
Copy

Filter the additional cron tasks created in the plugin

Params
 array $crons Plugin crons


Return
 array
Copied!
Copy

Filter the execution limit of the 'On sale item' email

Params
 int $limit Execution limit


Return
 int
Copied!
Copy

Filter the execution limit of the 'Promotional' email

Params
 int $limit Execution limit


Return
 int
Copied!
Copy

Filter the execution limit of the 'Promotional' email

Params
 array $item Email content


Return
 int

includes/class-yith-wcwl-cron.php

Copied!
Copy

Filter the cron tasks created in the plugin

Params
 array $crons Plugin crons


Return
 array

includes/class-yith-wcwl-extended.php

Copied!
Copy

Filter the expiration for the unsubscribe token

Params
 int    $token_expiration  Token expiration
 string $unsubscribe_token Unsubscribe token


Return
 int
Copied!
Copy

Filter the URL to unsubscribe for the plugin emails

Params
 string $url                          Unsubscribe URL
 int    $user_id                      User ID
 string $unsubscribe_token            Unsubscribe token
 int    $unsubscribe_token_expiration Unsubscribe token expiration


Return
 string

includes/class-yith-wcwl-form-handler-extended.php

Copied!
Copy

Filter the URL to redirect after the user has unsubscribed from mailing lists

Params
 string $redirect_url Redirect URL


Return
 string

includes/class-yith-wcwl-form-handler.php

Copied!
Copy

Filter the conditions to block some user agents

Params
 bool   $condition  Conditions
 string $user_agent User agent


Return
 bool
Copied!
Copy

Filter the message shown when an item has been added to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the error message shown when adding an item to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the conditions to allow removing the product from the wishlist after it has been adding to the cart

Params
 bool $condition Conditions


Return
 bool

includes/class-yith-wcwl-frontend.php

Copied!
Copy

Filter the array of positions where to display the 'Add to wishlist' button in the product page

Params
 array $positions Array of positions


Return
 array
Copied!
Copy

Filter the array of positions where to display the 'Add to wishlist' button in the loop page

Params
 array $positions Array of positions


Return
 array
Copied!
Copy

Filter whether to show the 'Add to wishlist' button

Params
 bool $show_button Whether to show the ATW button or not


Return
 bool
Copied!
Copy

Filter whether to disable the 'Add to wishlist' action from robots

Params
 bool $show_button Whether to disable the ATW action from robots or not


Return
 bool
Copied!
Copy

Filter the style dependencies to be used in the plugin

Params
 array $deps Array of style dependencies


Return
 array
Copied!
Copy

Filter the script dependencies to be used in the plugin

Params
 array $deps Array of script dependencies


Return
 array
Copied!
Copy

Filter the array with the parameters sent to the plugin scripts trought the localize

Params
 array $localize Array of parameters


Return
 array
Copied!
Copy

Filter whether to hide the 'Add to wishlist' button

Params
 bool $hide_button Whether to hide the ATW button or not


Return
 bool
Copied!
Copy

Filter whether to use the responsive layout for the wishlist

Params
 bool $is_responsive Whether to use responsive layout or not


Return
 bool
Copied!
Copy

Filter the time (in miliseconds) to close the popup after the 'Ask for an estimate' request has been sent

Params
 int $time Time to close the popup


Return
 int
Copied!
Copy

Filter the character used for the fragments index

Params
 string $char Character


Return
 string
Copied!
Copy

Filter whether to reload fragments on new variations found

Params
 bool $reload_variations Whether to reload fragments


Return
 bool
Copied!
Copy

Filter the breakpoint size for the mobile media queries

Params
 int $breakpoint Breakpoint size


Return
 int
Copied!
Copy

Filter the message when a product has been added succesfully to the cart from the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter whether to redirect after the 'Ask for an estimate' form has been submitted

Params
 bool $redirect Whether to redirect or not


Return
 bool
Copied!
Copy

Filter the URL to redirect after the 'Ask for an estimate' form has been submitted

Params
 string $redirect_url Redirect URL


Return
 string
Copied!
Copy

Filter the label of the 'Add to cart' button in the wishlist page

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the URL to redirect after adding to the cart from the wishlist

Params
 string     $redirect_url Redirect URL
 string     $original_url Original URL
 WC_Product $product      Product object


Return
 string
Copied!
Copy

Filter the array with the custom CSS rules to be used

Params
 array $css_rules CSS rules


Return
 array

includes/class-yith-wcwl-privacy.php

Copied!
Copy

Filter the content of the privacy policy

Params
 string $content Privacy policy content
 string $section Privacy policy section


Return
 string
Copied!
Copy

Filter whether to delete the personal data from the wishlist

Params
 bool               $condition Whether to delete personal data or not
 YITH_WCWL_Wishlist $wishlist  Wishlist object


Return
 bool
Copied!
Copy

Filter the personal data props to export from the wishlist

Params
 array              $data_to_export Personal data to export
 YITH_WCWL_Wishlist $wishlist       Wishlist object


Return
 array
Copied!
Copy

Filter the personal data value to export from the wishlist

Params
 string             $value    Value to export
 string             $prop     Prop data to export
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the personal data to export from the wishlist

Params
 array              $personal_data Personal data to export
 YITH_WCWL_Wishlist $wishlist      Wishlist object


Return
 array

includes/class-yith-wcwl-session.php

Copied!
Copy

Filter whether to set the session cookie

Params
 bool $set_session_cookie Whether to set session cookie or not


Return
 bool
Copied!
Copy

Filter whether to use secure cookies

Params
 bool $use_secure_cookie Wether to use secure cookies or not


Return
 bool
Copied!
Copy

Filter the session cookie name

Params
 string $cookie_name Cookie name


Return
 string

includes/class-yith-wcwl-shortcode-extended.php

Copied!
Copy

Filter whether to show the update button in the wishlist

Params
 bool               $show_update Whether to show update button or not
 YITH_WCWL_Wishlist $wishlist    Wishlist object


Return
 bool

includes/class-yith-wcwl-shortcode.php

Copied!
Copy

Filter the array of parameters to see the current wishlist

Params
 array $params Array of parameters


Return
 array
Copied!
Copy

Filter the alternative text for the heading icon in the widget

Params
 string $text Alternative text


Return
 string
Copied!
Copy

Filter the width for the heading icon in the widget

Params
 string $width Icon width


Return
 string
Copied!
Copy

Filter the title to share the wishlist on the different socials

Params
 string $share_title Share title


Return
 string
Copied!
Copy

Filter the wishlist URL to share

Params
 string             $share_link_url Share link URL
 YITH_WCWL_Wishlist $wishlist       Wishlist object


Return
 string
Copied!
Copy

Filter the title to share the wishlist

Params
 string             $share_title Share title
 YITH_WCWL_Wishlist $wishlist    Wishlist object


Return
 string
Copied!
Copy

Filter the array with the paramters in the wishlist page

Params
 array  $additional_params Wishlist parameters
 string $action            Action
 array  $action_params     Action parameters
 string $pagination        Use pagination or not
 int    $per_page          Number of items per page
 array  $atts              Array of attributes


Return
 array
Copied!
Copy

Filter the label of the 'Add to wishlist' button

Params
 string $label_option Button label


Return
 string
Copied!
Copy

Filter the icon of the 'Add to wishlist' button

Params
 string $icon Button icon


Return
 string
Copied!
Copy

Filter the added icon of the 'Add to wishlist' button

Params
 string $icon Button added icon


Return
 string
Copied!
Copy

Filter the CSS classes of the 'Add to wishlist' button

Params
 string $classes Button classes


Return
 string
Copied!
Copy

Filter the label to remove from the wishlist

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the label to browse the wishlist

Params
 string $browse_wishlist Browse wishlist text


Return
 string
Copied!
Copy

Filter the text when the product is already in the wishlist

Params
 string $already_in_wishlist 'Already in wishlist' text


Return
 string
Copied!
Copy

Filter the text when the product has been added to the wishlist

Params
 string $product_added 'Product added to the wishlist' text


Return
 string
Copied!
Copy

Filter the array with the paramters for the 'Add to wishlist' action

Params
 array  $additional_params Wishlist parameters
 array  $atts              Array of attributes


Return
 array
Copied!
Copy

Filter the HTML of the icon for the 'Add to wishlist'

Params
 string $icon_html HTML icon
 array  $atts      Array of attributes


Return
 string
Copied!
Copy

Filter the HTML of the heading icon for the 'Add to wishlist'

Params
 string $icon_html HTML icon
 array  $atts      Array of attributes


Return
 string
Copied!
Copy

Filter the HTML of the 'Add to wishlist' button

Params
 string $template     Button HTML
 string $wishlist_url Wishlist URL
 string $product_type Product type
 bool   $exists       Whether the product is already in the wishlist
 array  $atts         Array of attributes


Return
 string

includes/class-yith-wcwl-wishlist-factory.php

Copied!
Copy

Filter the array of parameters to get wishlists

Params
 array $args Array of parameters


Return
 array
Copied!
Copy

Filter the result of the query to get wishlists

Params
 array $results Query results
 array $args    Array of parameters


Return
 array
Copied!
Copy

Filter the array of parameters to get wishlists count

Params
 array $args Array of parameters


Return
 array
Copied!
Copy

Filter the result of the query to get wishlists count

Params
 int   $result Query results
 array $args   Array of parameters


Return
 int
Copied!
Copy

Filter the array of parameters to get wishlists users

Params
 array $args Array of parameters


Return
 array
Copied!
Copy

Filter the result of the query to get wishlists users

Params
 array $results Query results
 array $args   Array of parameters


Return
 array
Copied!
Copy

Filter the array of parameters to see the current wishlist

Params
 array $params Array of parameters


Return
 array
Copied!
Copy

Filter the default wishlist created

Params
 YITH_WCWL_Wishlist $default_wishlist Default wishlist
 int                $id               Customer or session ID
 string             $context          Context


Return
 YITH_WCWL_Wishlist
Copied!
Copy

Filter the array of parameters to get wishlist items

Params
 array $args Array of parameters


Return
 array
Copied!
Copy

Filter the result of the query to get wishlist items

Params
 array $results Query results
 array $args    Array of parameters


Return
 array
Copied!
Copy

Filter the array of parameters to get wishlist items count

Params
 array $args Array of parameters


Return
 array
Copied!
Copy

Filter the result of the query to get wishlist items count

Params
 int   $result Query results
 array $args   Array of parameters


Return
 int
Copied!
Copy

Filter the result of the query to get how many times a product has been added to a wishlist

Params
 int $result     Query results
 int $product_id Product ID


Return
 int
Copied!
Copy

Filter the result of the query to get how many times a product has been added to a wishlist by the current user

Params
 int $result     Query results
 int $product_id Product ID


Return
 int

includes/class-yith-wcwl-wishlist-item.php

Copied!
Copy

Filter the text shown when a product in the wishlist has no price

Params
 string     $text    Text
 WC_Product $product Product object


Return
 string
Copied!
Copy

Filter the formatted price for a wishlist item

Params
 string     $formatted_price Formatted price
 string     $base_price      Base price
 WC_Product $product         Product object


Return
 string
Copied!
Copy

Filter whether to show the price difference in the wishlist

Params
 bool       $show_difference   Whether to show price difference or not
 WC_Product $product           Product object
 string     $original_price    Original price
 string     $original_currency Original currency
 float      $difference        Price difference


Return
 bool
Copied!
Copy

Filter the HTML string to show the price difference in the wishlist

Params
 string $html HTML string


Return
 string
Copied!
Copy

Filter the URL to remove an item from the wishlist

Params
 string $url URL to remove item from the wishlist


Return
 string
Copied!
Copy

Filter the wishlist item legacy offsets to index to new properties

Params
 string $offset        Offset to search
 string $legacy_offset Legacy offset


Return
 string

includes/class-yith-wcwl-wishlist.php

Copied!
Copy

Filter the default Wishlist privacy

Params
 string $wishlist_privacy Default wishlist privacy. Possible values are 0 (Public), 1 (Shared) or 2 (Private)


Return
 string
Copied!
Copy

Filter the default Wishlist name

Params
 string $wishlist_name Default wishlist name


Return
 string
Copied!
Copy

Filter the default Wishlist slug

Params
 string $wishlist_slug Default wishlist slug


Return
 string
Copied!
Copy

Filters whether the current user is the wishlist owner

Params
 bool $is_owner Whether the current user is the wishlist owner


Return
 bool
Copied!
Copy

Filter whether admin can perform a specific action on wishlist

Params
 bool               $user_can     Whether admin can perform some actions on the wishlist
 string             $capability   Capability
 WP_User            $current_user Current user
 YITH_WCWL_Wishlist $wishlist     Wishlist object


Return
 bool
Copied!
Copy

Filter whether current user can perform a specific action on wishlist

Params
 bool               $user_can     Whether current user can perform some actions on the wishlist
 string             $capability   Capability
 WP_User            $current_user Current user
 YITH_WCWL_Wishlist $wishlist     Wishlist object


Return
 bool
Copied!
Copy

Filter the formatted wishlist privacy label

Params
 string             $formatted_privacy Formatted privacy label
 int                $privacy           Privacy option
 YITH_WCWL_Wishlist $wishlist          Wishlist object
 string             $context           Context


Return
 string
Copied!
Copy

Filter the default wishlist title

Params
 string $title Default wishlist title


Return
 string
Copied!
Copy

Filter the formatted wishlist title

Params
 string $title Formatted wishlist title


Return
 string
Copied!
Copy

Filter the URL to download the wishlist PDF

Params
 string             $download_url PDF download URL
 YITH_WCWL_Wishlist $wishlist     Wishlist object


Return
 string
Copied!
Copy

Filter the URL to delete the wishlist

Params
 string             $delete_url Delete wishlist URL
 YITH_WCWL_Wishlist $wishlist   Wishlist object


Return
 string
Copied!
Copy

Filter the wishlist items

Params
 array              $wishlist_items Wishlist items
 YITH_WCWL_Wishlist $wishlist       Wishlist object


Return
 string
Copied!
Copy

Filter the wishlist legacy offsets to index to new properties

Params
 string $offset        Offset to search
 string $legacy_offset Legacy offset


Return
 string

includes/class-yith-wcwl.php

Copied!
Copy

Filter the ID of the product added to the wishlist

Params
 int $product_id Product ID


Return
 int
Copied!
Copy

Filter the wishlist ID where the products are added to

Params
 int $wishlist_id Wishlist ID


Return
 int
Copied!
Copy

Filter the quantity of the product added to the wishlist

Params
 int $quantity   Product quantity
 int $product_id Product ID


Return
 int
Copied!
Copy

Filter the user ID saved in the wishlist

Params
 int $user_id User ID


Return
 int
Copied!
Copy

Filter the date when the wishlist was created

Params
 int $date_added Date when the wishlist was created (timestamp)


Return
 int
Copied!
Copy

Filter the message shown when the product can't be added to the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the message shown when the product is already in the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the message shown when the product can't be removed the wishlist

Params
 string $message Message


Return
 string
Copied!
Copy

Filter the wishlist from which products will be removed

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
 array              $atts     Array of parameters


Return
 YITH_WCWL_Wishlist
Copied!
Copy

Filter whether the product will be removed from the wishlist after it has been added to the cart

Params
 bool               $remove_after_add_to_cart Whether the item will be removed from the wishlist after added to cart or not
 YITH_WCWL_Wishlist $wishlist                 Wishlist object


Return
 bool
Copied!
Copy

Filter whether the product is already in the wishlist

Params
 bool $is_in_wishlist Whether the product is already in the wishlist
 int  $product_id     Product ID
 int  $wishlist_id    Wishlist ID


Return
 bool
Copied!
Copy

Filter whether the current user can add products to the wishlist

Params
 bool $can_add_to_wishlist Whether the product is already in the wishlist
 int  $user_id        User ID


Return
 bool
Copied!
Copy

Filter the wishlist param

Params
 string $wishlist_param Wishlist param


Return
 string
Copied!
Copy

Filter the wishlist page ID

Params
 int $wishlist_page_id Wishlist page ID


Return
 int
Copied!
Copy

Filter the wishlist page URL

Params
 string $wishlist_page_url Wishlist page URL
 string $action            Action


Return
 string
Copied!
Copy

Filter the URL to add products to the wishlist

Params
 string $url        URL to add to wishlist
 int    $product_id Product ID
 array  $args       Array of parameters


Return
 string
Copied!
Copy

Filter the available views in the wishlist page

Params
 array $views Available views


Return
 array

includes/data-stores/class-yith-wcwl-wishlist-data-store.php

Copied!
Copy

Filter the user ID saved in the wishlist

Params
 int $user_id User ID


Return
 int
Copied!
Copy

Filter the session ID saved in the wishlist

Params
 string $session_id Session ID


Return
 string
Copied!
Copy

Filter the wishlist privacy

Params
 int $privacy Wishlist privacy


Return
 int
Copied!
Copy

Filter the wishlist name

Params
 string $name Wishlist name


Return
 string
Copied!
Copy

Filter the wishlist slug

Params
 string $slug Wishlist slug


Return
 string
Copied!
Copy

Filter the wishlist token

Params
 string $token Wishlist token


Return
 string
Copied!
Copy

Filter whether is the default wishlist

Params
 bool $bool Is default wishlist?


Return
 bool
Copied!
Copy

Filter the date when the wishlist was created

Params
 int $date_added Date when the wishlist was created (timestamp)


Return
 int
Copied!
Copy

Filter the date when the wishlist will expire

Params
 int $expiration_date Date when the wishlist will expire (timestamp)


Return
 int
Copied!
Copy

Filter the ID of the Wishlist created

Params
 int $id Wishlist ID


Return
 int
Copied!
Copy

Filter the session ID of the updated wishlist

Params
 string $session_id Session ID


Return
 string
Copied!
Copy

Filter the user ID of the updated wishlist

Params
 int $user_id User ID


Return
 int
Copied!
Copy

Filter the expiration date of the updated wishlist

Params
 int $expiration_date Date when the wishlist will expire (timestamp)


Return
 int
Copied!
Copy

Filter the wishlist visibility value

Params
 string $wishlist_visibility Wishlist visibility. Possible values are: all | visible | public | shared | private


Return
 string
Copied!
Copy

Filter the wishlists retrieved in the query

Params
 array $lists Array of wishlists
 array $args  Array of arguments


Return
 array
Copied!
Copy

Filter whether to remove hidden products via query

Params
 bool $bool Remove hidden products or not?


Return
 bool
Copied!
Copy

Filter the order arguments for the query

Params
 array $args Array of order arguments


Return
 array
Copied!
Copy

Filter the products retrieved from the wishlist

Params
 array $items Array of products
 array $args  Array of arguments


Return
 array
Copied!
Copy

Filter whether merge all default wishlists into the oldest one

Params
 bool $bool Merge all default wishlists or not?


Return
 bool
Copied!
Copy

Filter the default wishlist title

Params
 string $title Default wishlist title


Return
 string

includes/data-stores/class-yith-wcwl-wishlist-item-data-store.php

Copied!
Copy

Filter the ID of the product added to the wishlist

Params
 int $product_id Product ID


Return
 int
Copied!
Copy

Filter the quantity of the product added to the wishlist

Params
 int $quantity   Product quantity
 int $product_id Product ID


Return
 int
Copied!
Copy

Filter the wishlist ID where the products are added to

Params
 int $wishlist_id Wishlist ID


Return
 int
Copied!
Copy

Filter the position where the product will be added to the wishlist

Params
 int $item_position Item position in the wishlist


Return
 int
Copied!
Copy

Filter the price of the product added to the wishlist

Params
 int $product_price Product price


Return
 int
Copied!
Copy

Filter the currency of the product added to the wishlist

Params
 string $currency Currency


Return
 string
Copied!
Copy

Filter whether the product added to the wishlist is on sale

Params
 bool $bool Is the product on sale or not?


Return
 bool
Copied!
Copy

Filter the user ID saved in the wishlist

Params
 int $user_id User ID


Return
 int
Copied!
Copy

Filter the date when the wishlist was created

Params
 int $date_added Date when the wishlist was created (timestamp)


Return
 int
Copied!
Copy

Filter the wishlist visibility value

Params
 string $wishlist_visibility Wishlist visibility. Possible values are: all | visible | public | shared | private


Return
 string
Copied!
Copy

Filter whether to remove hidden products via query

Params
 bool $bool Remove hidden products or not?


Return
 bool
Copied!
Copy

Filter the products retrieved from the wishlist

Params
 array $items Array of products
 array $args  Array of arguments


Return
 array

includes/emails/class-yith-wcwl-back-in-stock-email.php

Copied!
Copy

Filter the label for the unsubscribe link in the emails

Params
 string                        $label Label
 YITH_WCWL_Back_In_Stock_Email $email Email object


Return
 string
Copied!
Copy

Filter the HTML content in the email

Params
 string $content Email content
 object $object  Email object


Return
 string
Copied!
Copy

Filter the text content in the email

Params
 string $content Email content
 object $object  Email object


Return
 string

includes/functions-yith-wcwl.php

Copied!
Copy

Filter whether the current page is the wishlist page

Params
 bool $is_wishlist_page Whether current page is wishlist page or not


Return
 bool
Copied!
Copy

Filter whether the ATW button is being printed in a single product page

Params
 bool $is_product Whether current page is a product page or not


Return
 bool
Copied!
Copy

Filter if is enabled the responsive layout

Params
 bool $is_wishlist_responsive Whether responsive layout is enabled or not


Return
 bool
Copied!
Copy

Filter the location of the templates

Params
 string $located Template found
 string $path    Template path


Return
 string
Copied!
Copy

Filter the hierarchy structure of the plugin templates and templates parts

Params
 array  $template_hierarchy Template hierarchy
 string $template           Template
 string $template_part      Template part
 string $template_layout    Template layout
 array  $var                Array of data


Return
 array
Copied!
Copy

Filter the text shown when a product has not been added to any wishlist

Params
 string $text       Text
 int    $product_id Product ID


Return
 string
Copied!
Copy

Filter the text that states how many users added a specific product to wishlist

Params
 string $label              Text
 int    $product_id         Product ID
 int    $current_user_count Current user count
 int    $count              Total count


Return
 string
Copied!
Copy

Filter the cookie expiration

Params
 int $cookie_expiration Cookie expiration


Return
 int
Copied!
Copy

Filter whether to set the cookie

Params
 bool $set_cookie Whether to set cookie or not


Return
 bool
Copied!
Copy

Filter the cookie expiration time

Params
 int $time Cookie expiration time


Return
 int
Copied!
Copy

Filter the array of hidden products

Params
 array $hidden_products Hidden products


Return
 array
Copied!
Copy

Filter the icons used in the plugin

Params
 array  $icons        Icons
 string $none_label   Label to use for none option
 string $custom_label Label to use for custom option


Return
 array
Copied!
Copy

Filter the privacy label for the wishlist privacy status

Params
 string $privacy_text Privacy text
 bool   $extended     Whether to show extended or simplified label
 int    $privacy      Privacy value


Return
 string
Copied!
Copy

Filter the privacy value

Params
 int    $privacy_value Privacy value
 string $privacy_label Privacy label


Return
 string
Copied!
Copy

Filter the current URL

Params
 string $current_url Current URL
 string $url         URL


Return
 string
Copied!
Copy

Filter the Wishlist object ID

Params
 int    $id              Object ID
 string $type            Object type
 bool   $return_original Whether to return original object if no translation is found
 string $lang            Language to use for translation


Return
 int
Copied!
Copy

Filter the allowed HTML for the icons

Params
 array $allowed_icon_html Allowed HTML


Return
 array

plugin-options/promotion_email-options.php

Copied!
Copy

Filter the options available in the 'Promotional' tab

Params
 array $options Array of options


Return
 array

plugin-options/settings/add_to_wishlist-options.php

Copied!
Copy

Filter the options available in the 'Add to wishlist options' tab

Params
 array $options Array of options


Return
 array
Copied!
Copy

Filter the default 'Add to wishlist' icon

Params
 string $icon Default icon


Return
 array
Copied!
Copy

Filter the default 'Added to wishlist' icon

Params
 string $icon Default icon


Return
 array

plugin-options/settings/general-options.php

Copied!
Copy

Filter the options available in the 'General settings' tab

Params
 array $options Array of options


Return
 array

plugin-options/settings/wishlist_page-options.php

Copied!
Copy

Filter the options available in the 'Wishlist page options' tab

Params
 array $options Array of options


Return
 array
Copied!
Copy

Filter the default 'Add to cart' icon in the Wishlist page

Params
 string $icon Default icon


Return
 string

templates/add-to-wishlist-added.php

Copied!
Copy

Filter the label to browse the wishlist

Params
 string $text       Browse wishlist text
 int    $product_id Product ID
 string $icon       Icon


Return
 string

templates/add-to-wishlist-browse.php

Copied!
Copy

Filter whether to show the 'Add to wishlist' text on the product image

Params
 bool $condition Whether show or not the text in the image


Return
 bool
Copied!
Copy

Filter the label to browse the wishlist

Params
 string $text       Browse wishlist text
 int    $product_id Product ID
 string $icon       Icon


Return
 string

templates/add-to-wishlist-button.php

Copied!
Copy

Filter the 'Add to wishlist' label

Params
 string $label Label


Return
 string

templates/add-to-wishlist-remove.php

Copied!
Copy

Filter the 'Add to wishlist' label

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the 'View wishlist' label

Params
 string $label Label


Return
 string

templates/emails/products-table.php

Copied!
Copy

Filter the CSS class added to each product row inside the emails

Params
 string                  $class CSS class
 YITH_WCWL_Wishlist_Item $item  Wishlist item object


Return
 string

templates/share.php

Copied!
Copy

Filter the subject for the share email

Params
 string $subject Email subject


Return
 string
Copied!
Copy

Filter the body for the share email

Params
 string $body Email body


Return
 string

templates/wishlist-view-footer-mobile.php

Copied!
Copy

Filter the label of the bulk action selector in the Wishlist page

Params
 string $label Label


Return
 string
Copied!
Copy

Filters the label for the buk action to remove the items from the wishlist

Params
 string $label Label.


Return
 string
Copied!
Copy

Filter the icon for the 'Ask for an estimate'

Params
 string $icon Icon


Return
 string
Copied!
Copy

Filter the text for the 'Ask for an estimate'

Params
 string $text Text


Return
 string
Copied!
Copy

Filter the condition to load the 'Ask for an estimate' template

Params
 bool $condition Condition to load the template


Return
 bool
Copied!
Copy

Filter the condition to load the template to move products to another wishlist

Params
 bool $condition Condition to load the template


Return
 bool

templates/wishlist-view-footer.php

Copied!
Copy

Filter the label of the bulk action selector in the Wishlist page

Params
 string $label Label


Return
 string
Copied!
Copy

Filters the label for the buk action to remove the items from the wishlist

Params
 string $label Label.


Return
 string
Copied!
Copy

Filter the icon for the 'Ask for an estimate'

Params
 string $icon Icon


Return
 string
Copied!
Copy

Filter the text for the 'Ask for an estimate'

Params
 string $text Text


Return
 string
Copied!
Copy

Filter the condition to load the 'Ask for an estimate' template

Params
 bool $condition Condition to load the template


Return
 bool
Copied!
Copy

Filter the condition to load the template to move products to another wishlist

Params
 bool $condition Condition to load the template


Return
 bool

templates/wishlist-view-mobile.php

Copied!
Copy

Filter if show the 'Add to cart' button in the wishlist table for each product

Params
 bool                    $show_add_to_cart Show 'Add to cart' button or not
 YITH_WCWL_Wishlist_Item $item             Wishlist item object
 YITH_WCWL_Wishlist      $wishlist         Wishlist object


Return
 bool
Copied!
Copy

Filter the label to move the product to another wishlist

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the title of the button to remove the product from the wishlist

Params
 string $title Button title


Return
 string
Copied!
Copy

Filter the message shown when there are no products in the wishlist

Params
 string $message Message


Return
 string

templates/wishlist-view.php

Copied!
Copy

Filter the heading of the column to remove the product from the wishlist in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the column to show the product name in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the column to show the product price in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the column to show the product quantity in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the column to show the product stock status in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the cart column in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the heading of the column to change order of the items in the wishlist table

Params
 string             $heading  Heading text
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string
Copied!
Copy

Filter the title of the icon to remove the product from the wishlist

Params
 string $title Icon title


Return
 string
Copied!
Copy

Filter the label when the product in the wishlist is out of stock

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the label when the product in the wishlist is in stock

Params
 string $label Label


Return
 string
Copied!
Copy

Filters the HTML for the stock status label

Params
 string                  $stock_status_html Stock status HTML.
 YITH_WCWL_Wishlist_Item $item              Wishlist item object.
 YITH_WCWL_Wishlist      $wishlist          Wishlist object.


Return
 string
Copied!
Copy

Filter if show the 'Add to cart' button in the wishlist table for each product

Params
 bool                    $show_add_to_cart Show 'Add to cart' button or not
 YITH_WCWL_Wishlist_Item $item             Wishlist item object
 YITH_WCWL_Wishlist      $wishlist         Wishlist object


Return
 bool
Copied!
Copy

Filter if show the 'Move to another wishlist' button in the wishlist table for each product

Params
 bool                    $move_to_another_wishlist Show 'Move to another wishlist' button or not
 YITH_WCWL_Wishlist_Item $item                     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist                 Wishlist object


Return
 bool
Copied!
Copy

Filter the label to move the product to another wishlist

Params
 string $label Label


Return
 string
Copied!
Copy

Filter the title of the button to remove the product from the wishlist

Params
 string $title Button title


Return
 string
Copied!
Copy

Filter the message shown when there are no products in the wishlist

Params
 string             $message  Message
 YITH_WCWL_Wishlist $wishlist Wishlist object


Return
 string

Actions

Home > Development

includes/class-yith-wcwl-admin.php

Copied!
Copy

Allows to fire some action when the plugin database is updated

Copied!
Copy

Allows to fire some action when the plugin database is installed

includes/class-yith-wcwl-ajax-handler.php

Copied!
Copy

Allows to fire some action when the wishlist has been renamed

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object

includes/class-yith-wcwl-cron-extended.php

Copied!
Copy

Allows to fire some action when the 'Back in stock' email is sent

Params
 WP_User $user  User object
 array   $items Wishlist items

includes/class-yith-wcwl-cron-premium.php

Copied!
Copy

Allows to fire some action when the 'On sale item' email is sent

Params
 WP_User $user  User object
 array   $items Wishlist items
Copied!
Copy

Allows to fire some action when the 'Promotional' email is sent

Params
 array $receivers Array of user IDs
 array $item      Email content

includes/class-yith-wcwl-frontend.php

Copied!
Copy

Allows to fire some action when the frontend class has loaded all the requirements

includes/class-yith-wcwl-privacy.php

Copied!
Copy

Allows to fire some action before deleting the personal data from the wishlist

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
Copied!
Copy

Allows to fire some action when deleting the personal data from the wishlist

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object

includes/class-yith-wcwl-wishlist-item.php

Copied!
Copy

Allows to fire some action when a wishlist item is set on sale

Params
 YITH_WCWL_Wishlist_Item $wishlist_item Wishlist item object

includes/class-yith-wcwl.php

Copied!
Copy

Allows to fire some action when a product is added to a wishlist

Params
 int $prod_id     Product ID
 int $wishlist_id Wishlist ID
 int $user_id     User ID
Copied!
Copy

Allows to fire some action when a product has been added to a wishlist

Params
 int $prod_id     Product ID
 int $wishlist_id Wishlist ID
 int $user_id     User ID
Copied!
Copy

Allows to fire some action when removing a product from a wishlist

Params
 int $prod_id     Product ID
 int $wishlist_id Wishlist ID
 int $user_id     User ID
Copied!
Copy

Allows to fire some action when a product has been removed from a wishlist

Params
 int $prod_id     Product ID
 int $wishlist_id Wishlist ID
 int $user_id     User ID

includes/data-stores/class-yith-wcwl-wishlist-data-store.php

Copied!
Copy

Allows to fire some action when a new wishlist is created

Params
 int                $wishlist_id   Wishlist ID
 YITH_WCWL_Wishlist $wishlist_data Wishlist object
Copied!
Copy

Allows to fire some action when a wishlist is updated

Params
 int                $wishlist_id   Wishlist ID
 YITH_WCWL_Wishlist $wishlist_data Wishlist object
Copied!
Copy

Allows to fire some action before a wishlist is deleted

Params
 int $wishlist_id Wishlist ID
Copied!
Copy

Allows to fire some action when a wishlist is deleted

Params
 int $wishlist_id Wishlist ID
Copied!
Copy

Allows to fire some action after a wishlist is deleted

Params
 int $id Wishlist ID
Copied!
Copy

Allows to fire some action when default wishlist is created

Params
 YITH_WCWL_Wishlist $default_wishlist Default wishlist object
 int                $id               Wishlist ID

includes/data-stores/class-yith-wcwl-wishlist-item-data-store.php

Copied!
Copy

Allows to fire some action when a new item is added to the wishlist

Params
 int                     $item_id     Wishlist item ID
 YITH_WCWL_Wishlist_Item $item        Wishlist item object
 int                     $wishlist_id Wishlist ID
Copied!
Copy

Allows to fire some action when an item is updated in the wishlist

Params
 int                     $item_id     Wishlist item ID
 YITH_WCWL_Wishlist_Item $item        Wishlist item object
 int                     $wishlist_id Wishlist ID
Copied!
Copy

Allows to fire some action before an item is deleted from the wishlist

Params
 int $item_id Wishlist item ID
Copied!
Copy

Allows to fire some action when an item is deleted from the wishlist

Params
 int $item_id Wishlist item ID

includes/tables/class-yith-wcwl-popular-table.php

Copied!
Copy

Allows to render some content or fire some action after the Popular items table

includes/tables/class-yith-wcwl-users-popular-table.php

Copied!
Copy

Allows to render some content or fire some action after the Popular items table

init.php

Copied!
Copy

Allows the plugin initialization

templates/share.php

Copied!
Copy

Allows to render some content or fire some action before the share wishlist section

Copied!
Copy

Allows to render some content or fire some action after the share buttons in the Wishlist page

Params
 string $share_link_url   Share link URL
 string $share_title      Share title
 string $share_link_title Share link title
Copied!
Copy

Allows to render some content or fire some action after the share wishlist section

templates/wishlist-view-footer-mobile.php

Copied!
Copy

Allows to render some content or fire some action after the wishlist

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the wishlist form

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object

templates/wishlist-view-footer.php

Copied!
Copy

Allows to render some content or fire some action after the wishlist

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the wishlist form

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object

templates/wishlist-view-header.php

Copied!
Copy

Allows to render some content or fire some action before the wishlist form

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the wishlist title

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the wishlist

Params
 YITH_WCWL_Wishlist $wishlist Wishlist object

templates/wishlist-view-mobile.php

Copied!
Copy

Allows to render some content or fire some action after the product name in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item Wishlist item object

templates/wishlist-view.php

Copied!
Copy

Allows to render some content or fire some action before the product thumbnail in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product thumbnail in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the product name in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product name in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the product price in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product price in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the product quantity in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product quantity in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the product stock in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product stock in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the product cart in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action before the 'Add to cart' in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the 'Add to cart' in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the 'Move to another wishlist' in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object
Copied!
Copy

Allows to render some content or fire some action after the product cart in the wishlist table

Params
 YITH_WCWL_Wishlist_Item $item     Wishlist item object
 YITH_WCWL_Wishlist      $wishlist Wishlist object

templates/wishlist.php

Copied!
Copy

Allows to render some content or fire some action before the wishlist content

Params
 array $var Array of attributes that needs to be sent to sub-template
Copied!
Copy

Allows to render some content or fire some action in the wishlist content

Params
 array $var Array of attributes that needs to be sent to sub-template
Copied!
Copy

Allows to render some content or fire some action after the wishlist content

Params
 array $var Array of attributes that needs to be sent to sub-template