This section documents the hooks available in the app directory of Venddor IO platform.
Variable | Type | Description | |||||
1 | attachment_update_file | ||||||
|
| $attachment_data |
|
| |||
|
| $attachment_id |
|
| |||
|
| $object_type |
|
| |||
|
| $object_id |
|
| |||
|
| $type |
|
| |||
|
| $files |
|
| |||
|
| $lang_code |
|
| |||
|
| $uploaded_data |
|
| |||
|
|
|
|
| |||
2 | attachment_add_file |
|
|
| |||
|
| $attachment_data |
|
| |||
|
| $object_type |
|
| |||
|
| $object_id |
|
| |||
|
| $type |
|
| |||
|
| $files |
|
| |||
|
| $attachment_id |
|
| |||
|
| $uploaded_data |
|
| |||
|
|
|
|
| |||
3 | attachment_delete_file |
|
|
| |||
|
| $attachment_ids |
|
| |||
|
| $object_type |
|
| |||
|
| $object_id |
|
| |||
|
|
|
|
| |||
4 | attachments_get_attachment |
|
|
| |||
|
| $data |
|
| |||
|
| $attachment_id |
|
| |||
|
|
|
|
| |||
5 | attachments_check_permission_pre |
|
|
| |||
| Changes input parameters for attachment permission check | $request | array | Array of query parameters | |||
|
|
|
|
| |||
6 | attachments_check_permission |
|
|
| |||
| Checks permission to work with the attachment | $request | array | Array of query parameters | |||
|
| $table | string | Table to perform check | |||
|
| $field | string | SQL field to be selected in an SQL-query | |||
|
| $condition | string | String containing SQL-query condition prepended with a logical operator (AND or OR) | |||
|
|
|
|
| |||
7 | attachments_check_permission_post |
|
|
| |||
| Changes result of attachment permission check | $request | array | Array of query parameters | |||
|
| $permission |
|
| |||
|
|
|
|
| |||
8 | get_banners |
|
|
| |||
| This hook allows you to change parameters of the banner selection before making an SQL query. | $params | array | The parameters of the user's query (limit, period, item_ids, etc) | |||
|
| $condition | string | The conditions of the selection | |||
|
| $sorting | string | Sorting (ask, desc) | |||
|
| $limit | string | The LIMIT of the returned rows | |||
|
| $lang_code | string | Language code | |||
|
| $fields | array | Selected fields | |||
|
|
|
|
| |||
9 | get_banners_post |
|
|
| |||
|
| $banners |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
10 | get_banner_data |
|
|
| |||
| Prepare params for banner data SQL query | $banner_id | int | Banner ID | |||
|
| $lang_code | str | Language code | |||
|
| $fields | array | Fields list | |||
|
| $joins | array | Joins list | |||
|
| $condition | str | Conditions query | |||
|
|
|
|
| |||
11 | get_banner_data_post |
|
|
| |||
| Post processing of banner data | $banner_id | int | Banner ID | |||
|
| $lang_code | str | Language code | |||
|
| $banner | array | Banner data | |||
|
|
|
|
| |||
12 | delete_banners |
|
|
| |||
|
| $banner_id |
|
| |||
|
|
|
|
| |||
13 | buy_together_update_chain_pre |
|
|
| |||
| Modify product chain update parameters | $item_id | int | Product chain identifier | |||
|
| $product_id | int | Product identifier | |||
|
| $item_data | array | Product chain data | |||
|
| $auth | array | Array of user authentication data | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
14 | buy_together_restricted_product |
|
|
| |||
|
| $product['product_id'] |
|
| |||
|
| $auth |
|
| |||
|
| $is_restricted |
|
| |||
|
| $show_notice |
|
| |||
|
|
|
|
| |||
15 | buy_together_update_chain_post |
|
|
| |||
| Modify product chain update results | $item_id | int | Product chain identifier | |||
|
| $product_id | int | Product identifier | |||
|
| $item_data | array | Product chain data | |||
|
| $auth | array | Array of user authentication data | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
16 | buy_together_get_chains_pre |
|
|
| |||
| Modify product chains get parameters | $params | array | Parameters for the function | |||
|
| $auth | array | Array of user authentication data | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
17 | buy_together_get_chains |
|
|
| |||
| Change select condition (fields, conditions, joins) before selecting payment method data | $params | array | Parameters for the function | |||
|
| $auth | array | Array of user authentication data | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $fields | array | Array of fields to be selected | |||
|
| $conditions | array | Array of complete condition expressions to be applied to the end of an SQL-query | |||
|
| $joins | array | List of strings with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
|
|
|
| |||
18 | buy_together_get_chains_post |
|
|
| |||
| Gets function result along with parameters and query information. | $params | array | Parameters for the function | |||
|
| $auth | array | Array of user authentication data | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $chains | mixed | One chain or array of chains, depending on 'simple' parameter. | |||
|
| $fields | array | Array of fields to be selected | |||
|
| $conditions | array | Array of complete condition expressions to be applied to the end of an SQL-query | |||
|
| $joins | array | List of strings with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
|
|
|
| |||
19 | buy_together_pre_add_to_cart |
|
|
| |||
|
| $product_data |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $update |
|
| |||
|
|
|
|
| |||
20 | buy_together_calculate_cart_post |
|
|
| |||
| Additional actions after 'Buy together' combinations' products changes | $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $cart_products | array | Array of new data for products information update | |||
|
|
|
|
| |||
21 | buy_together_restricted_product |
|
|
| |||
|
| $product['product_id'] |
|
| |||
|
| $auth |
|
| |||
|
| $is_restricted |
|
| |||
|
| $show_notices |
|
| |||
|
|
|
|
| |||
22 | buy_together_restricted_product |
|
|
| |||
|
| $_REQUEST['product_id'] |
|
| |||
|
| $auth |
|
| |||
|
| $is_restricted |
|
| |||
|
| $show_notice |
|
| |||
|
|
|
|
| |||
23 | do_call_request |
|
|
| |||
| Allows to perform some actions before call request is processed | $params | array | Call request parameters | |||
|
| $product_data | array | Product data | |||
|
| $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $company_id | int | Company identifier | |||
|
|
|
|
| |||
24 | call_requests_do_call_request_post |
|
|
| |||
| Allows to perform some actions after call request is processed | $params | array | Parameters | |||
|
| $product_data | array | Product data | |||
|
| $cart | array | Cart data | |||
|
| $auth | array | Authentication data | |||
|
| $result | array | Operation result | |||
|
|
|
|
| |||
25 | catalog_mode_pre_add_to_cart |
|
|
| |||
| Allows to skip clearing the cart when the catalog mode is enabled | $product_data | array | List of products data | |||
|
| $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $update | bool | Flag, if true that is update mode. Usable for order management | |||
|
| $can_delete | bool | Flag, if true that is cart cleared. Usable to pay off the vendor debt. | |||
|
|
|
|
| |||
26 | data_feeds_export_before_get_products |
|
|
| |||
| Executed before get products. Allows you to affect parameters of exported products. | $datafeed_data | array | Data feed info | |||
|
| $pattern | array | Data of export pattern | |||
|
| $params | array | List of products params | |||
|
|
|
|
| |||
27 | data_feeds_export |
|
|
| |||
| Executed before products are exported to a data feed. Allows you to affect the export. | $datafeed_id | int | Data feed identifier | |||
|
| $options | array | List of export options | |||
|
| $pattern | array | Data of export pattern | |||
|
| $fields | array | List of export fields | |||
|
| $datafeed_data | array | Data feed info | |||
|
|
|
|
| |||
28 | prepare_direct_payments_payment_methods |
|
|
| |||
| Allows to modify payment methods grouped by category used for the checkout page. | $cart | array | Array of the cart contents and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $payment_groups | array | List of payment methods grouped by category | |||
|
|
|
|
| |||
29 | user_logout_after |
|
|
| |||
| Allows to perform any actions after user logout. | $auth | array | Auth data from session | |||
|
|
|
|
| |||
30 | checkout_select_default_payment_method |
|
|
| |||
|
| $cart |
|
| |||
|
| $payment_methods |
|
| |||
|
| $completed_steps |
|
| |||
|
|
|
|
| |||
31 | get_discussions_pre |
|
|
| |||
| Executes at the beginning of the function, allowing you to modify the arguments passed to the function. | $params | array | Request parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
|
|
|
| |||
32 | get_discussions |
|
|
| |||
| Executes right before performing discussions-fetching query, allowing you to modify the SQL-query. | $params | array | Request parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $sorting | string | String containing the SQL-query ORDER BY field | |||
|
| $limit | string | String containing the SQL-query LIMIT field | |||
|
|
|
|
| |||
33 | get_discussions_post |
|
|
| |||
| Executes after all discussions were fetched from DB and all data post-processing was done. | $params | array | Request parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
| $posts | array | List of posts in discussion | |||
|
|
|
|
| |||
34 | get_discussion_pre |
|
|
| |||
| Executes at the beginning of the function, allowing you to modify the arguments passed to the function. | $object_id | int | Object identifier | |||
|
| $object_type | string | One-letter object type identifier | |||
|
| $get_posts | bool | If true, posts in discussion will be fetched | |||
|
| $params | array | Extra parameteres | |||
|
|
|
|
| |||
35 | get_discussion_before_sql |
|
|
| |||
| Executes right before performing discussion-fetching query, allowing you to modify the SQL-query. | $object_id | int | Object identifier | |||
|
| $object_type | string | One-letter object type identifier | |||
|
| $get_posts | bool | If true, posts in discussion will be fetched | |||
|
| $params | array | Extra parameteres | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit | string | String containing the SQL-query LIMIT field | |||
|
|
|
|
| |||
36 | get_discussion |
|
|
| |||
| Executes after discussion was fetched from DB before performing data post-processing. | $object_id | int | Object identifier | |||
|
| $object_type | string | One-letter object type identifier | |||
|
| $discussion | array | Discussion object, false if none found | |||
|
|
|
|
| |||
37 | get_discussion_post |
|
|
| |||
| Executes after discussion was fetched from DB and all data post-processing was done. | $object_id | int | Object identifier | |||
|
| $object_type | string | One-letter object type identifier | |||
|
| $get_posts | bool | If true, posts in discussion will be fetched | |||
|
| $params | array | Extra parameteres | |||
|
|
|
|
| |||
38 | get_discussion_posts_pre |
|
|
| |||
| Modifies request parameters for fetching discussion posts | $params | array | Query parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
|
|
|
| |||
39 | get_discussion_posts |
|
|
| |||
| Modifies discuission posts query | $params | array | Query parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
| $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $order_by | string | String containing SQL-query ordering conditions | |||
|
| $limit | string | String containing SQL-query limit conditions | |||
|
|
|
|
| |||
40 | get_discussion_posts_post |
|
|
| |||
| Modifies discussion posts and request parameters | $params | array | Query parameters | |||
|
| $items_per_page | int | Amount of posts per page | |||
|
| $posts | array | Discussion posts | |||
|
|
|
|
| |||
41 | delete_discussion_pre |
|
|
| |||
| Modifies disscussed object properties | $object_id | int | Discussed object identifier | |||
|
| $object_type | string | Discussed object type | |||
|
|
|
|
| |||
42 | delete_discussion_post |
|
|
| |||
| Modifies deletion results @params bool $is_deleted Deletion result |
|
|
| |||
|
| $object_id | int | Discussed object identifier | |||
|
| $object_type | string | Discussed object type | |||
|
| $is_deleted |
|
| |||
|
|
|
|
| |||
43 | add_discussion_post_post |
|
|
| |||
| This hook allows you to access the data of discussions after that data was formatted, recorded to the database, and sent to users by email. | $post_data |
|
| |||
|
| $send_notifications |
|
| |||
|
|
|
|
| |||
44 | get_discussion_object_data |
|
|
| |||
|
| $data |
|
| |||
|
| $object_id |
|
| |||
|
| $object_type |
|
| |||
|
|
|
|
| |||
45 | get_discussion_objects |
|
|
| |||
|
| $discussion_object_types |
|
| |||
|
|
|
|
| |||
46 | is_accessible_discussion |
|
|
| |||
|
| $data |
|
| |||
|
| $auth |
|
| |||
|
| $access |
|
| |||
|
|
|
|
| |||
47 | update_discussion_pre |
|
|
| |||
| This hook allows you to change discussion parameters before they are processed and recorded to the database | $data | array | Discussion params (type, object_type, company_id, etc) | |||
|
|
|
|
| |||
48 | discussion_delete_post_pre |
|
|
| |||
| Modifies deleting discussion post identifier | $post_id | int | Post identifier | |||
|
|
|
|
| |||
49 | discussion_delete_post_post |
|
|
| |||
| Modifies deleted discussion post identifier | $post_id | int | Post identifier | |||
|
|
|
|
| |||
50 | update_discussion_posts_post |
|
|
| |||
| This hook allows you to access the discussions that were already processed and recorded to the database | $posts | array | Discussion data | |||
|
|
|
|
| |||
51 | get_discussion_titles |
|
|
| |||
| Modifies title strings for different discussion types. per type. | $discussion_object_titles | array | Title language variable ids | |||
|
|
|
|
| |||
52 | send_form |
|
|
| |||
| Modify submitted form data before sending an e-mail | $page_data | array | Form structure | |||
|
| $form_values | array | Submitted form data | |||
|
| $result | boolean | True if form data is valid | |||
|
| $from | string | E-mail to send e-mail from | |||
|
| $sender | string | Displayed sender name | |||
|
| $attachments | array | Attachments data | |||
|
| $is_html | boolean | True if e-mail content must be treated as HTML | |||
|
| $subject | string | E-mail subject | |||
|
|
|
|
| |||
53 | form_selectable_elements |
|
|
| |||
|
| $elms |
|
| |||
|
|
|
|
| |||
54 | get_gift_certificate_info |
|
|
| |||
|
| $_certificate |
|
| |||
|
| $certificate |
|
| |||
|
| $type |
|
| |||
|
|
|
|
| |||
55 | delete_gift_certificate |
|
|
| |||
|
| $gift_cert_id |
|
| |||
|
| $extra |
|
| |||
|
|
|
|
| |||
56 | sitemap_link_object |
|
|
| |||
|
| $link |
|
| |||
|
| $object |
|
| |||
|
| $value |
|
| |||
|
|
|
|
| |||
57 | sitemap_link |
|
|
| |||
|
| $link |
|
| |||
|
| $object |
|
| |||
|
| $value |
|
| |||
|
| $languages |
|
| |||
|
| $links |
|
| |||
|
|
|
|
| |||
58 | sitemap_item |
|
|
| |||
|
| $sitemap_settings |
|
| |||
|
| $file |
|
| |||
|
| $lmod |
|
| |||
|
| $link_counter |
|
| |||
|
| $file_counter |
|
| |||
|
|
|
|
| |||
59 | image_zoom_check_image_post |
|
|
| |||
| Post hook for check detail image sizes ration | $file_path | string | File path | |||
|
| $image_data | array | Image data | |||
|
| $images | array | Array with initial images | |||
|
| $use_original_image_format | bool | Whether to generate image with corrected ratio in its original format | |||
|
|
|
|
| |||
60 | newsletters_update_subscriptions_post |
|
|
| |||
| Allows to perform some actions after user subscriptions data is processed | $subscriber_id | int | Subscriber id | |||
|
| $user_list_ids | array | Subscription ids that user wants be subscribed to | |||
|
| $subscriber | array | Subscriber data | |||
|
| $params | array | Parameters | |||
|
|
|
|
| |||
61 | update_newsletter |
|
|
| |||
|
| $newsletter_data |
|
| |||
|
| $newsletter_id |
|
| |||
|
|
|
|
| |||
62 | process_paypal_ipn_create_payout |
|
|
| |||
| Executes before creating a payout based on the return request, allows to modify the payout data. | $order_id | int | Order ID | |||
|
| $data | array | IPN request parameters | |||
|
| $order_info | array | Order info from ::fn_get_order_info() | |||
|
| $payout_data | array | Payout data to be stored in the DB | |||
|
|
|
|
| |||
63 | paypal_get_ipn_order_ids |
|
|
| |||
|
| $data |
|
| |||
|
| $order_ids |
|
| |||
|
|
|
|
| |||
64 | paypal_express_get_order_data |
|
|
| |||
|
| $data |
|
| |||
|
| $order_data |
|
| |||
|
| $product_index |
|
| |||
|
|
|
|
| |||
65 | paypal_apply_discount_post |
|
|
| |||
|
| $data |
|
| |||
|
| $order_data |
|
| |||
|
| $product_index |
|
| |||
|
| $discount_applied |
|
| |||
|
|
|
|
| |||
66 | additional_data_loader_get_variation_codes_by_product_ids |
|
|
| |||
| Executes when fetching product variations codes for speicifed products right before the database query, allows to modify the query. |
|
|
| |||
|
| $statuses | array | List of product statuses | |||
|
| $join | string | JOIN part of the query | |||
|
| $condition | string | WHERE part of the query | |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
|
|
|
|
| |||
67 | quickbooks_export_items |
|
|
| |||
|
| $orders |
|
| |||
|
| $invitem |
|
| |||
|
| $export |
|
| |||
|
|
|
|
| |||
68 | quickbooks_export_order |
|
|
| |||
|
| $order |
|
| |||
|
| $order_products |
|
| |||
|
| $spl |
|
| |||
|
| $export |
|
| |||
|
|
|
|
| |||
69 | reward_points_cart_calculation |
|
|
| |||
|
| $cart_products |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
70 | reward_points_calculate_item |
|
|
| |||
|
| $cart_products |
|
| |||
|
| $cart |
|
| |||
|
| $k |
|
| |||
|
| $v |
|
| |||
|
|
|
|
| |||
71 | reward_points_calculate_item |
|
|
| |||
|
| $cart_products |
|
| |||
|
| $cart |
|
| |||
|
| $k |
|
| |||
|
| $v |
|
| |||
|
|
|
|
| |||
72 | set_point_payment |
|
|
| |||
| Executed before the reward points are applied. | $cart | array | Array of cart data. | |||
|
| $cart_products | array | List of cart products. | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.). | |||
|
| $user_info | array | Array of user data. | |||
|
| $cost_covered_by_applied_points | float | Total sum of products covered by previously applied points. | |||
|
| $point_exchange_rate | float | The number of points equal to 1 conventional unit. | |||
|
| $user_points | float | Total sum of points available for user. | |||
|
|
|
|
| |||
73 | gather_reward_points_data_pre |
|
|
| |||
| Executed before the reward point data is gathered. | $product | array | Array of product data. | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.). | |||
|
| $get_point_info | bool | Determines whether the reward point data is required. Defaults to true. | |||
|
|
|
|
| |||
74 | rma_update_details_pre |
|
|
| |||
|
| $data |
|
| |||
|
|
|
|
| |||
75 | rma_update_details_create_payout |
|
|
| |||
| Executes before creating a payout based on the return request, allows to modify the payout data. | $data | array | Request parameters | |||
|
| $order_info | array | Order information from ::fn_get_orders() | |||
|
| $return_info | array | Return request from ::fn_get_return_info() | |||
|
| $payout_data | array | Payout data to be stored in the DB | |||
|
|
|
|
| |||
76 | rma_update_details_post |
|
|
| |||
|
| $data |
|
| |||
|
| $show_confirmation_page |
|
| |||
|
| $show_confirmation |
|
| |||
|
| $is_refund |
|
| |||
|
| $_data |
|
| |||
|
| $confirmed |
|
| |||
|
|
|
|
| |||
77 | rma_recalculate_order |
|
|
| |||
|
| $item |
|
| |||
|
| $mirror_item |
|
| |||
|
| $type |
|
| |||
|
| $ex_data |
|
| |||
|
| $amount |
|
| |||
|
|
|
|
| |||
78 | generate_rss_feed |
|
|
| |||
| Executes after feed items and properties were fetched from DB and all data post-processing was done | $items_data | array | Feed items | |||
|
| $additional_data | array | Feed properties (title, description, etc.) | |||
|
| $block_data | array | Block settings | |||
|
| $lang_code | string | Two-letter language code | |||
|
|
|
|
| |||
79 | searchanise_signup_post |
|
|
| |||
|
| $connected |
|
| |||
|
|
|
|
| |||
80 | get_filters_products_count_post |
|
|
| |||
| Modifies filters | $params | array | Parameters of filters selection | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $filters | array | Filters array | |||
|
| $selected_filters | array | Selected filters array | |||
|
|
|
|
| |||
81 | delete_seo_name_pre |
|
|
| |||
| Deletes SEO name (running before fn_delete_seo_name() function) | $object_id | int |
| |||
|
| $object_type | string |
| |||
|
| $dispatch | string |
| |||
|
| $company_id | int |
| |||
|
|
|
|
| |||
82 | delete_seo_name_post |
|
|
| |||
| Deletes SEO name (running after fn_delete_seo_name() function) | $result | int |
| |||
|
| $object_id | int |
| |||
|
| $object_type | string |
| |||
|
| $dispatch | string |
| |||
|
| $company_id | int |
| |||
|
|
|
|
| |||
83 | create_seo_name_post |
|
|
| |||
| Create SEO name (running after fn_create_seo_name() function) | $_object_name | int |
| |||
|
| $object_id | int |
| |||
|
| $object_type | string |
| |||
|
| $object_name | string |
| |||
|
| $index | int |
| |||
|
| $dispatch | string |
| |||
|
| $company_id | int |
| |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $params | array | Additional params passed to fn_create_seo_name() function | |||
|
|
|
|
| |||
84 | get_seo_vars |
|
|
| |||
|
| $schema |
|
| |||
|
|
|
|
| |||
85 | get_rewrite_rules |
|
|
| |||
|
| $rewrite_rules |
|
| |||
|
| $prefix |
|
| |||
|
| $extension |
|
| |||
|
|
|
|
| |||
86 | seo_update_objects_pre |
|
|
| |||
|
| $object_data |
|
| |||
|
| $object_id |
|
| |||
|
| $type |
|
| |||
|
| $lang_code |
|
| |||
|
| $seo_objects |
|
| |||
|
|
|
|
| |||
87 | validate_sef_object |
|
|
| |||
|
| $path |
|
| |||
|
| $seo |
|
| |||
|
| $vars |
|
| |||
|
| $result |
|
| |||
|
| $objects |
|
| |||
|
|
|
|
| |||
88 | seo_get_parent_items_path |
|
|
| |||
|
| $object_type |
|
| |||
|
| $object_id |
|
| |||
|
| $id_path |
|
| |||
|
|
|
|
| |||
89 | seo_is_indexed_page |
|
|
| |||
|
| $index_schema |
|
| |||
|
|
|
|
| |||
90 | seo_get_name_pre |
|
|
| |||
| Get name for seo object (running before fn_seo_get_name() function) | $object_type | string |
| |||
|
| $object_id | int |
| |||
|
| $dispatch | string |
| |||
|
| $company_id | int |
| |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
91 | seo_get_name_post |
|
|
| |||
| Get name for seo object (running after fn_seo_get_name() function) | $name | string |
| |||
|
| $object_type | string |
| |||
|
| $object_id | int |
| |||
|
| $dispatch | string |
| |||
|
| $company_id | int |
| |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
92 | seo_url |
|
|
| |||
|
| $seo_settings |
|
| |||
|
| $url |
|
| |||
|
| $parsed_url |
|
| |||
|
| $link_parts |
|
| |||
|
| $parsed_query |
|
| |||
|
| $company_id_in_url |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
93 | get_tags_pre |
|
|
| |||
| Change parameters for getting tags | $params | array | Params list | |||
|
| $items_per_page | int | Tags per page | |||
|
| $default_params | array | Default params | |||
|
|
|
|
| |||
94 | get_tags |
|
|
| |||
| Gets tags | $params | array | Params list | |||
|
| $items_per_page | int | Tags per page | |||
|
| $fields | array | List of SQL fields to be selected in an SQL-query | |||
|
| $joins | array | List of strings with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $conditions | string | String containing the SQL-query conditions prepended with a logical operator (AND or OR) | |||
|
| $group | string | String containing the SQL-query GROUP BY field | |||
|
| $sorting | string | String containing the SQL-query ORDER BY field | |||
|
|
|
|
| |||
95 | get_tags_post |
|
|
| |||
| Change tags | $params | array | Params list | |||
|
| $items_per_page | int | Tags per page | |||
|
| $tags | array | Tags | |||
|
|
|
|
| |||
96 | delete_tags_post |
|
|
| |||
| This hook is executed after the tags are deleted from the database by their numeric identifiers | $tag_ids | array | The numeric identifiers of the tags | |||
|
|
|
|
| |||
97 | delete_tags_by_params_post |
|
|
| |||
| Actions after deleting the tag data by parameters. | $params | array | This hook is executed after the tags are deleted by the specified parameters | |||
|
|
|
|
| |||
98 | update_tags_post |
|
|
| |||
| This hook is executed after the data of the tags has been updated. | $tags_data | array | The data required for updating the tag. | |||
|
| $for_all_companies | bool | The parameter that determines whether or not to update the tag data for all companies; true - update tag data for all companies. | |||
|
|
|
|
| |||
99 | get_tag_objects |
|
|
| |||
|
| $types |
|
| |||
|
|
|
|
| |||
100 | change_approval_status_pre |
|
|
| |||
| Changes the values in the array of product identifiers before the approval status of those products is changed. | $status | string | Approval status | |||
|
| $status |
|
| |||
|
|
|
|
| |||
101 | vendor_plans_calculate_commission_for_payout_before |
|
|
| |||
| This hook is executed before the commission amount was calculated for a payout. Allows to modify the values that payout calculation is based on. | $order_info | array | Order information | |||
|
| $company_data | array | Company to which order belongs to | |||
|
| $payout_data | array | Payout data to be written to database | |||
|
| $total | float | Order total amount | |||
|
| $shipping_cost | float | Order shipping cost amount | |||
|
| $surcharge_from_total | float | Order payment surcharge to be subtracted from total | |||
|
| $surcharge_to_commission | float | Order payment surcharge to be added to commission amount | |||
|
| $commission | float | The transaction percent value | |||
|
|
|
|
| |||
102 | vendor_plans_calculate_commission_for_payout_post |
|
|
| |||
| This hook is executed after the commission amount was calculated for a payout. Allows to modify payout data. | $order_info | array | Order information | |||
|
| $company_data | array | Company to which order belongs to | |||
|
| $payout_data | array | Payout data to be written to database | |||
|
|
|
|
| |||
103 | plans_companies_get_list_post |
|
|
| |||
| Process selected companies data | $instance | object | Current model instance | |||
|
| $items | array | Items | |||
|
| $params | array | Params array | |||
|
|
|
|
| |||
104 | plans_companies_get_list_post |
|
|
| |||
| Company payout | $instance | object | Current model instance | |||
|
| $payout_id | int | Payout ID | |||
|
| $price | float | Price | |||
|
| $time | int | Unix timestamp | |||
|
|
|
|
| |||
105 | plans_companies_get_list_post |
|
|
| |||
| Getting current company products | $instance | object | Current model instance | |||
|
| $products | int | Products count | |||
|
|
|
|
| |||
106 | plans_companies_get_list_post |
|
|
| |||
| Can company add product | $instance | object | Current model instance | |||
|
| $notify | bool | Notify flag | |||
|
| $can | bool | Can add product flag | |||
|
|
|
|
| |||
107 | plans_companies_get_list_post |
|
|
| |||
| Getting current company revenue | $instance | object | Current model instance | |||
|
| $revenue | float | Revenue | |||
|
| $today | int | Today unix timestamp | |||
|
| $time_from | int | Time from unix timestamp | |||
|
| $time_to | int | Time to unix timestamp | |||
|
| $statuses | array | Order payout statuses | |||
|
|
|
|
| |||
108 | plans_companies_get_list_post |
|
|
| |||
| Can vendor get revenue | $instance | object | Current model instance | |||
|
| $notify | bool | Notify flag | |||
|
| $can | bool | Can add product flag | |||
|
|
|
|
| |||
109 | vendor_plan_get_fields |
|
|
| |||
| Change fields list for main SQL query | $instance | object | Current model instance | |||
|
| $fields | array | Fields list | |||
|
| $params | array | Params array | |||
|
|
|
|
| |||
110 | vendor_plan_get_search_fields |
|
|
| |||
| Setting search fields schema | $instance | object | Current model instance | |||
|
| $search_fields | array | Fields list | |||
|
|
|
|
| |||
111 | vendor_plan_get_sort_fields |
|
|
| |||
| Setting sorting fields schema | $instance | object | Current model instance | |||
|
| $sort_fields | array | Sorting fields schema | |||
|
|
|
|
| |||
112 | vendor_plan_get_relations |
|
|
| |||
| Setting relations schema | $instance | object | Current model instance | |||
|
| $relations | array | Relations schema | |||
|
|
|
|
| |||
113 | vendor_plan_get_list |
|
|
| |||
| Change SQL parameters for vendor plans select | $instance | object | Current model instance | |||
|
| $params | array | Params array | |||
|
| $fields | array | Fields list | |||
|
| $sortings | array | Sortings list | |||
|
| $joins | array | Joins list | |||
|
| $conditions | array | Conditions list | |||
|
|
|
|
| |||
114 | vendor_plan_get_list_post |
|
|
| |||
| Process selected vendor plans data | $instance | object | Current model instance | |||
|
| $items | array | Items | |||
|
| $params | array | Params array | |||
|
|
|
|
| |||
115 | vendor_plan_before_save |
|
|
| |||
| Actions before saving plan data | $plan | object | Instance of VendorPlan | |||
|
| $result | bool | Can save flag | |||
|
|
|
|
| |||
116 | vendor_plan_after_save |
|
|
| |||
| Actions after saving plan data | $plan | object | Instance of VendorPlan | |||
|
|
|
|
| |||
117 | vendor_plan_before_delete |
|
|
| |||
| Actions before deleting plan | $plan | object | Instance of VendorPlan | |||
|
| $result | bool | Can delete flag | |||
|
|
|
|
| |||
118 | is_need_watermark_post |
|
|
| |||
|
| $object_type |
|
| |||
|
| $is_detailed |
|
| |||
|
| $company_id |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
119 | generate_hidpi_name |
|
|
| |||
|
| $relative_path |
|
| |||
|
| $hidpi_path |
|
| |||
|
|
|
|
| |||
120 | generate_absolute_hidpi_name |
|
|
| |||
|
| $relative_path |
|
| |||
|
| $hidpi_path |
|
| |||
|
|
|
|
| |||
121 | wishlist_get_count_post |
|
|
| |||
| Changes wishlist items count | $wishlist | array | wishlist data | |||
|
| $result | int | wishlist items count | |||
|
|
|
|
| |||
122 | pre_add_to_wishlist |
|
|
| |||
|
| $product_data |
|
| |||
|
| $wishlist |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
123 | delete_wishlist_product |
|
|
| |||
|
| $wishlist |
|
| |||
|
| $wishlist_id |
|
| |||
|
|
|
|
| |||
124 | get_feedback_data |
|
|
| |||
| Get feedback data | $fdata | array | Feedback data | |||
|
|
|
|
| |||
125 | dashboard_get_graphs_data |
|
|
| |||
|
| $time_from |
|
| |||
|
| $time_to |
|
| |||
|
| $graphs |
|
| |||
|
| $graph_tabs |
|
| |||
|
| $is_day |
|
| |||
|
|
|
|
| |||
126 | localization_objects |
|
|
| |||
|
| $_tables |
|
| |||
|
|
|
|
| |||
127 | get_feature_variants_list |
|
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $pattern |
|
| |||
|
| $start |
|
| |||
|
| $limit |
|
| |||
|
|
|
|
| |||
128 | update_static_data |
|
|
| |||
|
| $data |
|
| |||
|
| $param_id |
|
| |||
|
| $condition |
|
| |||
|
| $section |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
129 | get_status_params_definition |
|
|
| |||
|
| $status_params |
|
| |||
|
| $type |
|
| |||
|
|
|
|
| |||
130 | te_get_root |
|
|
| |||
|
| $type |
|
| |||
|
| $path |
|
| |||
|
|
|
|
| |||
131 | te_filter_path |
|
|
| |||
|
| $filter |
|
| |||
|
| $path |
|
| |||
|
| $fileext_filter |
|
| |||
|
|
|
|
| |||
132 | set_admin_notification |
|
|
| |||
|
| $user_data |
|
| |||
|
|
|
|
| |||
133 | get_companies_list |
|
|
| |||
|
| $condition |
|
| |||
|
| $pattern |
|
| |||
|
| $start |
|
| |||
|
| $limit |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
134 | checkout_select_default_payment_method |
|
|
| |||
|
| $cart |
|
| |||
|
| $payment_methods |
|
| |||
|
| $completed_steps |
|
| |||
|
|
|
|
| |||
135 | repay_order |
|
|
| |||
| Data change for a repayed order | $order_info | array | Order information | |||
|
| $update_order | array | New order data | |||
|
| $payment | array | Payment information | |||
|
| $payment_info | array | Payment information received from a user | |||
|
| $change_order_status | string | New order status | |||
|
|
|
|
| |||
136 | reorder |
|
|
| |||
|
| $order_info |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
137 | reorder_product |
|
|
| |||
| Executed for each product when an order is re-ordered. Allows you to modify the data of a product in the order. | $order_info | array | Order info from fn_get_order_info() | |||
|
| $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $product | array | Product data | |||
|
| $amount | int | Product quantity | |||
|
| $price | float | Product price | |||
|
| $zero_price_action | string | Flag, determines the action when the price of the product is 0 | |||
|
|
|
|
| |||
138 | prepare_repay_data |
|
|
| |||
|
| $payment_id |
|
| |||
|
| $order_info |
|
| |||
|
| $auth |
|
| |||
|
| $payment_methods |
|
| |||
|
|
|
|
| |||
139 | update_product_notifications_pre |
|
|
| |||
| Processes product subscription data | $data | array | Subscription notification data | |||
|
|
|
|
| |||
140 | update_product_notifications_before_delete |
|
|
| |||
| Processes product subscription data before deleting it from the database | $data | array | Subscription notification data | |||
|
| $where | array | Where clause data | |||
|
|
|
|
| |||
141 | update_product_notifications_post |
|
|
| |||
| Processes product subscription data after updating product notification | $data | array | Subscription notification data | |||
|
| $subscribed | mixed | Subscription result | |||
|
| $delete | mixed | Deletion result | |||
|
|
|
|
| |||
142 | sitemap_get_sections |
|
|
| |||
|
| $section_fields |
|
| |||
|
| $section_tables |
|
| |||
|
| $section_left_joins |
|
| |||
|
| $section_conditions |
|
| |||
|
| $section_orders |
|
| |||
|
|
|
|
| |||
143 | addon_snapshot |
|
|
| |||
|
| $addon |
|
| |||
|
| $status |
|
| |||
|
|
|
|
| |||
144 | update_addon_status_pre |
|
|
| |||
| Hook is executed before changing add-on status (i.e. before add-on enabling or disabling). |
|
|
| |||
|
| $addon | string | Add-on name | |||
|
| $status | string | New addon status - "A" for enabled, "D" for disabled | |||
|
| $show_notification | bool | Display notification if set to true | |||
|
| $on_install | bool | If status was changed right after install process | |||
|
| $allow_unmanaged | bool | Whether to allow change status for unmanaged addons in non-console environment | |||
|
| $old_status | string | Previous addon status - "A" for enabled, "D" for disabled | |||
|
| $scheme |
|
| |||
|
|
|
|
| |||
145 | update_addon_status_post |
|
|
| |||
| Hook is executed after changing add-on status (i.e. after add-on enabling or disabling). |
|
|
| |||
|
| $addon | string | Add-on name | |||
|
| $status | string | New addon status - "A" for enabled, "D" for disabled | |||
|
| $show_notification | bool | Display notification if set to true | |||
|
| $on_install | bool | If status was changed right after install process | |||
|
| $allow_unmanaged | bool | Whether to allow change status for unmanaged addons in non-console environment | |||
|
| $old_status | string | Previous addon status - "A" for enabled, "D" for disabled | |||
|
| $scheme |
|
| |||
|
|
|
|
| |||
146 | addon_permissions_text |
|
|
| |||
|
| $messages |
|
| |||
|
|
|
|
| |||
147 | get_cart_product_data_pre |
|
|
| |||
| Prepare params before getting product data from cart |
|
|
| |||
|
| $hash | string | Unique product HASH | |||
|
| $skip_promotion | bool | Skip promotion calculation | |||
|
| $promotion_amount | array | Amount of product in promotion (like Free products, etc) | |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $promotion_amount |
|
| |||
|
|
|
|
| |||
148 | pre_get_cart_product_data |
|
|
| |||
|
| $hash |
|
| |||
|
| $product |
|
| |||
|
| $skip_promotion |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $promotion_amount |
|
| |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
|
|
|
| |||
149 | get_cart_product_data |
|
|
| |||
|
| $product['product_id'] |
|
| |||
|
| $_pdata |
|
| |||
|
| $product |
|
| |||
|
| $auth |
|
| |||
|
| $cart |
|
| |||
|
| $hash |
|
| |||
|
|
|
|
| |||
150 | get_cart_product_data_post_options |
|
|
| |||
|
| $product['product_id'] |
|
| |||
|
| $_pdata |
|
| |||
|
| $product |
|
| |||
|
|
|
|
| |||
151 | get_cart_product_data_post |
|
|
| |||
| Prepare params before getting product data from cart | $hash | string | Unique product HASH | |||
|
| $skip_promotion | bool | Skip promotion calculation | |||
|
| $promotion_amount | array | Amount of product in promotion (like Free products, etc) | |||
|
| $promotion_amount | array | Product data | |||
|
| $auth |
|
| |||
|
| $promotion_amount |
|
| |||
|
| $_pdata |
|
| |||
|
|
|
|
| |||
152 | summary_get_payment_method_data |
|
|
| |||
| Change select condition (fields, joins) before selecting payment method data | $payment_id | int | payment ID | |||
|
| $lang_code | string | 2-letter language code | |||
|
| $fields | array | List of fields in SELECT query | |||
|
| $join | array | List of JOINed tables | |||
|
|
|
|
| |||
153 | summary_get_payment_method |
|
|
| |||
|
| $payment_id |
|
| |||
|
| $payment |
|
| |||
|
|
|
|
| |||
154 | get_payments |
|
|
| |||
|
| $params |
|
| |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $order |
|
| |||
|
| $condition |
|
| |||
|
| $having |
|
| |||
|
|
|
|
| |||
155 | get_payments_post |
|
|
| |||
|
| $params |
|
| |||
|
| $payments |
|
| |||
|
|
|
|
| |||
156 | update_payment_pre |
|
|
| |||
|
| $payment_data |
|
| |||
|
| $payment_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $certificate_file |
|
| |||
|
| $certificates_dir |
|
| |||
|
|
|
|
| |||
157 | update_payment_post |
|
|
| |||
|
| $payment_data |
|
| |||
|
| $payment_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $certificate_file |
|
| |||
|
| $certificates_dir |
|
| |||
|
| $processor_params |
|
| |||
|
|
|
|
| |||
158 | update_currency_pre |
|
|
| |||
| Updates currency data before updating | $currency_data | array | Currency information | |||
|
| $currency_id | int | Currency id | |||
|
| $lang_code | string | 2-letter language code | |||
|
|
|
|
| |||
159 | update_currency_post |
|
|
| |||
| Changes result of currency saving | $currency_data | array | Currency information | |||
|
| $currency_id | int | Currency id | |||
|
| $lang_code | string | 2-letter language code | |||
|
| Currency | int | id | |||
|
|
|
|
| |||
160 | update_product_amount_pre |
|
|
| |||
|
| $product_id |
|
| |||
|
| $amount |
|
| |||
|
| $product_options |
|
| |||
|
| $sign |
|
| |||
|
| $tracking |
|
| |||
|
| $current_amount |
|
| |||
|
| $product_code |
|
| |||
|
| $notify |
|
| |||
|
|
|
|
| |||
161 | update_product_amount |
|
|
| |||
| Executes when updating product quantity before setting new amount in the database, allows to modify data passed to the SQL query. |
|
|
| |||
|
| $new_amount | int | New product quantity | |||
|
| $product_id | int | Product ID | |||
|
| $cart_id | int | Product cart ID | |||
|
| $notify | bool | Whether to send product stock notifications | |||
|
| $notify |
|
| |||
|
|
|
|
| |||
162 | pre_update_order |
|
|
| |||
|
| $cart |
|
| |||
|
| $order_id |
|
| |||
|
|
|
|
| |||
163 | create_order |
|
|
| |||
|
| $order |
|
| |||
|
|
|
|
| |||
164 | edit_place_order |
|
|
| |||
|
| $order_id |
|
| |||
|
|
|
|
| |||
165 | update_order |
|
|
| |||
|
| $order |
|
| |||
|
| $order_id |
|
| |||
|
|
|
|
| |||
166 | create_order_details |
|
|
| |||
| Modifies product order details | $order_id | int | Order identifier to create details for | |||
|
| $cart | array | Cart contents | |||
|
| $order_details | array | Ordered product details | |||
|
| $extra | array | Product extra parameters | |||
|
|
|
|
| |||
167 | create_order_details_post |
|
|
| |||
| Modifies product popularity | $order_id | int | Order identifier to create details for | |||
|
| $cart | array | Cart contents | |||
|
| $order_details | array | Ordered product details | |||
|
| $extra | array | Product extra parameters | |||
|
| $popularity | array | Product popularity | |||
|
|
|
|
| |||
168 | pre_place_order |
|
|
| |||
|
| $cart |
|
| |||
|
| $allow |
|
| |||
|
| $cart['product_groups'] |
|
| |||
|
|
|
|
| |||
169 | place_order |
|
|
| |||
|
| $order_id |
|
| |||
|
| $action |
|
| |||
|
| $order_status |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
170 | place_suborders |
|
|
| |||
|
| $cart |
|
| |||
|
| $suborder_cart |
|
| |||
|
|
|
|
| |||
171 | finish_payment |
|
|
| |||
|
| $order_id |
|
| |||
|
| $pp_response |
|
| |||
|
| $force_notification |
|
| |||
|
|
|
|
| |||
172 | save_cart_content_pre |
|
|
| |||
| Actions before storing cart content in the customer's profile | $cart | array | Cart contents | |||
|
| $user_id | int | User identifier | |||
|
| $type | string | Cart type | |||
|
| $user_type | string | User type | |||
|
|
|
|
| |||
173 | save_cart |
|
|
| |||
| Deprecated: This hook will be removed in version 5.x.x.. Use save_cart_content_post instead. | $cart |
|
| |||
|
| $user_id |
|
| |||
|
| $type |
|
| |||
|
|
|
|
| |||
174 | save_cart_content_post |
|
|
| |||
| Actions after storing cart content in the customer's profile | $cart | array | Cart contents | |||
|
| $user_id | int | User identifier | |||
|
| $type | string | Cart type | |||
|
| $user_type | string | User type | |||
|
|
|
|
| |||
175 | pre_extract_cart |
|
|
| |||
|
| $cart |
|
| |||
|
| $condition |
|
| |||
|
| $item_types |
|
| |||
|
|
|
|
| |||
176 | extract_cart |
|
|
| |||
|
| $cart |
|
| |||
|
| $user_id |
|
| |||
|
| $type |
|
| |||
|
| $user_type |
|
| |||
|
|
|
|
| |||
177 | get_cart_item_types |
|
|
| |||
|
| $item_types |
|
| |||
|
| $action |
|
| |||
|
|
|
|
| |||
178 | get_order_paid_statuses_post |
|
|
| |||
| Get order paid statuses (at the end of fn_get_order_paid_statuses()) | $paid_statuses | array | List of order paid statuses | |||
|
|
|
|
| |||
179 | format_price_by_currency_post |
|
|
| |||
| Update converted value | $price | float | value to be converted | |||
|
| $currency_from | string | in what currency did we get the value | |||
|
| $currency_to | string | in what currency should we send the result | |||
|
| $result | float | converted value | |||
|
|
|
|
| |||
180 | get_order_items_info_post |
|
|
| |||
|
| $order |
|
| |||
|
| $v |
|
| |||
|
| $k |
|
| |||
|
|
|
|
| |||
181 | get_order_info |
|
|
| |||
|
| $order |
|
| |||
|
| $additional_data |
|
| |||
|
|
|
|
| |||
182 | is_accessible_product_post |
|
|
| |||
| Changes result of product accessability checking | $product | array | Product data | |||
|
| $result | boolean | Flag that defines if product is accessible | |||
|
|
|
|
| |||
183 | change_order_status_child_order |
|
|
| |||
| Executes before changing the order's child order status, allowing to modify the child order status or prevent the status from being changed. | $order_id | int | Parent order identifier | |||
|
| $status_to | string | New parent order status (one char) | |||
|
| $status_from | string | Old parent order status (one char) | |||
|
| $force_notification | array | Array with notification rules | |||
|
| $place_order | boolean | True, if this function have been called inside of fn_place_order function. | |||
|
| $child_order_id | int | Child order identifier | |||
|
| $child_status_to | string | New child order status (one char) | |||
|
| $change_child_status | boolean | If true, the child order status will be changed | |||
|
|
|
|
| |||
184 | change_order_status_before_update_product_amount |
|
|
| |||
| Executes when changing order status before changing a product stock balance in the database. | $order_id | int | Parent order identifier | |||
|
| $status_to | string | New parent order status (one char) | |||
|
| $status_from | string | Old parent order status (one char) | |||
|
| $force_notification | array | Array with notification rules | |||
|
| $place_order | boolean | True, if this function have been called inside of fn_place_order function. | |||
|
| $child_order_id | int | Child order identifier | |||
|
| $child_status_to | string | New child order status (one char) | |||
|
| $change_child_status | boolean | If true, the child order status will be changed | |||
|
|
|
|
| |||
185 | change_order_status |
|
|
| |||
|
| $status_to |
|
| |||
|
| $status_from |
|
| |||
|
| $order_info |
|
| |||
|
| $force_notification |
|
| |||
|
| $order_statuses |
|
| |||
|
| $place_order |
|
| |||
|
|
|
|
| |||
186 | delete_order |
|
|
| |||
|
| $order_id |
|
| |||
|
|
|
|
| |||
187 | generate_ekeys_for_edp_pre |
|
|
| |||
| Actions before generating ekeys for downloadable products (EDP) | $statuses | array | Order statuses | |||
|
| $order_info | array | Order information | |||
|
| $active_files | array | Array with file download statuses | |||
|
|
|
|
| |||
188 | generate_ekeys_for_edp_post |
|
|
| |||
| Actions after generating ekeys for downloadable products (EDP) | $statuses | array | Order statuses | |||
|
| $order_info | array | Order information | |||
|
| $active_files | array | Array with file download statuses | |||
|
| $edp_data | array | EDP ekeys for email notification | |||
|
|
|
|
| |||
189 | update_order_payment_info_before_processing_response |
|
|
| |||
| Executes before merging payment processor response with the stored order's payment info, allowing to modify processor response | $order_id | int | Order identifier | |||
|
| $pp_response | array | Response from payment processor | |||
|
| $payment_info | array | Stored order's payment info | |||
|
|
|
|
| |||
190 | update_order_payment_info |
|
|
| |||
| Executes right before putting the order payment info in the database, allowing you to modify the SQL query. | $order_id | int | Order identifier | |||
|
| $pp_response | array | Response from payment processor | |||
|
| $payment_info | array | Payment processor response merged with the stored payment information | |||
|
| $data | array | Order data to be put in the database | |||
|
|
|
|
| |||
191 | get_shipping_info |
|
|
| |||
| Change SQL parameters for shipping info select | $shipping_id | int | Shipping ID | |||
|
| $fields | string | List of fields for retrieving | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $conditions | string | Condition for selecting product data | |||
|
| $lang_code | string | Lang code | |||
|
|
|
|
| |||
192 | get_shipping_info_post |
|
|
| |||
| Particularize shipping information | $shipping_id | int | Shipping ID | |||
|
| $lang_code | string | Lang code | |||
|
| $shipping | string | Shipping data | |||
|
|
|
|
| |||
193 | update_shipping |
|
|
| |||
|
| $shipping_data |
|
| |||
|
| $shipping_id |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
194 | update_shipping_post |
|
|
| |||
|
| $shipping_data |
|
| |||
|
| $shipping_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $action |
|
| |||
|
|
|
|
| |||
195 | update_tax_pre |
|
|
| |||
| Update tax data (running before fn_update_tax() function) | $tax_data | array | Tax data | |||
|
| $tax_id | int | Tax identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
196 | update_tax_post |
|
|
| |||
|
| $tax_data |
|
| |||
|
| $tax_id |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
197 | delete_tax_pre |
|
|
| |||
| Delete taxes (running before fn_delete_taxes() function) | $tax_ids | array | Taxes identifier | |||
|
|
|
|
| |||
198 | delete_taxes_pre |
|
|
| |||
| Delete taxes (running before fn_delete_taxes() function) | $tax_ids | array | Taxes identifier | |||
|
|
|
|
| |||
199 | exclude_products_from_calculation |
|
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $original_subtotal |
|
| |||
|
| $subtotal |
|
| |||
|
|
|
|
| |||
200 | calculate_cart_items |
|
|
| |||
| Executes when calculating cart content after products data is collected. Allows to modify cart content and affect further processes like promotions or shipping calculation. | $cart | array | Array of the cart contents and user information necessary for purchase | |||
|
| $cart_products | array | Array of products in cart | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $apply_cart_promotions | bool | Whether promotions have to be applied to cart content | |||
|
|
|
|
| |||
201 | calculate_cart_content_before_shipping_calculation |
|
|
| |||
| Executes when the cart content is calculated before the shipping rates are calculated, allows you to modify the cart state. A - calculate all available methods E - calculate selected methods only (from cart[shipping]) S - skip calculation F - full S - skip selection I - info | $cart | array | Cart data | |||
|
| $auth | array | Authentication data | |||
|
| $calculate_shipping | string | 1-letter flag indicating how to calculate the shipping cost (not used): | |||
|
| $calculate_taxes | bool | Whether taxes should be calculated | |||
|
| $options_style | string | 1-letter flag indicating how to obtain options information: | |||
|
| $apply_cart_promotions | bool | Whether promotions should be applied to the cart | |||
|
|
|
|
| |||
202 | calculate_cart_taxes_pre |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $product_groups |
|
| |||
|
| $calculate_taxes |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
203 | calculate_cart_taxes_post |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $shipping_rates |
|
| |||
|
| $calculate_taxes |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
204 | calculate_cart |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $auth |
|
| |||
|
| $calculate_shipping |
|
| |||
|
| $calculate_taxes |
|
| |||
|
| $apply_cart_promotions |
|
| |||
|
|
|
|
| |||
205 | calculate_cart_post |
|
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $calculate_shipping |
|
| |||
|
| $calculate_taxes |
|
| |||
|
| $options_style |
|
| |||
|
| $apply_cart_promotions |
|
| |||
|
| $cart_products |
|
| |||
|
| $product_groups |
|
| |||
|
|
|
|
| |||
206 | is_cart_empty |
|
|
| |||
| Change result of check cart is empty | $cart | array | Data of cart | |||
|
| $result | bool |
| |||
|
| $check_excluded | bool | If true then products will on checked extra fields 'exclude_from_calculate' and 'parent' | |||
|
|
|
|
| |||
207 | exclude_from_shipping_calculation |
|
|
| |||
|
| $product |
|
| |||
|
| $exclude |
|
| |||
|
|
|
|
| |||
208 | get_payment_processors |
|
|
| |||
| Changes params to get payment processors | $lang_code | string | 2-letter language code | |||
|
| $fields | array | List of fields for retrieving | |||
|
| $join | array | Array with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | array | Array containing SQL-query condition possibly prepended with a logical operator AND | |||
|
|
|
|
| |||
209 | get_payment_processors_post |
|
|
| |||
| Changes selected payment processors | $lang_code | string | Language code | |||
|
| $processors | array | Array of processors | |||
|
|
|
|
| |||
210 | get_processor_data_by_name |
|
|
| |||
| Change processor data | $processor_script | string | Processor script name | |||
|
| $processor_data | array | Processor data | |||
|
|
|
|
| |||
211 | calculate_taxes_pre |
|
|
| |||
| Prepare params before applying products and shipping taxes to cart | $cart | array | Cart data | |||
|
| $group_products | array | Products data | |||
|
| $shipping_rates | array |
| |||
|
| $auth | array | Auth data | |||
|
|
|
|
| |||
212 | calculate_taxes_post |
|
|
| |||
| Processes products data after applying products and shipping taxes to cart) | $cart | array | Cart data | |||
|
| $group_products | array | Products data | |||
|
| $shipping_rates | array | Shipping rates data | |||
|
| $auth | array | Auth data | |||
|
| $calculated_data | array | Payment taxes data | |||
|
|
|
|
| |||
213 | calculate_payment_taxes_pre |
|
|
| |||
| Prepare params before applying payment taxes to cart | $cart | array | Cart data | |||
|
| $auth | array | Auth data | |||
|
|
|
|
| |||
214 | calculate_payment_taxes_post |
|
|
| |||
| Processes payment data taxes after applying payment taxes to cart | $cart | array | Cart data | |||
|
| $auth | array | Auth data | |||
|
| $calculated_data | array | Payment data taxes | |||
|
|
|
|
| |||
215 | apply_payment_taxes_post |
|
|
| |||
| Apply payment taxes (running after fn_apply_payment_taxes function) | $calculated_data | array | payment data taxes | |||
|
| $cart | array | cart data | |||
|
|
|
|
| |||
216 | init_tax_subtotals_post |
|
|
| |||
| Init tax subtotals (running after fn_init_tax_subtotals function) | $tax | array | tax array | |||
|
|
|
|
| |||
217 | get_payment_taxes_post |
|
|
| |||
| Init payment taxes (running after fn_get_payment_taxes function) | $payment_id | integer | payment method id | |||
|
| $cart | array | cart data | |||
|
| $taxes | array | array with taxes | |||
|
|
|
|
| |||
218 | apply_calculated_taxes_post |
|
|
| |||
| Apply products and shipping taxes (running after fn_apply_calculated_taxes function) | $calculated_data | array | payment data taxes | |||
|
| $cart | array | cart data | |||
|
|
|
|
| |||
219 | format_rate_value |
|
|
| |||
|
| $rate_value |
|
| |||
|
| $rate_type |
|
| |||
|
| $decimals |
|
| |||
|
| $dec_point |
|
| |||
|
| $thousands_sep |
|
| |||
|
| $coefficient |
|
| |||
|
|
|
|
| |||
220 | check_amount_in_stock |
|
|
| |||
|
| $product_id |
|
| |||
|
| $amount |
|
| |||
|
| $product_options |
|
| |||
|
| $cart_id |
|
| |||
|
| $is_edp |
|
| |||
|
| $original_amount |
|
| |||
|
| $cart |
|
| |||
|
|
|
|
| |||
221 | check_amount_in_stock_before_check |
|
|
| |||
| Executed before the checks for the remaining quantity of products. Allows you to change the inventory checking logic. | $product_id | int | Product identifier | |||
|
| $amount | int | Product quantity | |||
|
| $product_options | array | List of selected product options | |||
|
| $cart_id | int | Item cart identifier | |||
|
| $is_edp | string | Flag, is downloadable product (Y|N) | |||
|
| $original_amount | int | Original product quantity | |||
|
| $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $update_id | int | Updated item cart identifier | |||
|
| $product | array | Product data | |||
|
| $current_amount | int | Current product quantity in cart | |||
|
|
|
|
| |||
222 | post_check_amount_in_stock |
|
|
| |||
|
| $product_id |
|
| |||
|
| $amount |
|
| |||
|
| $product_options |
|
| |||
|
| $cart_id |
|
| |||
|
| $is_edp |
|
| |||
|
| $original_amount |
|
| |||
|
| $cart |
|
| |||
|
|
|
|
| |||
223 | generate_cart_id |
|
|
| |||
|
| $_cid |
|
| |||
|
| $extra |
|
| |||
|
| $only_selectable |
|
| |||
|
|
|
|
| |||
224 | placement_routines |
|
|
| |||
|
| $order_id |
|
| |||
|
| $order_info |
|
| |||
|
| $force_notification |
|
| |||
|
| $clear_cart |
|
| |||
|
| $action |
|
| |||
|
| $display_notification |
|
| |||
|
|
|
|
| |||
225 | order_placement_routines |
|
|
| |||
|
| $order_id |
|
| |||
|
| $force_notification |
|
| |||
|
| $order_info |
|
| |||
|
| $_error |
|
| |||
|
|
|
|
| |||
226 | check_add_to_cart_pre |
|
|
| |||
| Change parmetres of checking if product can be added to cart (run before fn_check_add_product_to_cart func) | $cart | array | Array of the cart contents and user information necessary for purchase | |||
|
| $product | array | Params with that product is adding to cart | |||
|
| $product_id | int | Identifier of adding product | |||
|
| $result | boolean | Flag determines if product can be added to cart | |||
|
|
|
|
| |||
227 | check_add_to_cart_post |
|
|
| |||
| Change parmetres of checking if product can be added to cart (run before fn_check_add_product_to_cart func) | $cart | array | Array of the cart contents and user information necessary for purchase | |||
|
| $product | array | Params with that product is adding to cart | |||
|
| $product_id | int | Identifier of adding product | |||
|
| $result | boolean | Flag determines if product can be added to cart | |||
|
|
|
|
| |||
228 | pre_add_to_cart |
|
|
| |||
|
| $product_data |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
| $update |
|
| |||
|
|
|
|
| |||
229 | add_product_to_cart_get_price |
|
|
| |||
| Executed when a product is added to cart, once the price of the product is determined. Allows to change the price of the product in the cart. | $product_data | array | List of products data | |||
|
| $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $update | bool | Flag, if true that is update mode. Usable for order management | |||
|
| $_id | int | Cart item identifier | |||
|
| $data | array | Current product data | |||
|
| $product_id | int | Product identifier | |||
|
| $amount | int | Product quantity | |||
|
| $price | float | Product price | |||
|
| $zero_price_action | string | Flag, determines the action when the price of the product is 0 | |||
|
| $allow_add | bool | Flag, determines if product can be added to cart | |||
|
|
|
|
| |||
230 | add_product_to_cart_check_price |
|
|
| |||
| Recalculates price and checks if product can be added with the current price | $data | array | Adding product data | |||
|
| $price | float | Calculated product price | |||
|
| $allow_add | boolean | Flag that determines if product can be added to cart | |||
|
|
|
|
| |||
231 | add_to_cart |
|
|
| |||
|
| $cart |
|
| |||
|
| $product_id |
|
| |||
|
| $_id |
|
| |||
|
|
|
|
| |||
232 | post_add_to_cart |
|
|
| |||
| Change product data after adding product to cart |
|
|
| |||
|
| $product_data | array | Product data | |||
|
| $cart | array | Cart data | |||
|
| $auth | array | Auth data | |||
|
| $update | bool | Flag the determains if cart data are updated | |||
|
| $ids |
|
| |||
|
|
|
|
| |||
233 | form_cart_pre_fill |
|
|
| |||
| Change cart data before forming cart. |
|
|
| |||
|
| $order_id | int | Order id | |||
|
| $cart | array | Cart data | |||
|
| $auth |
|
| |||
|
| $order_info |
|
| |||
|
|
|
|
| |||
234 | form_cart |
|
|
| |||
|
| $order_info |
|
| |||
|
| $cart |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
235 | get_payment_data |
|
|
| |||
|
| $data |
|
| |||
|
| $payment_id |
|
| |||
|
| $object_id |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
236 | delete_cart_product |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_id |
|
| |||
|
| $full_erase |
|
| |||
|
|
|
|
| |||
237 | clear_cart |
|
|
| |||
|
| $cart |
|
| |||
|
| $complete |
|
| |||
|
| $clear_all |
|
| |||
|
|
|
|
| |||
238 | get_external_discounts |
|
|
| |||
|
| $product |
|
| |||
|
| $discounts |
|
| |||
|
|
|
|
| |||
239 | allow_place_order |
|
|
| |||
|
|
|
|
| |||
|
| $total |
|
| |||
|
| $cart |
|
| |||
|
| $parent_order_id |
|
| |||
|
|
|
|
| |||
240 | pre_get_orders |
|
|
| |||
|
| $params |
|
| |||
|
| $fields |
|
| |||
|
| $sortings |
|
| |||
|
| $get_totals |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
241 | get_orders |
|
|
| |||
|
| $params |
|
| |||
|
| $fields |
|
| |||
|
| $sortings |
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $group |
|
| |||
|
|
|
|
| |||
242 | get_orders_post |
|
|
| |||
|
| $params |
|
| |||
|
| $orders |
|
| |||
|
|
|
|
| |||
243 | get_orders_totals |
|
|
| |||
|
| $paid_statuses |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $group |
|
| |||
|
|
|
|
| |||
244 | send_order_notification |
|
|
| |||
|
| $order_info |
|
| |||
|
| $edp_data |
|
| |||
|
| $force_notification |
|
| |||
|
| $notified |
|
| |||
|
| $send_order_notification |
|
| |||
|
|
|
|
| |||
245 | order_notification |
|
|
| |||
|
| $order_info |
|
| |||
|
| $order_statuses |
|
| |||
|
| $force_notification |
|
| |||
|
|
|
|
| |||
246 | get_shipments |
|
|
| |||
|
| $params |
|
| |||
|
| $fields_list |
|
| |||
|
| $joins |
|
| |||
|
| $condition |
|
| |||
|
| $group |
|
| |||
|
|
|
|
| |||
247 | get_shipments_info_post |
|
|
| |||
| Changes selected shipments | $shipments | array | Array of shipments | |||
|
| $params | array | Shipments search params | |||
|
|
|
|
| |||
248 | create_shipment |
|
|
| |||
|
| $shipment_data |
|
| |||
|
| $order_info |
|
| |||
|
| $group_key |
|
| |||
|
| $all_products |
|
| |||
|
|
|
|
| |||
249 | create_shipment_post |
|
|
| |||
| Called after new shipment creation. | $shipment_data | array | Array of shipment data. | |||
|
| $order_info | array | Shipment order info | |||
|
| $group_key | int | Group number | |||
|
| $all_products | bool |
| |||
|
| $shipment_id | int | Created shipment identifier | |||
|
|
|
|
| |||
250 | delete_shipments |
|
|
| |||
| Called after shipments deletion | $shipment_ids | array | Identifiers of deleted shipments | |||
|
| $result | int | Number of affected by deletion database rows | |||
|
|
|
|
| |||
251 | delete_shipping |
|
|
| |||
|
| $shipping_id |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
252 | get_cart_product_icon |
|
|
| |||
| Executed before gets product image pairs. Allows to substitute the detailed image. | $product_id | int | Product identifier | |||
|
| $product_data | array | Product data | |||
|
| $selected_options | array | List of selected product options | |||
|
| $image | null | Product image pairs (icon, detailed) | |||
|
|
|
|
| |||
253 | prepare_checkout_payment_methods |
|
|
| |||
| Allows to modify payment methods grouped by category used for the checkout page. | $cart | array | Array of the cart contents and user information necessary for purchase | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $payment_groups | array | List of payment methods grouped by category | |||
|
|
|
|
| |||
254 | get_available_shippings |
|
|
| |||
| Executes before obtaining the list of shipping methods in the administration panel. Allows to modify SQL query parameters. | $condition | string | SQL query condition string | |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
255 | payment_url |
|
|
| |||
|
| $method |
|
| |||
|
| $script |
|
| |||
|
| $url |
|
| |||
|
| $payment_dir |
|
| |||
|
|
|
|
| |||
256 | update_cart_products_pre |
|
|
| |||
| Actions before updating cart products | $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $product_data | array | Array of new products data | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
|
|
|
| |||
257 | update_cart_products_post |
|
|
| |||
| Additional cart products updates from passed params | $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $product_data | array | Array of new products data | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
|
|
|
| |||
258 | update_cart_by_data_post |
|
|
| |||
| Additional cart updates from passed params | $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $new_cart_data | array | Array of new data for products, totals, discounts and etc. update | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
|
|
|
| |||
259 | checkout_summary |
|
|
| |||
|
| $cart |
|
| |||
|
|
|
|
| |||
260 | cart_agreements |
|
|
| |||
| Executed after the license agreements of the files of downloadable products are retrieved. The hook allows to modify the list of license agreements. | $cart | array | Array of cart content and user information necessary for purchase | |||
|
| $agreements | array | License agreements list of the files of downloadable products | |||
|
|
|
|
| |||
261 | get_checkout_payment_buttons_pre |
|
|
| |||
|
|
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $auth |
|
| |||
|
| $checkout_buttons |
|
| |||
|
|
|
|
| |||
262 | get_checkout_payment_buttons |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $auth |
|
| |||
|
| $checkout_buttons |
|
| |||
|
| $checkout_payments |
|
| |||
|
| $_payment_id |
|
| |||
|
|
|
|
| |||
263 | get_checkout_payment_buttons_post |
|
|
| |||
|
| $cart |
|
| |||
|
| $cart_products |
|
| |||
|
| $auth |
|
| |||
|
| $checkout_buttons |
|
| |||
|
|
|
|
| |||
264 | checkout_place_order_delete_orders |
|
|
| |||
| Executes when placing an order on checkout after failed orders are deleted. | $cart | array | Cart data | |||
|
| $auth | array | Authentication data | |||
|
| $params | array | Request parameters | |||
|
| $order_id | int | Deleted order ID | |||
|
|
|
|
| |||
265 | checkout_place_order_before_check_amount_in_stock |
|
|
| |||
| Executes before checking a product stock balance when placing an order on checkout, allows to modify product data. | $cart | array | Cart contents | |||
|
| $auth | array | Authentication data | |||
|
| $params | array | Request parameters | |||
|
| $cart_id | string | Product cart ID | |||
|
| $product | string | Product data | |||
|
| $_is_edp | string | Whether product is downloadable | |||
|
|
|
|
| |||
266 | checkout_place_orders_pre_route |
|
|
| |||
| Perform actions before order placement redirect on checkout | $cart | array | Cart data | |||
|
| $auth | array | Authentication data | |||
|
| $params | array | Request parameters | |||
|
|
|
|
| |||
267 | user_session_products_condition |
|
|
| |||
| Process user session products condition | $params | array | Params | |||
|
| $conditions | array | SQL conditions to manipulate with ?:user_session_products table | |||
|
|
|
|
| |||
268 | delete_user_cart |
|
|
| |||
|
| $user_ids |
|
| |||
|
| $condition |
|
| |||
|
| $data |
|
| |||
|
|
|
|
| |||
269 | get_carts |
|
|
| |||
|
| $type_restrictions |
|
| |||
|
| $params |
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $fields |
|
| |||
|
| $group |
|
| |||
|
| $array_index_field |
|
| |||
|
|
|
|
| |||
270 | get_carts_before_select |
|
|
| |||
| Extra | $params |
|
| |||
|
| $items_per_page |
|
| |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $group |
|
| |||
|
| $sorting |
|
| |||
|
| $limit |
|
| |||
|
|
|
|
| |||
271 | get_carts_post |
|
|
| |||
|
| $carts_list |
|
| |||
|
| $params |
|
| |||
|
| $user_ids |
|
| |||
|
| $items_per_page |
|
| |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $group |
|
| |||
|
| $sorting |
|
| |||
|
| $limit |
|
| |||
|
|
|
|
| |||
272 | get_cart_products |
|
|
| |||
| Gets products in a particular abandoned or live cart | $user_id | int | User ID | |||
|
| $params | array | Params | |||
|
| $fields | array | SQL fields to be selected in an SQL-query | |||
|
| $conditions | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
|
|
|
| |||
273 | get_cart_products_post |
|
|
| |||
| Actions after getting products in a particular abandoned or live cart | $user_id | int | User ID | |||
|
| $params | array | Params | |||
|
| $cart_products | array | Products list in a abandoned or live cart | |||
|
| $fields | array | SQL fields to be selected in an SQL-query | |||
|
| $conditions | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
|
|
|
| |||
274 | store_shipping_rates_pre |
|
|
| |||
|
| $order_id |
|
| |||
|
| $cart |
|
| |||
|
| $customer_auth |
|
| |||
|
|
|
|
| |||
275 | store_shipping_rates_post |
|
|
| |||
|
| $order_id |
|
| |||
|
| $cart |
|
| |||
|
| $customer_auth |
|
| |||
|
|
|
|
| |||
276 | is_order_allowed |
|
|
| |||
| Deprecated @since 4.3.7 | $order_id |
|
| |||
|
| $allowed |
|
| |||
|
|
|
|
| |||
277 | is_order_allowed_post |
|
|
| |||
| Checks if an order is available for a customer | $order_id | int | Order ID | |||
|
| $auth | array | Auth array | |||
|
| $allowed | int | Allowed flag | |||
|
|
|
|
| |||
278 | checkout_step_needs_shipping_calculation_post |
|
|
| |||
| Executes after shipping cost recalculation necessity is determined, allows to modify result. | $cart | array | Cart content | |||
|
| $needs_calculation | bool | Check result | |||
|
| $needs_calculation |
|
| |||
|
|
|
|
| |||
279 | get_product_data_pre |
|
|
| |||
| Change parameters for getting product data | $product_id | int | Product ID | |||
|
| $auth | mixed | Array with authorization data | |||
|
| $lang_code | string | 2 letters language code | |||
|
| $field_list | string | List of fields for retrieving | |||
|
| $get_add_pairs | boolean | Get additional images | |||
|
| $get_main_pair | boolean | Get main images | |||
|
| $get_taxes | boolean | Get taxes | |||
|
| $get_qty_discounts | boolean | Get quantity discounts | |||
|
| $preview | boolean | Is product previewed by admin | |||
|
| $features | boolean | Get product features | |||
|
| $skip_company_condition | boolean | Skip company condition and retrieve product data for displaying on other store page. (Works only in ULT) | |||
|
|
|
|
| |||
280 | get_product_data |
|
|
| |||
| Change SQL parameters for product data select | $product_id | int | Product ID | |||
|
| $field_list | string | List of fields for retrieving | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $auth | mixed | Array with authorization data | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $condition | string | Condition for selecting product data | |||
|
|
|
|
| |||
281 | get_product_data_post |
|
|
| |||
| Particularize product data | $product_data | array | List with product fields | |||
|
| $auth | mixed | Array with authorization data | |||
|
| $preview | boolean | Is product previewed by admin | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
282 | get_feature_name_pre |
|
|
| |||
|
| $feature_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
|
|
|
| |||
283 | get_feature_name |
|
|
| |||
|
| $feature_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
| $field_list |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
284 | get_feature_name_post |
|
|
| |||
|
| $feature_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
285 | get_product_name_pre |
|
|
| |||
|
| $product_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
|
|
|
| |||
286 | get_product_name |
|
|
| |||
|
| $product_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
| $field_list |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
287 | get_product_name_post |
|
|
| |||
|
| $product_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
288 | get_product_price_pre |
|
|
| |||
| Change parameters for getting product price | $product_id | int | Product identifier | |||
|
| $amount | int | Amount of products, required to get wholesale price | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
|
|
|
| |||
289 | get_product_price_post |
|
|
| |||
| Change product price |
|
|
| |||
|
| $product_id | int | Product identifier | |||
|
| $amount | int | Amount of products, required to get wholesale price | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $price | float |
| |||
|
|
|
|
| |||
|
|
|
|
| |||
290 | translate_products_pre |
|
|
| |||
| Change parameters for translating product text data | $products | array | List of products | |||
|
| $fields | string | Fields of products that should be translated | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $translate_options | bool | Flag that defines whether we want to translate product options. Set it to "true" in case you want. | |||
|
|
|
|
| |||
291 | translate_products_post |
|
|
| |||
| Change translated products data | $products | array | List of products | |||
|
| $fields | string | Fields of products that should be translated | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $translate_options | bool | Flag that defines whether we want to translate product options. Set it to "true" in case you want. | |||
|
|
|
|
| |||
292 | gather_additional_products_data_pre |
|
|
| |||
| Change parameters for gathering additional products data | $products | array | List of products | |||
|
| $params | array | Parameters for gathering data | |||
|
|
|
|
| |||
293 | gather_additional_products_data_params |
|
|
| |||
| Changes before gathering additional products data | $product_ids | array | Array of product identifiers | |||
|
| $params | array | Parameteres for gathering data | |||
|
| $products | array | Array of products | |||
|
| $auth | mixed | Array of user authentication data | |||
|
| $products_images | array | Array with product main images | |||
|
| $additional_images | array | Array with product additional images | |||
|
| $product_options | array | Array with product options | |||
|
| $has_product_options | array | Array of flags determines if product has options | |||
|
| $has_product_options_links | array | Array of flags determines if product has option links | |||
|
|
|
|
| |||
294 | gather_additional_product_data_before_options |
|
|
| |||
| Changes before gathering product options | $product | array | Product data | |||
|
| $auth | mixed | Array of user authentication data | |||
|
| $params | array | Parameteres for gathering data | |||
|
|
|
|
| |||
295 | gather_additional_product_data_before_discounts |
|
|
| |||
| Changes before gathering product discounts | $product | array | Product data | |||
|
| $auth | mixed | Array of user authentication data | |||
|
| $params | array | Parameteres for gathering data | |||
|
|
|
|
| |||
296 | gather_additional_product_data_post |
|
|
| |||
| Add additional data to product | $product | array | Product data | |||
|
| $auth | mixed | Array of user authentication data | |||
|
| $params | array | Parameteres for gathering data | |||
|
|
|
|
| |||
297 | gather_additional_products_data_post |
|
|
| |||
| Add additional data to products after gathering additional products data | $product_ids | array | Array of product identifiers | |||
|
| $params | array | Parameteres for gathering data | |||
|
| $products | array | Array of products | |||
|
| $auth | mixed | Array of user authentication data | |||
|
|
|
|
| |||
298 | gather_additional_product_data_params |
|
|
| |||
| Change parameters for gathering additional data for a product | $product | array | Product data | |||
|
| $params | array | parameters for gathering data | |||
|
|
|
|
| |||
299 | get_product_files_pre |
|
|
| |||
| Change parameters for getting product files | $params | array |
| |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
300 | get_product_files_before_select |
|
|
| |||
| Change SQL parameters for product files selection | $params | array |
| |||
|
| $fields | array | List of fields for retrieving | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
|
|
|
| |||
301 | get_product_files_post |
|
|
| |||
| Change product files | $params | array |
| |||
|
| $files | array | Product files | |||
|
|
|
|
| |||
302 | get_product_edp_info_pre |
|
|
| |||
| Prepare params before getting EDP information | $product_id | int | Product identifier | |||
|
| $ekey | string | Download key | |||
|
|
|
|
| |||
303 | get_product_edp_info_post |
|
|
| |||
| Change product edp info | $edp_info | array | EDP information | |||
|
| $product_id | int | Product identifier | |||
|
| $ekey | string | Download key | |||
|
|
|
|
| |||
304 | get_edp_agreements_pre |
|
|
| |||
| Actions before getting edp agreements | $product_id | int | Product identifier | |||
|
| $file_name | bool | Get file name | |||
|
|
|
|
| |||
305 | get_edp_agreements_before_get_agriments |
|
|
| |||
| Prepare params before getting edp agreements | $product_id | int | Product identifier | |||
|
| $join | string | Query join; it is treated as a JOIN clause | |||
|
| $fields | array | Array of table column names to be returned | |||
|
|
|
|
| |||
306 | get_edp_agreements_post |
|
|
| |||
| Actions after getting edp agreements | $product_id | int | Product identifier | |||
|
| $file_name | bool | If true get file name in info, false otherwise | |||
|
| $edp_agreements | array | EDP agreements data | |||
|
|
|
|
| |||
307 | get_subcategories_params |
|
|
| |||
| Change params before subcategories select | $category_id | int | Category identifier | |||
|
| $params | int | Params of subcategories search | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
308 | get_subcategories_post |
|
|
| |||
| Change subcategories | $params | int | Params of subcategories search | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $categories | array | Subcategories | |||
|
|
|
|
| |||
309 | get_categories_tree_params |
|
|
| |||
| Change params before categories tree select | $category_id | int | Category identifier | |||
|
| $simple | boolean | Flag that defines if category names path and product count should not be gathered | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $params | int | Params of subcategories search | |||
|
|
|
|
| |||
310 | get_categories_tree_post |
|
|
| |||
| Change categories tree | $params | int | Params of subcategories search | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $categories | array | Categories tree | |||
|
|
|
|
| |||
311 | get_plain_categories_tree_params |
|
|
| |||
| Change params before plain categories tree select | $category_id | int | Category identifier | |||
|
| $simple | boolean | Flag that defines if category names path and product count should not be gathered | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $company_ids | array | Identifiers of companies for that categories should be gathered | |||
|
| $params | int | Params of subcategories search | |||
|
|
|
|
| |||
312 | get_plain_categories_tree_post |
|
|
| |||
| Change categories tree | $params | int | Params of subcategories search | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $categories | array | Categories tree | |||
|
|
|
|
| |||
313 | cat_sort_pre |
|
|
| |||
| Changes categories data before the comparison | $a | array | First category data | |||
|
| $b | array | Second category data | |||
|
|
|
|
| |||
314 | cat_sort_post |
|
|
| |||
| Changes the result of categories comparison | $a | array | First category data | |||
|
| $b | array | Second category data | |||
|
| $result | int | Result of comparison categories positions or categories names( if both categories positions are empty) | |||
|
|
|
|
| |||
315 | show_picker_pre |
|
|
| |||
| Changes params for the 'fn_show_picker' function | $table | string | Table name | |||
|
| $threshold | string | Value of the threshold after which the picker should be displayed | |||
|
|
|
|
| |||
316 | show_picker_post |
|
|
| |||
| Changes result of the 'fn_show_picker' function | $table | string | Table name | |||
|
| $threshold | string | Value of the threshold after which the picker should be displayed | |||
|
| $picker | boolean | Flag that defines if data should be displayed in picker | |||
|
|
|
|
| |||
317 | get_categories_pre |
|
|
| |||
| Changes params for the categories search | $params | array | Categories search params | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
318 | get_categories |
|
|
| |||
| Changes SQL params for the categories search | $params | array | Categories search params | |||
|
| $join | string | Join parametrs | |||
|
| $condition | string | Request condition | |||
|
| $fields | array | Selectable fields | |||
|
| $group_by | string | Group by parameters | |||
|
| $sortings | array | Sorting fields | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
319 | get_categories_after_sql |
|
|
| |||
| Process categories list after getting it | $categories | array | Categories list | |||
|
| $params | array | Categories search params | |||
|
| $join | string | Join parametrs | |||
|
| $condition | string | Request condition | |||
|
| $fields | array | Selectable fields | |||
|
| $group_by | string | Group by parameters | |||
|
| $sortings | array | Sorting fields | |||
|
| $sorting | string | Sorting parameters | |||
|
| $limit | string | Limit parameter | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
320 | get_categories_before_cut_levels |
|
|
| |||
| Process categories list before cutting second and fird levels | $categories_list | array | Categories list | |||
|
| $params | array | Categories search params | |||
|
|
|
|
| |||
321 | get_categories_post |
|
|
| |||
| Process final category list | $categories_list | array | Categories list | |||
|
| $params | array | Categories search params | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
322 | get_category_data_pre |
|
|
| |||
| Changes select category data conditions | $category_id | int | Category ID | |||
|
| $field_list | array | List of fields for retrieving | |||
|
| $get_main_pair | boolean | Get or not category image | |||
|
| $skip_company_condition | boolean | Select data for other stores categories. By default is false. This flag is used in ULT for displaying common categories in picker. | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
323 | get_category_data |
|
|
| |||
| Changes SQL parameters before select category data | $category_id | int | Category ID | |||
|
| $field_list | array | SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $conditions | string | Condition params | |||
|
|
|
|
| |||
324 | get_category_data_post |
|
|
| |||
| Changes category data | $category_id | int | Category ID | |||
|
| $field_list | array | List of fields for retrieving | |||
|
| $get_main_pair | boolean | Get or not category image | |||
|
| $skip_company_condition | boolean | Select data for other stores categories. By default is false. This flag is used in ULT for displaying common categories in picker. | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $category_data | array | Array with category fields | |||
|
|
|
|
| |||
325 | get_category_name_pre |
|
|
| |||
|
| $category_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
|
|
|
| |||
326 | get_category_name_post |
|
|
| |||
| Changes category names |
|
|
| |||
|
| $lang_code | string | 2-letters language code | |||
|
| $as_array | boolean | Flag if false one category name is returned as simple string, if true category names are always returned as array | |||
|
| $as_array |
|
| |||
|
| $name |
|
| |||
|
|
|
|
| |||
327 | fn_get_category_path_pre |
|
|
| |||
| Change parameters for getting category path | $category_id | int | Category identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $path_separator | string | String character(s) separating the catergories | |||
|
|
|
|
| |||
328 | fn_get_category_path_post |
|
|
| |||
| Change category path | $category_id | int | Category identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $path_separator | string | String character(s) separating the catergories | |||
|
| $category_path | string | Category path | |||
|
|
|
|
| |||
329 | delete_category_pre |
|
|
| |||
| Actions before category and its related data removal @return int|boolean Identifiers of deleted categories or false if categories were not found | $category_id | int | Category identifier to delete | |||
|
| $recurse | boolean | Flag that defines if category should be deleted recursively | |||
|
|
|
|
| |||
330 | delete_category_before |
|
|
| |||
| Process category delete (run before category is deleted) | $category_id | int | Category identifier | |||
|
|
|
|
| |||
331 | delete_category_after |
|
|
| |||
| Process category delete (run after category is deleted) | $category_id | int | Category identifier | |||
|
|
|
|
| |||
332 | delete_category_post |
|
|
| |||
| Actions after category and its related data removal | $category_id | int | Category identifier to delete | |||
|
| $recurse | boolean | Flag that defines if category should be deleted recursively | |||
|
| $category_ids | array | Category identifiers that were removed | |||
|
|
|
|
| |||
333 | delete_product_pre |
|
|
| |||
| Check product delete (run before product is deleted) | $product_id | int | Product identifier | |||
|
| $status | boolean | Flag determines if product can be deleted, if false product is not deleted | |||
|
|
|
|
| |||
334 | delete_product_post |
|
|
| |||
| Process product delete (run after product is deleted) | $product_id | int | Product identifier | |||
|
| $product_deleted | bool | True if product was deleted successfully, false otherwise | |||
|
|
|
|
| |||
335 | product_exists |
|
|
| |||
|
| $product_id |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
336 | global_update_products_pre |
|
|
| |||
| Global update products data (running before fn_global_update_products() function) | $update_data | array | List of updated fields and product_ids | |||
|
| $table | array | List of table names to be updated | |||
|
| $field | array | List of SQL field names to be updated | |||
|
| $value | array | List of new fields values | |||
|
| $type | array | List of field types absolute or persentage | |||
|
| $msg | string | Message containing the information about the changes made | |||
|
|
|
|
| |||
337 | global_update_products |
|
|
| |||
| Global update products data (running inside fn_global_update_products() function before fields update) | $table | array | List of table names to be updated | |||
|
| $field | array | List of SQL field names to be updated | |||
|
| $value | array | List of new fields values | |||
|
| $type | array | List of field types absolute or persentage | |||
|
| $msg | string | Message containing the information about the changes made | |||
|
| $update_data | array | List of updated fields and product_ids | |||
|
|
|
|
| |||
338 | global_update_products_post |
|
|
| |||
| Global update products data (running after fn_global_update_products() function) | $msg | string | Message containing the information about the changes made | |||
|
| $update_data | array | List of updated fields and product_ids | |||
|
|
|
|
| |||
339 | update_product_pre |
|
|
| |||
|
| $product_data |
|
| |||
|
| $product_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $can_update |
|
| |||
|
|
|
|
| |||
340 | update_product_post |
|
|
| |||
| Update product data (running after fn_update_product() function) | $product_data | array | Product data | |||
|
| $product_id | int | Product integer identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $create | boolean | Flag determines if product was created (true) or just updated (false). | |||
|
|
|
|
| |||
341 | update_product_features_value_pre |
|
|
| |||
| Executed before saving the values of the features of a product. It allows you to change the values of features before saving them. | $product_id | int | Product identifier | |||
|
| $product_features | array | List of feature values | |||
|
| $add_new_variant | array | List of new variants that will be added when the features of a product are saved | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $params | array | List of additional parameters | |||
|
| $category_ids | array | List of the category identifiers | |||
|
|
|
|
| |||
342 | update_product_count_pre |
|
|
| |||
| Update product count (running before update) | $category_ids | array | List of category ids for update | |||
|
|
|
|
| |||
343 | update_product_count_post |
|
|
| |||
| Update product count (running after update) | $category_ids | array | List of category ids for update | |||
|
|
|
|
| |||
344 | update_product_filter |
|
|
| |||
| Update product filter post hook | $filter_data | array |
| |||
|
| $filter_id | int |
| |||
|
| $lang_code | string |
| |||
|
|
|
|
| |||
345 | update_category_pre |
|
|
| |||
| Update category data (running before fn_update_category() function) | $category_data | array | Category data | |||
|
| $category_id | int | Category identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
346 | update_category_post |
|
|
| |||
| Update category data (running after fn_update_category() function) | $category_data | array | Category data | |||
|
| $category_id | int | Category identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
347 | update_category_parent_pre |
|
|
| |||
| Adds additional actions before category parent updating | $category_id | int | Category identifier | |||
|
| $new_parent_id | int | Identifier of new category parent | |||
|
|
|
|
| |||
348 | update_category_parent_post |
|
|
| |||
| Adds additional actions after category parent updating | $category_id | int | Category identifier | |||
|
| $new_parent_id | int | Identifier of new category parent | |||
|
|
|
|
| |||
349 | delete_product_option_pre |
|
|
| |||
| Adds additional actions before product option deleting | $option_id | int | Option identifier | |||
|
| $pid | int | Product identifier | |||
|
|
|
|
| |||
350 | delete_product_option_before_delete |
|
|
| |||
| Adds additional actions before executing delete queries | $option_id | int | Option identifier | |||
|
| $pid | int | Product identifier for linked option | |||
|
| $product_id | int | Product identifier for products own option | |||
|
| $product_link | array | Product ids for linked options | |||
|
| $can_continue | bool | Flag that allows to proceed deleting | |||
|
|
|
|
| |||
351 | delete_product_option_post |
|
|
| |||
| Adds additional actions after product option deleting removed (for not global options) | $option_id | int | Option identifier | |||
|
| $pid | int | Product identifier | |||
|
| $option_deleted | bool | True if option was successfully deleted, false otherwise | |||
|
| $product_id | int | Identifier of the product from which the option should be | |||
|
|
|
|
| |||
352 | delete_product_option_combinations |
|
|
| |||
| Adds additional actions before product option combinations deleting | $product_id | int | Product Id. | |||
|
|
|
|
| |||
353 | delete_product_option_variants_pre |
|
|
| |||
| Adds additional actions before product option variants deleting | $option_id | int | Option identifier: if given, all the option variants are deleted | |||
|
| $variant_ids | int | Variants identifiers: used if option_id is empty | |||
|
|
|
|
| |||
354 | delete_product_option_variants_post |
|
|
| |||
| Adds additional actions after product option variants deleting | $option_id | int | Option identifier: if given, all the option variants are deleted | |||
|
| $variant_ids | int | Variants identifiers: used if option_id is empty | |||
|
|
|
|
| |||
355 | get_product_options_pre |
|
|
| |||
| Get product options ( at the beggining of fn_get_product_options() ) | $product_ids | array | Product identifiers | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $only_selectable | bool | This flag forces to retreive the options with the certain types (default: select, radio or checkbox) | |||
|
| $inventory | bool | Get only options with the inventory tracking | |||
|
| $only_avail | bool | Get only available options | |||
|
| $selectable_option_types | array | Selectable option types | |||
|
| $skip_global | bool | Get only general options, not global options, applied as link | |||
|
|
|
|
| |||
356 | get_product_options |
|
|
| |||
| Changes request params before product options selecting | $fields | string | Fields to be selected | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $extra_variant_fields | string | Additional variant fields to be selected | |||
|
| $product_ids | array | Product identifiers | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
357 | get_product_options_get_variants |
|
|
| |||
| Changes request params before product option variants selecting | $v_fields | string | Fields to be selected | |||
|
| $v_condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $v_join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $v_sorting | string | String with the information for the "order by" statement | |||
|
| $option_ids | array | Options identifiers | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
358 | get_product_options_post |
|
|
| |||
| Get product options ( at the end of fn_get_product_options() ) | $product_ids | array | Product ids | |||
|
| $lang_code | string | Language code | |||
|
| $only_selectable | bool | This flag forces to retreive the options with the certain types (default: select, radio or checkbox) | |||
|
| $inventory | bool | Get only options with the inventory tracking | |||
|
| $only_avail | bool | Get only available options | |||
|
| $options | array | The resulting array of the retrieved options | |||
|
|
|
|
| |||
359 | get_product_global_options_pre |
|
|
| |||
| Changes params for getting product global options | $params | array | Array of search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
360 | get_product_global_options_before_select |
|
|
| |||
| Changes SQL params before select product global options | $params | array | Array of search params | |||
|
| $fields | array | Fields to be selected | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
|
|
|
| |||
361 | get_product_global_options_post |
|
|
| |||
| Changes product global options | $data | array | Product global options | |||
|
| $params | array | Array of search params | |||
|
|
|
|
| |||
362 | get_product_options_by_combination_pre |
|
|
| |||
| Changes product options (running before fn_get_product_options_by_combination function) | $combination | string | Options combination code | |||
|
| $options | array | Array for options decoded from combination | |||
|
|
|
|
| |||
363 | get_product_options_by_combination_post |
|
|
| |||
| Changes product options (running after fn_get_product_options_by_combination function) | $combination | string | Options combination code | |||
|
| $options | array | options decoded from combination | |||
|
|
|
|
| |||
364 | poptions_delete_product_pre |
|
|
| |||
| Adds additional actions before delete all product option | $product_id | int | Product identifier | |||
|
|
|
|
| |||
365 | poptions_delete_product_post |
|
|
| |||
| Adds additional actions after delete all product option | $product_id | int | Product identifier | |||
|
|
|
|
| |||
366 | get_selected_product_options_pre |
|
|
| |||
| Changes params for selecting product options with selected values | $product_id | int | Product identifier | |||
|
| $selected_options | array | Selected opotions values | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
367 | get_selected_product_options_before_select |
|
|
| |||
| Changes params before selecting product options | $fields | string | Fields to be selected | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $extra_variant_fields | string | Additional variant fields to be selected | |||
|
|
|
|
| |||
368 | get_selected_product_options_post |
|
|
| |||
| Changes selected product options | $_opts | array | Selected product options | |||
|
| $product_id | int | Product identifier | |||
|
| $selected_options | array | Selected opotions values | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
369 | apply_option_modifiers_pre |
|
|
| |||
| Apply option modifiers (at the beginning of the fn_apply_options_modifiers()) | $selected_options | array | The list of selected option variants as option_id => variant_id | |||
|
| $base_value | mixed | Base value | |||
|
| $stored_options | array | The list of product options stored in the order. | |||
|
| $extra | array | Extra data | |||
|
| $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $type | string | Calculation type (price or weight) | |||
|
|
|
|
| |||
370 | apply_option_modifiers_post |
|
|
| |||
| Apply option modifiers (at the end of the fn_apply_options_modifiers()) | $selected_options | array | The list of selected option variants as option_id => variant_id | |||
|
| $base_value | mixed | Base value | |||
|
| $type | string | Calculation type (price or weight) | |||
|
| $stored_options | array | The list of product options stored in the order. | |||
|
| $orig_value | mixed | Original base value | |||
|
| $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $extra | array | Extra data | |||
|
|
|
|
| |||
371 | get_selected_product_options_info_pre |
|
|
| |||
| Get selected product options info (at the beginning of the fn_get_selected_product_options_info()) | $selected_options | array | Selected options | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
372 | get_selected_product_options_info_post |
|
|
| |||
| Get selected product options info (at the end of the fn_get_selected_product_options_info()) | $selected_options | array | Selected options | |||
|
| $lang_code | string | Language code | |||
|
| $result | array | List of the option info arrays | |||
|
|
|
|
| |||
373 | get_default_product_options_pre |
|
|
| |||
| Get default product options ( at the beginning of fn_get_default_product_options() ) | $product_id | integer | Product id | |||
|
| $get_all | bool | Whether to get all the default options or not | |||
|
| $product | array | Product data | |||
|
| $selectable_option_types | array | Selectable option types | |||
|
|
|
|
| |||
374 | get_default_product_options_post |
|
|
| |||
| Get default product options ( at the end of fn_get_default_product_options() ) | $product_id | integer | Product id | |||
|
| $get_all | bool | Whether to get all the default options or not | |||
|
| $product | array | Product data | |||
|
| $result | array | The resulting array | |||
|
|
|
|
| |||
375 | look_through_variants_pre |
|
|
| |||
| Changes params for getting product variants combinations | $product_id | int | Product identifier | |||
|
| $amount | int | Default combination amount | |||
|
| $options | array | Array of options identifiers | |||
|
| $variants | array | Array of option variants identifiers arrays in order corresponding to $options parameter | |||
|
|
|
|
| |||
376 | look_through_variants_update_combination |
|
|
| |||
| Changes data before update combination | $combination | array | Array of combination data | |||
|
| $data | array | Combination data to update | |||
|
| $product_id | int | Product identifier | |||
|
| $amount | int | Default combination amount | |||
|
| $options | array | Array of options identifiers | |||
|
| $variants | array | Array of option variants identifiers arrays in order corresponding to $options parameter | |||
|
|
|
|
| |||
377 | look_through_variants_post |
|
|
| |||
| Changes the product options combinations | $combination | array | Array of combinations | |||
|
| $product_id | int | Product identifier | |||
|
| $amount | int | Default combination amount | |||
|
| $options | array | Array of options identifiers | |||
|
| $variants | array | Array of option variants identifiers arrays in order corresponding to $options parameter | |||
|
|
|
|
| |||
378 | rebuild_product_options_inventory_pre |
|
|
| |||
| Changes parameters for rebuilding product options inventory | $product_id | int | Product identifier | |||
|
| $amount | int | Default combination amount | |||
|
|
|
|
| |||
379 | rebuild_product_options_inventory_post |
|
|
| |||
| Adds additional actions after rebuilding product options inventory | $product_id | int | Product identifier | |||
|
|
|
|
| |||
380 | get_product_features_pre |
|
|
| |||
| Changes params before getting products features | $params | array | Products features search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
381 | get_product_features |
|
|
| |||
| Change SQL parameters before product features selection |
|
| ||||
|
| $fields | array | List of fields for retrieving | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $params |
|
| |||
|
|
|
|
| |||
| get_product_features_post |
|
|
| |||
| Change products features data | $data | array | Products features data | |||
|
| $params | array | Products features search params | |||
|
| $has_ungroupped | boolean | Flag determines if there are features without group | |||
|
|
|
|
| |||
| get_product_feature_data_pre |
|
|
| |||
| Changes params before getting product feature data | $feature_id | int | Feature identifier | |||
|
| $get_variants | boolean | Flag determines if product variants should be fetched | |||
|
| $get_variant_images | boolean | Flag determines if variant images should be fetched | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
| get_product_feature_data_before_select |
|
|
| |||
| Change SQL parameters before fetching product feature data | $fields | array | Array SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $feature_id | int | Feature identifier | |||
|
| $get_variants | boolean | Flag determines if product variants should be fetched | |||
|
| $get_variant_images | boolean | Flag determines if variant images should be fetched | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
| get_product_feature_data_post |
|
|
| |||
| Change product feature data | $feature_data | array | Product feature data | |||
|
|
|
|
| |||
| get_product_features_list_pre |
|
|
| |||
|
| $product |
|
| |||
|
| $display_on |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
| get_product_features_list_before_select |
|
|
| |||
| Change SQL parameters before fetching product feature data |
|
| ||||
|
| $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $product | array | Array with product data | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
| get_product_features_list_post |
|
|
| |||
|
| $features_list |
|
| |||
|
| $product |
|
| |||
|
| $display_on |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
| get_avail_product_features_pre |
|
|
| |||
| Changes parameters for getting available product features | $lang_code | string | 2-letters language code | |||
|
| $simple | boolean | Flag determines if only feature names(true) or all properties(false) should be selected | |||
|
| $get_hidden | boolean | Flag determines if all feature fields should be selected | |||
|
|
|
|
| |||
390 | get_avail_product_features_before_select |
|
|
| |||
| Change SQL parameters before fetching available product features | $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $simple | boolean | Flag determines if only feature names(true) or all properties(false) should be selected | |||
|
| $get_hidden | boolean | Flag determines if all feature fields should be selected | |||
|
|
|
|
| |||
391 | get_avail_product_features_post |
|
|
| |||
| Changes available product features data | $result | array | Product features | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $simple | boolean | Flag determines if only feature names(true) or all properties(false) should be selected | |||
|
| $get_hidden | boolean | Flag determines if all feature fields should be selected | |||
|
|
|
|
| |||
392 | get_product_feature_variants_pre |
|
|
| |||
| Changes parameters for getting product feature variants | $params | array | array with search parameters | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
393 | get_product_feature_variants |
|
|
| |||
| Changes SQL parameters for getting product feature variants | $fields | array | List of fields for retrieving | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $sorting | string | String containing the SQL-query ORDER BY clause | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $limit | string | String containing the SQL-query LIMIT clause | |||
|
|
|
|
| |||
394 | get_product_feature_variants_post |
|
|
| |||
| Changes feature variants data | $vars | array | Product feature variants | |||
|
| $params | array | array with search params | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
395 | get_product_feature_variant_before_select |
|
|
| |||
| Changes SQL parameters before select product feature variant data | $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $variant_id | int | Variant identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
396 | get_product_feature_variant_post |
|
|
| |||
| Changes product feature variant data | $var | array | Variant data | |||
|
| $feature_id | int | Feature identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
397 | update_product_feature_pre |
|
|
| |||
| Changes before product feature updating | $feature_data | array | Feature data | |||
|
| $feature_id | int | Feature identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
398 | update_product_feature_post |
|
|
| |||
| Adds additional actions after product feature updating | $feature_data | array | Feature data | |||
|
| $feature_id | int | Feature identifier | |||
|
| $deleted_variants | array | Deleted product feature variants identifiers | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
399 | update_product_feature_variant_pre |
|
|
| |||
| Executes at the beginning of the function, allowing you to modify the arguments passed to the function. | $feature_id | int | Feature identifier | |||
|
| $feature_type | array | Feature type | |||
|
| $variant | array | Feature variant data | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
400 | update_product_feature_variant |
|
|
| |||
| Executes after identifier of the variant was checked. | $feature_id | int | Feature identifier | |||
|
| $feature_type | array | Feature type | |||
|
| $variant | array | Feature variant data | |||
|
| $lang_code | string | 2-letters language code | |||
|
| $variant_id | int | Variant identifier | |||
|
|
|
|
| |||
401 | update_product_feature_variant_post |
|
|
| |||
|
| $feature_id |
|
| |||
|
| $feature_type |
|
| |||
|
| $variant |
|
| |||
|
| $lang_code |
|
| |||
|
| $variant_id |
|
| |||
|
|
|
|
| |||
402 | add_feature_variant_pre |
|
|
| |||
| Changes variant data before adding | $feature_id | int | Feature identifier | |||
|
| $variant | array | Variant data | |||
|
|
|
|
| |||
403 | add_feature_variant_post |
|
|
| |||
| Adds additional actions before category parent updating | $feature_id | int | Feature identifier | |||
|
| $variant | array | Variant data | |||
|
|
|
|
| |||
404 | delete_feature_pre |
|
|
| |||
| Adds additional actions before product feature deleting | $feature_id | int | Feature identifier | |||
|
|
|
|
| |||
405 | delete_product_feature |
|
|
| |||
|
| $feature_id |
|
| |||
|
| $feature_type |
|
| |||
|
|
|
|
| |||
406 | delete_feature_post |
|
|
| |||
| Adds additional actions after product feature deleting | $feature_id | int | Deleted feature identifier | |||
|
| $variant_ids | array | Deleted feature variants | |||
|
|
|
|
| |||
407 | delete_product_feature_variants_post |
|
|
| |||
| Adds additional actions after product feature variants deleting | $feature_id | int | Deleted feature identifier | |||
|
| $variant_ids | array | Deleted feature variants | |||
|
|
|
|
| |||
408 | get_product_filters_pre |
|
|
| |||
| Changes product filters search params | $params | array | Products filter search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
409 | get_product_filters_before_select |
|
|
| |||
| Changes SQL parameters for product filters select | $fields | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $sorting | string | String containing the SQL-query ORDER BY clause | |||
|
| $limit | string | String containing the SQL-query LIMIT clause | |||
|
| $params | array | Products filter search params | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
410 | get_product_filters_post |
|
|
| |||
| Changes product filters data | $filters | array | Product filters | |||
|
| $params | array | Products filter search params | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
411 | delete_product_filter_pre |
|
|
| |||
| Adds additional actions before deleting product filter | $filter_id | int | Filter identifier | |||
|
|
|
|
| |||
412 | delete_product_filter_post |
|
|
| |||
| Adds additional actions after deleting product filter | $filter_id | int | Filter identifier | |||
|
|
|
|
| |||
413 | get_product_exceptions_pre |
|
|
| |||
| Changes params before getting product exceptions | $product_id | int | Product identifier | |||
|
| $short_list | boolean | Flag determines if exceptions list should be returned in short format | |||
|
|
|
|
| |||
414 | get_product_exceptions_post |
|
|
| |||
| Changes product exceptions data | $product_id | int | Product identifier | |||
|
| $exceptions | array | Exceptions data | |||
|
| $short_list | boolean | Flag determines if exceptions list should be returned in short format | |||
|
|
|
|
| |||
415 | update_exceptions_pre |
|
|
| |||
| Adds additional actions before product exceptions update |
|
| ||||
|
| $product_id | int | Product identifier | |||
|
| $exceptions | array |
| |||
|
|
|
|
| |||
416 | update_exceptions_post |
|
|
| |||
| Adds additional actions after product exceptions update | $product_id | int | Product identifier | |||
|
| $exceptions | array |
| |||
|
|
|
|
| |||
417 | get_product_exception_data_pre |
|
|
| |||
| Changes params before getting product exception data | $exception_id | int | Exception ID | |||
|
|
|
|
| |||
418 | get_product_exception_data_pre |
|
|
| |||
| Changes product exception data | $exception_id | int | Exception ID | |||
|
| $exception_data | array | Exception data | |||
|
|
|
|
| |||
419 | check_combination_pre |
|
|
| |||
| Changes params before checking combination | $combinations | array | Combinations data | |||
|
| $product_id | int | Product identifier | |||
|
|
|
|
| |||
420 | check_combination_post |
|
|
| |||
| Changes params after checking combination | $exception_id | boolean | Flag determines if combination exists | |||
|
| $combinations | array | Combinations data | |||
|
| $product_id | int | Product identifier | |||
|
|
|
|
| |||
421 | update_exceptions_pre |
|
|
| |||
| Adds additional actions before product exceptions update | $product_id | int | Product identifier | |||
|
| $exceptions | array |
| |||
|
|
|
|
| |||
422 | update_exceptions_post |
|
|
| |||
| Adds additional actions after product exceptions update |
|
|
| |||
|
| $product_id | int | Product identifier | |||
|
| $exceptions | array |
| |||
|
|
|
|
| |||
423 | update_exception_pre |
|
|
| |||
| Changes params before updating exception | $exception_data | array | Exception data | |||
|
| $exception_id | int | Exception ID | |||
|
|
|
|
| |||
424 | update_exception_post |
|
|
| |||
| Adds additional actions afrer updating exception | $exception_data | array | Exception data | |||
|
| $exception_id | int | Exception ID | |||
|
|
|
|
| |||
425 | clone_options_exceptions_pre |
|
|
| |||
| Adds additional actions before options exceptions clone | $exceptions | array | Exceptions array | |||
|
| $old_opt_id | int | Old option identifier | |||
|
| $old_var_id | int | Old variant identifier | |||
|
| $new_opt_id | int | New option identifier | |||
|
| $new_var_id | int | New variant identifier | |||
|
|
|
|
| |||
426 | clone_options_exceptions_post |
|
|
| |||
| Adds additional actions after options exceptions clone | $exceptions | array | Exceptions array | |||
|
| $old_opt_id | int | Old option identifier | |||
|
| $old_var_id | int | Old variant identifier | |||
|
| $new_opt_id | int | New option identifier | |||
|
| $new_var_id | int | New variant identifier | |||
|
|
|
|
| |||
427 | delete_exception_pre |
|
|
| |||
| Makes additional actions before deleting exception | $exception_id | int | Exception ID | |||
|
|
|
|
| |||
428 | clone_product_options_pre |
|
|
| |||
|
| $from_product_id |
|
| |||
|
| $to_product_id |
|
| |||
|
| $from_global_option_id |
|
| |||
|
|
|
|
| |||
429 | clone_product_option_post |
|
|
| |||
| Adds additional actions after cloning each product option |
|
| ||||
|
| $from_product_id | int | Identifier of product from that options are copied | |||
|
| $to_product_id | int | Identifier of product to that options are copied | |||
|
| $option_data | array | Product option data | |||
|
| $change_options | array | Links old options to the new ones via ids | |||
|
| $change_variants | array | Links old variants to the new ones via ids | |||
|
| $change_variants |
|
| |||
|
|
|
|
| |||
430 | clone_product_options_post |
|
|
| |||
|
| $from_product_id |
|
| |||
|
| $to_product_id |
|
| |||
|
| $from_global_option_id |
|
| |||
|
| $change_options |
|
| |||
|
| $change_variants |
|
| |||
|
|
|
|
| |||
431 | clone_options_inventory_pre |
|
|
| |||
| Adds additional actions before options inventory clone | $from_product_id | int | Identifier of product from that options are copied | |||
|
| $to_product_id | int | Identifier of product to that options are copied | |||
|
| $options | array | Array with options identifiers where old identifiers points to new identifier | |||
|
| $variants | array | Array with variant identifiers where old identifiers points to new identifier | |||
|
|
|
|
| |||
432 | clone_options_inventory_post |
|
|
| |||
| Adds additional actions after options inventory clone | $from_product_id | int | Identifier of product from that options are copied | |||
|
| $to_product_id | int | Identifier of product to that options are copied | |||
|
| $options | array | Array with options identifiers where old identifier points to new identifier | |||
|
| $variants | array | Array with variant identifiers where old identifier points to new identifier | |||
|
|
|
|
| |||
433 | generate_name_pre |
|
|
| |||
| Change parameters for generating file name | $str | string | Basic file name | |||
|
| $object_type | string | Object type | |||
|
| $object_id | int | Object identifier | |||
|
|
|
|
| |||
434 | generate_name_post |
|
|
| |||
| Change generated file name | $result | string | Generated file name | |||
|
| $str | string | Basic file name | |||
|
| $object_type | string | Object type | |||
|
| $object_id | int | Object identifier | |||
|
|
|
|
| |||
435 | get_options_combination_pre |
|
|
| |||
| Changes params for generating options combination | $product_options | array | Array with selected options values | |||
|
|
|
|
| |||
436 | get_options_combination_post |
|
|
| |||
| Changes options combination | $product_options | array | Array with selected options values | |||
|
| $combination | string | Generated combination | |||
|
|
|
|
| |||
437 | get_products_pre |
|
|
| |||
| Changes params for selecting products | $params | array | Product search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
438 | additional_fields_in_search |
|
|
| |||
| Executed for each part of a search query; it allows to modify the SQL conditions of the search. | $params | array | List of parameters passed to fn_get_products functions | |||
|
| $fields | array | List of fields for retrieving | |||
|
| $sortings | array | Sorting fields | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $sorting | string | String containing the SQL-query ORDER BY clause. This variable isn't used; it remains only for backward compatibility. | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field. This variable isn't used; it remains only for backward compatibility. | |||
|
| $tmp | string | String containing SQL-query search condition by piece | |||
|
| $piece | string | Part of the search query | |||
|
| $having | array | HAVING condition | |||
|
|
|
|
| |||
439 | get_products_before_select |
|
|
| |||
|
| $params |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $u_condition |
|
| |||
|
| $inventory_join_cond |
|
| |||
|
| $sortings |
|
| |||
|
| $total |
|
| |||
|
| $items_per_page |
|
| |||
|
| $lang_code |
|
| |||
|
| $having |
|
| |||
|
|
|
|
| |||
440 | get_products |
|
|
| |||
| Changes additional params for selecting products | $params | array | Product search params | |||
|
| $fields | array | List of fields for retrieving | |||
|
| $sortings | array | Sorting fields | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $sorting | string | String containing the SQL-query ORDER BY clause | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $having | array | HAVING condition | |||
|
|
|
|
| |||
441 | get_products_post |
|
|
| |||
| Changes selected products | $products | array | Array of products | |||
|
| $params | array | Product search params | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
442 | load_products_extra_data |
|
|
| |||
| Allows you to extend configuration of extra fields that should be lazily loaded for products. @see fn_load_extra_data_by_item_ids() | $extra_fields | array |
| |||
|
| $products | array | List of products | |||
|
| $product_ids | array | List of product identifiers | |||
|
| $params | array | Parameters passed to fn_get_products() | |||
|
| $lang_code | string | Language code passed to fn_get_products() | |||
|
|
|
|
| |||
443 | load_products_extra_data_post |
|
|
| |||
| Allows you lazily load extra data for products after they were fetched from DB or post-process lazy-loaded additional data related to products. | $products | array | List of products | |||
|
| $product_ids | array | List of product identifiers | |||
|
| $params | array | Parameters passed to fn_get_products() | |||
|
| $lang_code | string | Language code passed to fn_get_products() | |||
|
|
|
|
| |||
444 | update_product_option_pre |
|
|
| |||
| Changes parameters before update option data | $option_data | array | Option data | |||
|
| $option_id | int | Option identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
445 | update_product_option_post |
|
|
| |||
|
| $option_data |
|
| |||
|
| $option_id |
|
| |||
|
| $deleted_variants |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
446 | update_product_option_post |
|
|
| |||
|
| $option_data |
|
| |||
|
| $option_id |
|
| |||
|
| $deleted_variants |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
447 | convert_weight_pre |
|
|
| |||
| Change weight before converting | $weight | float | Weight for converting | |||
|
|
|
|
| |||
448 | convert_weight_post |
|
|
| |||
| Change the converted weight | $result | float | Converted weight | |||
|
| $weight | float | Weight for converting | |||
|
|
|
|
| |||
449 | convert_price_pre |
|
|
| |||
| Change price before converting | $price | float | Price for converting | |||
|
| $currency_code | string | Price currency code | |||
|
|
|
|
| |||
450 | convert_price_post |
|
|
| |||
| Change the converted price | $result | float | Converted price | |||
|
| $price | float | Price for converting | |||
|
| $currency_code | string | Price currency code | |||
|
|
|
|
| |||
451 | products_sorting |
|
|
| |||
| Change products sortings | $sorting | array | Sortings | |||
|
| $simple_mode | boolean | Flag that defines if products sortings should be returned as simple titles list | |||
|
|
|
|
| |||
452 | get_products_sorting_orders |
|
|
| |||
| Change products sorting orders | $result | array | Sorting orders | |||
|
|
|
|
| |||
453 | get_products_views_pre |
|
|
| |||
| Change params for getting product views | $simple_mode | boolean | Flag that defines is product views should be returned in simple mode | |||
|
| $active | boolean | Flag that defines if only active views should be returned | |||
|
|
|
|
| |||
454 | get_products_views_post |
|
|
| |||
| Change product views | $products_views | array | Array of products views | |||
|
| $simple_mode | boolean | Flag that defines is product views should be returned in simple mode | |||
|
| $active | boolean | Flag that defines if only active views should be returned | |||
|
|
|
|
| |||
455 | get_products_layout_pre |
|
|
| |||
| Change params for getting products layout | $params | array | Params for getting products layout | |||
|
|
|
|
| |||
456 | get_products_layout_post |
|
|
| |||
| Change selected layout | $selected_view | array | Selected layout | |||
|
| $params | array | Params for getting products layout | |||
|
|
|
|
| |||
457 | get_categories_list_pre |
|
|
| |||
| Change params for getting categories list | $category_ids | array | Category identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
458 | get_categories_list_post |
|
|
| |||
| Change categories list | $c_names | array | Categories names list | |||
|
| $category_ids | array | Category identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
459 | get_allowed_options_combination_pre |
|
|
| |||
| Changes parameters for getting allowed options combination | $options | array | Product options | |||
|
| $variants | array | Options variants | |||
|
| $string | array | Array of combinations values | |||
|
| $iteration | int | Iteration level | |||
|
| $exceptions | array | Options exceptions | |||
|
| $inventory_combinations | array | Inventory combinations | |||
|
|
|
|
| |||
460 | apply_options_rules_pre |
|
|
| |||
| Changes product data before applying product options rules | $product | array | Product data | |||
|
|
|
|
| |||
461 | apply_options_rules_post |
|
|
| |||
| Changes product data after applying product options rules | $product | array | Product data | |||
|
|
|
|
| |||
462 | apply_exceptions_rules_pre |
|
|
| |||
| Changes product data before applying options exceptions rules | $product | array | Product data | |||
|
|
|
|
| |||
463 | apply_exceptions_post |
|
|
| |||
| Changes product data after applying options exceptions rules | $product | array | Product data | |||
|
| $exceptions | array | Options exceptions | |||
|
|
|
|
| |||
464 | is_allowed_options_exceptions_pre |
|
|
| |||
| Changes parameters before checking allowed options exceptions | $exceptions | array | Options exceptions | |||
|
| $options | array | Product options | |||
|
| $o_type | string | Option type | |||
|
| $e_type | string | Exception type | |||
|
|
|
|
| |||
465 | is_allowed_options_exceptions_post |
|
|
| |||
| Changes result of checking allowed options exceptions | $result | boolean | Result of checking options exceptions | |||
|
| $exceptions | array | Options exceptions | |||
|
| $options | array | Product options | |||
|
| $o_type | string | Option type | |||
|
| $e_type | string | Exception type | |||
|
|
|
|
| |||
466 | get_product_details_views_pre |
|
|
| |||
| Changes params for getting product details views or adds additional views | $product_details_views | array | Array for product details views templates | |||
|
| $get_default | string | Type of default layout | |||
|
|
|
|
| |||
467 | get_product_details_views_post |
|
|
| |||
| Changes product details views | $product_details_views | array | Product details views | |||
|
| $get_default | string | Type of default layout | |||
|
|
|
|
| |||
468 | get_product_details_view_pre |
|
|
| |||
| Changes params for getting product details layout | $product_id | int | Product identifier | |||
|
|
|
|
| |||
469 | get_product_details_layout_pre |
|
|
| |||
|
| $product_id |
|
| |||
|
|
|
|
| |||
470 | get_product_details_view_post |
|
|
| |||
| Changes product details layout template | $result | string | Product layout template | |||
|
| $product_id | int | Product identifier | |||
|
|
|
|
| |||
471 | get_product_details_layout_post |
|
|
| |||
|
| $result |
|
| |||
|
| $product_id |
|
| |||
|
|
|
|
| |||
472 | clone_product_pre |
|
|
| |||
| Adds additional actions before product cloning | $product_id | int | Original product identifier | |||
|
|
|
|
| |||
473 | clone_product_data |
|
|
| |||
| Executed after the data of the cloned product is received. Allows to modify the data before cloning or to forbid cloning. | $product_id | int | Product identifier | |||
|
| $data | array | Product data | |||
|
| $is_cloning_allowed | bool | If 'false', the product can't be cloned | |||
|
|
|
|
| |||
474 | clone_product |
|
|
| |||
|
| $product_id |
|
| |||
|
| $pid |
|
| |||
|
|
|
|
| |||
475 | clone_product_post |
|
|
| |||
| Adds additional actions after product cloning | $product_id | int | Original product identifier | |||
|
| $pid | int | Cloned product identifier | |||
|
| $orig_name | string | Original product name | |||
|
| $new_name | string | Cloned product name | |||
|
|
|
|
| |||
476 | update_product_prices |
|
|
| |||
| Allows to influence the process of updating the prices of a product. | $product_id | int | Product identifier. | |||
|
| $_product_data | array | Array of product data. | |||
|
| $company_id | int | Company identifier. | |||
|
| $skip_price_delete | bool | Whether to delete the old prices of a product. | |||
|
| $table_name | bool | Database table name where the price data is stored. | |||
|
| $condition | string | SQL conditions for deleting the old prices of a product. | |||
|
|
|
|
| |||
477 | copy_product_files_pre |
|
|
| |||
| Changes params before copying product files | $file_id | int | File identifier | |||
|
| $file | array | File data | |||
|
| $product_id | int | Product identifier | |||
|
| $var_prefix | string | Prefix of file variables | |||
|
|
|
|
| |||
478 | copy_product_files_post |
|
|
| |||
| Adds additional actions after product files were copied | $file_id | int | File identifier | |||
|
| $file | array | File data | |||
|
| $product_id | int | Product identifier | |||
|
| $var_prefix | string | Prefix of file variables | |||
|
|
|
|
| |||
479 | get_product_subscribers_pre |
|
|
| |||
| Changes params for getting product subscribers | $params | array | Search subscribers params | |||
|
|
|
|
| |||
480 | get_product_subscribers_post |
|
|
| |||
| Changes product subscribers | $product_id | int | Product identifier | |||
|
| $params | array | Search subscribers params | |||
|
|
|
|
| |||
481 | get_comparison_products_post |
|
|
| |||
| Changes compared products | $compared_products | array | List of compared products | |||
|
|
|
|
| |||
482 | update_product_file_post |
|
|
| |||
| Executed after a file of a downloadable product is added or updated. The hook allows to perform additional actions. | $product_file | array | File data | |||
|
| $file_id | int | File identifier | |||
|
| $lang_code | string | Language code to update file description | |||
|
|
|
|
| |||
483 | prepare_product_quick_view |
|
|
| |||
| Additional actions for product quick view | $_REQUEST | array | Request parameters | |||
|
|
|
|
| |||
484 | get_product_option_data_pre |
|
|
| |||
| Changes params before option data selecting | $option_id | int | Option identifier | |||
|
| $product_id | int | Product identifier | |||
|
| $fields | string | Fields to be selected | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $extra_variant_fields | string | Additional variant fields to be selected | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
485 | get_product_option_data_post |
|
|
| |||
| Changes option data | $opt | array | Option data | |||
|
| $product_id | int | Product identifier | |||
|
| $lang_code | string | 2-letters language code | |||
|
|
|
|
| |||
486 | get_product_fields |
|
|
| |||
| Hook for change fields array | $fields | array | Product fields | |||
|
|
|
|
| |||
487 | get_product_code |
|
|
| |||
| Executed when a product code is requested by the product ID. Allows you to substitute the product code. | $product_id | int | Product identifier | |||
|
| $product_options | array | Selected options | |||
|
| $product_code |
|
| |||
|
|
|
|
| |||
488 | update_product_categories_pre |
|
|
| |||
| Change parameters before updating product categories then the changes will affect only those categories that belong to the specified company. | $product_id | int | Product ID | |||
|
| $product_data | array | Product data | |||
|
| $rebuild | bool | Determines whether or not the tree of categories must be rebuilt | |||
|
| $company_id | int | The identifier of the company. If an identifier is passed to the function, | |||
|
|
|
|
| |||
489 | get_filters_products_count_pre |
|
|
| |||
| Change parameters for getting product filters count | $params | array | Products filter search params | |||
|
|
|
|
| |||
490 | get_filters_products_count_before_select_filters |
|
|
| |||
| Change SQL parameters before select product filters | $sf_fields | array | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $sf_join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $sf_sorting | string | String containing the SQL-query ORDER BY clause | |||
|
| $params | array | Products filter search params | |||
|
|
|
|
| |||
491 | get_filters_products_count_post |
|
|
| |||
| Modifies filters | $params | array | Parameters of filters selection | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $filters | array | Filters array | |||
|
| $selected_filters | array | Selected filters array | |||
|
|
|
|
| |||
492 | generate_filter_field_params |
|
|
| |||
| This hook allows to extend products filtering params | $params | array | request params | |||
|
| $filters | array | filters list | |||
|
| $selected_filters | array | selected filter variants | |||
|
| $filter_fields | array | filter by product's field type of filter schema | |||
|
| $filter | array | current filter's data | |||
|
| $structure | array | current filter's schema | |||
|
|
|
|
| |||
493 | get_current_filters_post |
|
|
| |||
| Allows to change of $variant_values, $range_values, $field_variant_values, $field_range_values to extend standard filters functionality. | $params | array | request params | |||
|
| $filters | array | filters list | |||
|
| $selected_filters | array | selected filter variants | |||
|
| $area | string | current working area | |||
|
| $lang_code | string | language code | |||
|
| $variant_values | array | feature filters variants values | |||
|
| $range_values | array | feature filters range values | |||
|
| $field_variant_values | array | product field filters variants values | |||
|
| $field_range_values | array | product field filters range values | |||
|
|
|
|
| |||
494 | get_product_filter_fields |
|
|
| |||
| Changes product filter fields data | $filters | array | Product filter fields | |||
|
|
|
|
| |||
495 | get_product_options_inventory_pre |
|
|
| |||
| Changes params before selecting option combinations | $params | array | Combination search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
496 | get_product_options_inventory_post |
|
|
| |||
| Modifies option combinations | $params | array | Combination search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| List | array | of available option combinations | |||
|
|
|
|
| |||
497 | get_product_options_combination_data_post |
|
|
| |||
| Modifies selected combination data | $combination_hash | string | Combination unique hash | |||
|
| $combination_hash | array | Combination data | |||
|
|
|
|
| |||
498 | update_option_combination_pre |
|
|
| |||
| Change parameters for updating options combination | $combination_data | array | Combination data | |||
|
| $combination_hash | string | Combination hash | |||
|
|
|
|
| |||
499 | update_option_combination_post |
|
|
| |||
| Makes extra actions after updating options combination | $combination_data | array | Combination data | |||
|
| $combination_hash | string | Combination hash | |||
|
| $inventory_amount | int | Previous (before update) inventory amount of the combination | |||
|
|
|
|
| |||
500 | delete_option_combination_pre |
|
|
| |||
| Makes additional actions before deleting options combination | $combination_hash | string | Combination hash | |||
|
|
|
|
| |||
501 | filter_product_data |
|
|
| |||
| Filtering product data | $request | array | $_REQUEST | |||
|
| $product_data | array | $product_data | |||
|
|
|
|
| |||
502 | apply_option_modifiers_get_option_modifiers |
|
|
| |||
| Changes SQL-query params before option modifiers selecting | $type | string | Calculation type (price or weight) | |||
|
| $fields | string | Fields to be selected | |||
|
| $om_condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $om_join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $variant_ids | array | Variant identifiers | |||
|
| $selected_options | array | The list of selected option variants as option_id => variant_id | |||
|
|
|
|
| |||
503 | init_product_tabs_pre |
|
|
| |||
| Change product data before tabs initializing | $product | array | Product data | |||
|
|
|
|
| |||
504 | init_product_tabs_post |
|
|
| |||
| Change product tabs and data before passing tabs variable to view | $product | array | Product data | |||
|
| $tabs | array | Product tabs | |||
|
|
|
|
| |||
505 | get_pages_pre |
|
|
| |||
| Changes params for selecting pages | $params | array | Pages search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
|
|
|
| |||
506 | get_pages |
|
|
| |||
|
| $params |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $fields |
|
| |||
|
| $group_by |
|
| |||
|
| $sortings |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
507 | get_pages_after_sql |
|
|
| |||
| This hook allows you to modify the pages before they are included into the page_tree structure | $params | array | Page params | |||
|
| $items_per_page | int | Limit items per page | |||
|
| $lang_code | string | Language code | |||
|
| $pages | array | Selected pages | |||
|
|
|
|
| |||
508 | post_get_pages |
|
|
| |||
|
| $pages |
|
| |||
|
| $params |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
509 | update_page_pre |
|
|
| |||
| Actions before all checks and initializations | $page_data | array | Page data | |||
|
| $page_id | int | Page idetifier, if equals zero new page will be created | |||
|
| $lang_code | string | 2 letters language code | |||
|
|
|
|
| |||
510 | update_page_before |
|
|
| |||
| Actions after all checks and initializations and before update page | $page_data | array | Page data | |||
|
| $page_id | int | Page idetifier, if equals zero new page will be created | |||
|
| $lang_code | string | 2 letters language code | |||
|
|
|
|
| |||
511 | update_page_post |
|
|
| |||
| Actions after page update | $page_data | array | Page data | |||
|
| $page_id | int | Page idetifier, if equals zero new page will be created | |||
|
| $lang_code | string | 2 letters language code | |||
|
| $create | bool | True if page was created, falce otherwise | |||
|
| $old_page_data | array | Page data before update | |||
|
|
|
|
| |||
512 | update_page_parent_pre |
|
|
| |||
| Adds additional actions before page parent updating | $page_id | int | Page identifier | |||
|
| $new_parent_id | int | Identifier of new page parent | |||
|
|
|
|
| |||
513 | update_page_parent_post |
|
|
| |||
| Adds additional actions after page parent updating | $page_id | int | Page identifier | |||
|
| $new_parent_id | int | Identifier of new page parent | |||
|
|
|
|
| |||
514 | clone_page_pre |
|
|
| |||
|
| $page_id |
|
| |||
|
| $data |
|
| |||
|
|
|
|
| |||
515 | clone_page |
|
|
| |||
|
| $page_id |
|
| |||
|
| $new_page_id |
|
| |||
|
|
|
|
| |||
516 | page_object_by_type |
|
|
| |||
|
| $types |
|
| |||
|
|
|
|
| |||
517 | get_pages_plain_list |
|
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
518 | dropdown_object_link_pre |
|
|
| |||
| Actions before preparing the object links results | $object_data | array | Current element of block | |||
|
| $object_type | string | Type of object | |||
|
|
|
|
| |||
519 | dropdown_object_link_post |
|
|
| |||
| Actions after got link by object | $object_data |
|
| |||
|
| $object_type | array | Current element of block | |||
|
| $result | string | Type of object | |||
|
|
|
|
| |||
520 | get_page_data_pre |
|
|
| |||
|
| $page_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $preview |
|
| |||
|
| $area |
|
| |||
|
|
|
|
| |||
521 | pre_get_page_data |
|
|
| |||
|
| $field_list |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
522 | get_page_data |
|
|
| |||
|
| $page_data |
|
| |||
|
| $lang_code |
|
| |||
|
| $preview |
|
| |||
|
| $area |
|
| |||
|
|
|
|
| |||
523 | delete_page |
|
|
| |||
|
| $v |
|
| |||
|
|
|
|
| |||
524 | top_menu_form_pre |
|
|
| |||
| Modifies top menu forming parameters | $top_menu | array | Top menu data from the database | |||
|
| $level | int | Current menu level | |||
|
| $active | boolean | Menu item active flag | |||
|
|
|
|
| |||
525 | top_menu_form |
|
|
| |||
| Deprecated since 4.3.6, use top_menu_form_post instead | $v |
|
| |||
|
| $type |
|
| |||
|
| $id |
|
| |||
|
| $use_name |
|
| |||
|
|
|
|
| |||
526 | top_menu_form_post |
|
|
| |||
| Modifies top menu items | $top_menu | array | Top menu data from the database | |||
|
| $level | int | Current menu level | |||
|
| $active | boolean | Menu item active flag | |||
|
|
|
|
| |||
527 | sitemap_delete_links |
|
|
| |||
|
| $link_ids |
|
| |||
|
|
|
|
| |||
528 | sitemap_delete_sections |
|
|
| |||
|
| $section_ids |
|
| |||
|
|
|
|
| |||
529 | sitemap_get_sections |
|
|
| |||
|
| $section_fields |
|
| |||
|
| $section_tables |
|
| |||
|
| $section_left_join |
|
| |||
|
| $section_condition |
|
| |||
|
|
|
|
| |||
530 | sitemap_get_links |
|
|
| |||
|
| $links_fields |
|
| |||
|
| $links_tables |
|
| |||
|
| $links_left_join |
|
| |||
|
| $links_condition |
|
| |||
|
|
|
|
| |||
531 | sitemap_update_object |
|
|
| |||
|
| $link_data |
|
| |||
|
|
|
|
| |||
532 | allow_save_object_pre |
|
|
| |||
| Perform actions before object checking | $object_data | array | Object data | |||
|
| $object_type | string | Object name | |||
|
|
|
|
| |||
533 | allow_save_object_post |
|
|
| |||
| Perform actions after object checking | $object_data | array | Object data | |||
|
| $object_type | string | Object name | |||
|
| $allow | string | True if the object can be saved, otherwise False. | |||
|
|
|
|
| |||
534 | get_theme_path_pre |
|
|
| |||
|
| $path |
|
| |||
|
| $area |
|
| |||
|
| $company_id |
|
| |||
|
| $theme_names |
|
| |||
|
|
|
|
| |||
535 | get_theme_path |
|
|
| |||
|
| $path |
|
| |||
|
| $area |
|
| |||
|
| $dir_design |
|
| |||
|
| $company_id |
|
| |||
|
|
|
|
| |||
536 | get_cache_path |
|
|
| |||
|
| $path |
|
| |||
|
| $relative |
|
| |||
|
| $area |
|
| |||
|
| $company_id |
|
| |||
|
|
|
|
| |||
537 | redirect |
|
|
| |||
|
| $location |
|
| |||
|
|
|
|
| |||
538 | redirect_complete |
|
|
| |||
|
| $meta_redirect |
|
| |||
|
|
|
|
| |||
539 | set_notification_pre |
|
|
| |||
| Сhanges the parameters of the notification | $type | string | notification type (E - error, W - warning, N - notice, O - order error on checkout, I - information) | |||
|
| $title | string | notification title | |||
|
| $message | string | notification message | |||
|
| $message_state | string | (S - notification will be displayed unless it's closed, K - only once, I - will be closed by timer) | |||
|
| $extra | mixed | extra data to save with notification | |||
|
| $init_message | bool | $title and $message will be processed by __ function if true | |||
|
|
|
|
| |||
540 | generate_pagination_pre |
|
|
| |||
| This hook allows you to change the pagination data | $params | array | Pagination data | |||
|
| $area | string | One-letter area code | |||
|
| $deviation | int | Number of pages to display before and after selected page | |||
|
|
|
|
| |||
541 | format_price_pre |
|
|
| |||
| This hook allows you to change the format of the price; you can change the price and the number of digits after the decimal point, or convert the price to another currency. | $price | float | The current price. | |||
|
| $currency | string | The currency of the price. | |||
|
| $decimals | int | The number of digits after decimal point. | |||
|
| $return_as_float | boolean | If 'true', then a float result will be returned. | |||
|
|
|
|
| |||
542 | send_product_notifications_before_fetch_subscriptions |
|
|
| |||
| Processes product subscription data | $product_id | integer | Product id | |||
|
| $fields | array | SQL query fields list | |||
|
|
|
|
| |||
543 | add_breadcrumb |
|
|
| |||
|
| $lang_value |
|
| |||
|
| $link |
|
| |||
|
|
|
|
| |||
544 | delete_static_data_pre |
|
|
| |||
| This hook allows you to modify the input parameters of the function | $param_id | int |
| |||
|
|
|
|
| |||
545 | delete_static_data_post |
|
|
| |||
| This hook allows you to modify the parameters of the function after it has been executed. | $param_id | int |
| |||
|
| $delete_ids | array |
| |||
|
|
|
|
| |||
546 | get_static_data_pre |
|
|
| |||
| This hook allows you to modify the input parameters of the function |
|
| ||||
|
| $params | array |
| |||
|
| $lang_code | string |
| |||
|
|
|
|
| |||
547 | get_static_data |
|
|
| |||
| This hook allows you to modify the parameters by which the selection from the database will be performed | $params | array | Static data params | |||
|
| $fields | array | Selected fields | |||
|
| $condition | string | Condition for selecting | |||
|
| $sorting | string | Sorting condition | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
548 | get_static_data_post |
|
|
| |||
| This hook allows you to modify the parameters and the result of the function after it has been executed. | $params | array | Static data params | |||
|
| $lang_code | string | Language code | |||
|
| $s_data | array | Selected static data | |||
|
|
|
|
| |||
549 | after_set_progress |
|
|
| |||
|
| $prop |
|
| |||
|
| $value |
|
| |||
|
| $extra |
|
| |||
|
|
|
|
| |||
550 | compare_dispatch |
|
|
| |||
|
| $_url1 |
|
| |||
|
| $_url2 |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
551 | check_company_permissions |
|
|
| |||
|
| $permission |
|
| |||
|
| $controller |
|
| |||
|
| $mode |
|
| |||
|
| $request_method |
|
| |||
|
| $request_variables |
|
| |||
|
| $extra |
|
| |||
|
| $schema |
|
| |||
|
|
|
|
| |||
552 | get_notification_rules |
|
|
| |||
|
| $force_notification |
|
| |||
|
| $params |
|
| |||
|
| $disable_notification |
|
| |||
|
|
|
|
| |||
553 | url_pre |
|
|
| |||
|
| $url |
|
| |||
|
| $area |
|
| |||
|
| $protocol |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
554 | url_set_locations |
|
|
| |||
|
| $url |
|
| |||
|
| $area |
|
| |||
|
| $protocol |
|
| |||
|
| $lang_code |
|
| |||
|
| $locations |
|
| |||
|
|
|
|
| |||
555 | url_post |
|
|
| |||
|
| $_url |
|
| |||
|
| $area |
|
| |||
|
| $url |
|
| |||
|
| $protocol |
|
| |||
|
| $company_id_in_url |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
556 | check_user_type_access_rules_pre |
|
|
| |||
| Hook for changing incoming parameters and access rules. | $user_data |
|
| |||
|
| $account_type |
|
| |||
|
| $rules |
|
| |||
|
|
|
|
| |||
557 | check_user_type_access_rules_pre_post |
|
|
| |||
| Hook for changing the result of checking. | $user_data |
|
| |||
|
| $account_type |
|
| |||
|
| $rules |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
558 | update_status_pre |
|
|
| |||
| Performs additional actions before status description and data updated | $status | string | One-letter status code | |||
|
| $status_data | array | Status description and properties | |||
|
| $type | string | One-letter status type | |||
|
| $lang_code | string | Two-letter language code | |||
|
| $can_continue | bool | If true, status description and data will be updated | |||
|
|
|
|
| |||
559 | update_status_post |
|
|
| |||
|
| $status |
|
| |||
|
| $status_data |
|
| |||
|
| $type |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
560 | get_status_data_pre |
|
|
| |||
|
| $status |
|
| |||
|
| $type |
|
| |||
|
| $object_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $company_id |
|
| |||
|
|
|
|
| |||
561 | get_status_data_post |
|
|
| |||
|
| $status_data |
|
| |||
|
| $status |
|
| |||
|
| $type |
|
| |||
|
| $object_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $company_id |
|
| |||
|
|
|
|
| |||
562 | delete_status_pre |
|
|
| |||
| Modifies deleted status parameter |
|
|
| |||
|
| $status | string | One-letter status code | |||
|
| $type | string | One-letter status type | |||
|
| $can_delete | string | One-letter status code if status can be deleted | |||
|
| $is_default | mixed | True if status is default, false if status is not default, null otherwise | |||
|
| $status_id |
|
| |||
|
|
|
|
| |||
563 | delete_status_post |
|
|
| |||
| Performs additional actions after status removal |
|
|
| |||
|
| $status | string | One-letter status code | |||
|
| $type | string | One-letter status type | |||
|
| $can_delete | string | One-letter status code if status can be deleted | |||
|
| $is_default | mixed | True if status is default, false if status is not default, null otherwise | |||
|
| $status_id |
|
| |||
|
|
|
|
| |||
564 | clear_cache_post |
|
|
| |||
|
| $type |
|
| |||
|
| $extra |
|
| |||
|
|
|
|
| |||
565 | tools_change_status |
|
|
| |||
| This hook provides an access to the parameters that control the DB request for status change, and to the result of this request. | $params | array | Parameters that control status changes (table, id_name, id) | |||
|
| $result | array | The result of the DB request for status change | |||
|
|
|
|
| |||
566 | userdir_prefix |
|
|
| |||
|
| $prefix |
|
| |||
|
|
|
|
| |||
567 | description_tables_post |
|
|
| |||
| Process list of tables that has language depended data before return | $description_tables | array | Array of table names without prefix | |||
|
|
|
|
| |||
568 | delete_payment_pre |
|
|
| |||
|
| $payment_id |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
569 | delete_payment_post |
|
|
| |||
|
| $payment_id |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
570 | get_logos_pre |
|
|
| |||
| Changes params before selecting logo | $company_id | int | company ID | |||
|
| $layout_id | int | layout ID | |||
|
| $style_id | string | Style ID | |||
|
|
|
|
| |||
571 | get_logos |
|
|
| |||
| Changes conditions before selecting logo | $company_id | int | company ID | |||
|
| $layout_id | int | layout ID | |||
|
| $style_id | string | Style ID | |||
|
| $condition | array | Selecting conditions | |||
|
| $company_condition | string | Condition by companies | |||
|
|
|
|
| |||
572 | get_logos_post |
|
|
| |||
| Changes logos before returning | $company_id | int | company ID | |||
|
| $layout_id | int | layout ID | |||
|
| $style_id | string | Style ID | |||
|
| $logos | array | Selected logos | |||
|
|
|
|
| |||
573 | logo_types |
|
|
| |||
|
| $types |
|
| |||
|
| $for_company |
|
| |||
|
|
|
|
| |||
574 | get_customization_modes |
|
|
| |||
|
| $modes |
|
| |||
|
| $enabled_modes |
|
| |||
|
|
|
|
| |||
575 | update_customization_mode |
|
|
| |||
| Hook is executed before saving enabled customization modes to DB. | $modes | array | List of modes to be changed passed to function | |||
|
| $enabled_modes | array | Modes that will be enabled | |||
|
| $available_modes | array | All available modes | |||
|
|
|
|
| |||
576 | merge_styles_file_hash |
|
|
| |||
| Executes before obtaining merged styles file (or merging style files when the one is missing),allows to modify the name of the loaded styles file. | $files | array | Array with style files | |||
|
| $styles | string | Style code | |||
|
| $prepend_prefix | string | Prepend prefix | |||
|
| $params | array | Additional params | |||
|
| $area | string | Site's area ('A' for admin, 'C' for customer) | |||
|
| $css_dirs | array | Directories to load style files from | |||
|
| $hash | string | Hash part of the compiled styles file | |||
|
|
|
|
| |||
577 | get_currencies_list_pre |
|
|
| |||
|
| $params |
|
| |||
|
| $area |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
578 | get_currencies_list_before_select |
|
|
| |||
|
| $params |
|
| |||
|
| $area |
|
| |||
|
| $lang_code |
|
| |||
|
| $join |
|
| |||
|
| $order_by |
|
| |||
|
| $cond |
|
| |||
|
|
|
|
| |||
579 | get_currencies_list_post |
|
|
| |||
|
| $params |
|
| |||
|
| $area |
|
| |||
|
| $lang_code |
|
| |||
|
| $currencies |
|
| |||
|
|
|
|
| |||
580 | get_preview_url_post |
|
|
| |||
|
| $uri |
|
| |||
|
| $object_data |
|
| |||
|
| $user_id |
|
| |||
|
| $preview_url |
|
| |||
|
|
|
|
| |||
581 | get_predefined_statuses |
|
|
| |||
| Prepare statuses for particular object type | $type | string | Object type | |||
|
| $statuses | array | Array of statuses by type | |||
|
| $status | string | Current status | |||
|
|
|
|
| |||
582 | live_editor_update_object_pre |
|
|
| |||
| Performs actions before updating a live editor object | $params | array | Params to be updated; array with keys name, value, lang_code, and need_render | |||
|
| $updated | bool | The "already updated" flag | |||
|
|
|
|
| |||
583 | live_editor_update_object_table |
|
|
| |||
| Prepares data for the live editor object update request | $params | array | Params | |||
|
| $rule | array | Rule | |||
|
| $condition | array | Conditions | |||
|
| $table | str | Table name | |||
|
|
|
|
| |||
584 | live_editor_update_object_post |
|
|
| |||
| Performs actions after updating a live editor object | $params | array | Params | |||
|
| $updated | bool | The "already updated" flag | |||
|
|
|
|
| |||
585 | csrf_validate_request_pre |
|
|
| |||
| Allows to require CSRF validation in certain cases. server - $_SERVER array request - $_REQUEST array session - Tygh::$app['session'] array controller - curently running controller mode - currently running mode of controller action & dispatch_extra - additional dispatch parameters auth - Tygh::$app['session']['auth'] data area - 'A' or 'C' | $params | array | List of parameters: | |||
|
| $validation_required | bool | A flag indicating whether the CSRF validation is required, defaults to null (auto-detect) | |||
|
|
|
|
| |||
586 | get_theme_editor_tmp_css_path |
|
|
| |||
| Executes when determining the path where to store temporary style file for the Theme editor, allows to modiy path. | $css_filename | string | CSS filename | |||
|
| $cache_dir |
|
| |||
|
|
|
|
| |||
587 | fn_get_console_command |
|
|
| |||
| Allows change the console command. | $prefix | string | URL path to script | |||
|
| $script | string | Script name | |||
|
| $args | string | Arguments script | |||
|
| $cmd | string | Command | |||
|
|
|
|
| |||
588 | get_short_companies |
|
|
| |||
|
| $params |
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $limit |
|
| |||
|
|
|
|
| |||
589 | get_companies |
|
|
| |||
|
| $params |
|
| |||
|
| $fields |
|
| |||
|
| $sortings |
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $auth |
|
| |||
|
| $lang_code |
|
| |||
|
| $group |
|
| |||
|
|
|
|
| |||
590 | get_companies_post |
|
|
| |||
| This hook allows you to modify the selection parameters of companies and the resulting list of companies. | $params | array | Selection parameters | |||
|
| $auth | array | Array of user authentication data (e.g. uid, usergroup_ids, etc.) | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $companies | array | Information about the companies | |||
|
|
|
|
| |||
591 | company_products_check |
|
|
| |||
| |||||||
|
| $notify | bool | Whether notification must be shown on failed check | |||
|
| $company_condition | string | Products filtering condition | |||
|
| $company_condition |
|
| |||
|
|
|
|
| |||
592 | get_company_data_pre |
|
|
| |||
| Hook for changing incoming parameters | $company_id | int | Company ID | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $extra | array | Array with extra parameters | |||
|
|
|
|
| |||
593 | get_company_data |
|
|
| |||
| Hook for changing parameters before SQL query | $company_id | int | Company ID | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $extra | array | Array with extra parameters | |||
|
| $fields | array | Array with tables fields for SQL query | |||
|
| $join | string | String with SQL join statements | |||
|
| $condition | string | String with conditions for the WHERE SQL statement | |||
|
|
|
|
| |||
594 | get_company_data_post |
|
|
| |||
| Hook for changing result of function | $company_id | int | Company ID | |||
|
| $lang_code | string | 2-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $extra | array | Array with extra parameters | |||
|
| $company_data | array | Array with company data | |||
|
|
|
|
| |||
595 | get_company_id_by_name |
|
|
| |||
| Hook get_company_id_by_name is executing before selecting the company ID by name. | $company_name | string | Company name | |||
|
| $condition | string | Where' condition of SQL query | |||
|
|
|
|
| |||
596 | update_company_pre |
|
|
| |||
|
| $company_data |
|
| |||
|
| $company_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $can_update |
|
| |||
|
|
|
|
| |||
597 | update_company |
|
|
| |||
| Update company data (running after fn_update_company() function) | $company_data | array | Company data | |||
|
| $company_id | int | Company integer identifier | |||
|
| $lang_code | string | Two-letter language code (e.g. 'en', 'ru', etc.) | |||
|
| $action | string | Flag determines if company was created (add) or just updated (update). | |||
|
|
|
|
| |||
598 | delete_company_pre |
|
|
| |||
| Performs company pre-delete actions | $company_id | int | Company integer identifier | |||
|
| $can_delete | boolean | Flag if company can be deleted | |||
|
|
|
|
| |||
599 | delete_company |
|
|
| |||
| Performs company post-delete actions | $company_id | int | Company integer identifier | |||
|
| $result | boolean | Company deletion result | |||
|
|
|
|
| |||
600 | change_company_status_pre |
|
|
| |||
| Actions before change company status | $company_id | int | Company ID | |||
|
| $status_to | string | Status to letter | |||
|
| $reason | string | Reason text | |||
|
| $status_from | string | Status from letter | |||
|
| $skip_query | bool | Skip query flag | |||
|
| $notify | bool | Notify flag | |||
|
|
|
|
| |||
601 | change_company_status_before_mail |
|
|
| |||
| Actions between change company status and send mail | $company_id | int | Company ID | |||
|
| $status_to | string | Status to letter | |||
|
| $reason | string | Reason text | |||
|
| $status_from | string | Status from letter | |||
|
| $skip_query | bool | Skip query flag | |||
|
| $notify | bool | Notify flag | |||
|
| $company_data | array | Company data | |||
|
| $user_data | array | User data | |||
|
| $result | bool | Updated flag | |||
|
|
|
|
| |||
602 | companies_sorting |
|
|
| |||
|
| $sorting |
|
| |||
|
|
|
|
| |||
603 | create_company_admin_pre |
|
|
| |||
| Actions before creating company admin | $company_data | array | Company data | |||
|
| $fields | string | Fields list | |||
|
| $notify | boolean | Notify flag | |||
|
|
|
|
| |||
604 | create_company_admin |
|
|
| |||
| Actions before directly creating company admin | $company_data | array | Company data | |||
|
| $fields | string | Fields list | |||
|
| $notify | boolean | Notify flag | |||
|
| $user | array | User data | |||
|
|
|
|
| |||
605 | create_company_admin_post |
|
|
| |||
| Actions after creating company admin | $company_data | array | Company data | |||
|
| $fields | string | Fields list | |||
|
| $notify | boolean | Notify flag | |||
|
| $user | array | User data | |||
|
|
|
|
| |||
606 | is_product_company_condition_required_post |
|
|
| |||
| Executes after company condition requirement is determined when selecting a product data, allows to modify the requirement. | $is_required | bool | Whether the company_condition is required | |||
|
| $is_required |
|
| |||
|
|
|
|
| |||
607 | init_secure_controllers |
|
|
| |||
| Allows to set list of secure controllers which use https connection. | $secure_controllers | array | List of controllers. | |||
|
| $secure_storefront_mode | string | Secure storefront mode (none, full, partial). | |||
|
|
|
|
| |||
608 | before_dispatch |
|
|
| |||
|
| $controller |
|
| |||
|
| $mode |
|
| |||
|
| $action |
|
| |||
|
| $dispatch_extra |
|
| |||
|
| $area |
|
| |||
|
|
|
|
| |||
609 | dispatch_assign_template |
|
|
| |||
| Performs actions after template assignment and before controller run | $controller | string | controller name | |||
|
| $mode | string | controller mode name | |||
|
| $area | string | current working area | |||
|
| $controllers_cascade | array | list of controllers to run | |||
|
|
|
|
| |||
610 | dispatch_before_send_response |
|
|
| |||
| Allows to perform actions before HTTP response is sent to the client. This is the last place where you can modify HTTP headers list. | $status | string | Controller response status | |||
|
| $area | string | Currentry running application area | |||
|
| $controller | string | Executed controller | |||
|
| $mode | string | Executed mode | |||
|
| $action | string | Executed action | |||
|
|
|
|
| |||
611 | get_route |
|
|
| |||
|
|
|
|
| |||
|
| $req |
|
| |||
|
| $result |
|
| |||
|
| $area |
|
| |||
|
| $is_allowed_url |
|
| |||
|
|
|
|
| |||
612 | get_route_runtime |
|
|
| |||
| Executes after routing is performed before setting runtime variables, allowing to modify them. |
| |||||
|
| $req | array | Request parameters | |||
|
| $area | string | Site's area | |||
|
| $is_allowed_url | bool | Flag that determines if url is supported | |||
|
| $controller | string | Controller to handle request | |||
|
| $mode | string | Requested controller mode | |||
|
| $action | string | Requested mode action | |||
|
| $dispatch_extra | string | Additional dispatch data | |||
|
| $current_url_params | array | Parameters to generate current url | |||
|
| $current_url | string | Current url | |||
|
| $current_url |
|
| |||
|
|
|
|
| |||
613 | get_storefront_url |
|
|
| |||
|
| $protocol |
|
| |||
|
| $company_id |
|
| |||
|
| $url |
|
| |||
|
|
|
|
| |||
614 | import_post |
|
|
| |||
| Executes after objects were imported into a store. | $pattern | array | Imported items specification | |||
|
| $import_data | array | Imported items | |||
|
| $options | array | Import options | |||
|
| $result | bool | Import result | |||
|
| $processed_data | array | Information about objects affected by import | |||
|
|
|
|
| |||
615 | exim_get_pattern_definition_export_fields |
|
|
| |||
|
| $pattern_id |
|
| |||
|
| $get_for |
|
| |||
|
| $extra |
|
| |||
|
| $field_id |
|
| |||
|
| $field_data |
|
| |||
|
| $schema |
|
| |||
|
|
|
|
| |||
616 | exim_get_pattern_definition_options |
|
|
| |||
|
| $pattern_id |
|
| |||
|
| $get_for |
|
| |||
|
| $extra |
|
| |||
|
| $option_id |
|
| |||
|
| $option_data |
|
| |||
|
| $schema |
|
| |||
|
|
|
|
| |||
617 | exim_get_product_url |
|
|
| |||
|
| $url |
|
| |||
|
| $product_id |
|
| |||
|
| $options |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
618 | copy_file |
|
|
| |||
|
| $source |
|
| |||
|
| $dest |
|
| |||
|
| $silent |
|
| |||
|
| $exclude_files |
|
| |||
|
|
|
|
| |||
619 | check_uploaded_data_pre |
|
|
| |||
| Actions before check uploaded data | $uploaded_data | array | Uploaded data | |||
|
| $filter_by_ext | array | Allowed file extensions | |||
|
| $result | bool | Result status | |||
|
| $processed | bool | Processed flag | |||
|
|
|
|
| |||
620 | check_uploaded_data_post |
|
|
| |||
| Actions after check uploaded data | $uploaded_data | array | Uploaded data | |||
|
| $filter_by_ext | array | Allowed file extensions | |||
|
| $result | bool | Result status | |||
|
| $processed | bool | Processed flag | |||
|
|
|
|
| |||
621 | attach_absolute_image_paths |
|
|
| |||
|
| $image_data |
|
| |||
|
| $object_type |
|
| |||
|
| $path |
|
| |||
|
| $image_name |
|
| |||
|
|
|
|
| |||
622 | update_image |
|
|
| |||
| Hook is executed before saving or updating an image. | $image_data | array | Image data | |||
|
| $image_id | int | Image ID | |||
|
| $image_type | string | Type of an object image belongs to (product, category, etc.) | |||
|
| $images_path | string | Path to directory image is located at | |||
|
| $_data | array | Data to be saved into "images" DB table | |||
|
| $mime_type | string | MIME type of an image file | |||
|
| $is_clone | bool | True if image is copied from an existing image object | |||
|
|
|
|
| |||
623 | delete_image_pre |
|
|
| |||
|
| $image_id |
|
| |||
|
| $pair_id |
|
| |||
|
| $object_type |
|
| |||
|
|
|
|
| |||
624 | delete_image |
|
|
| |||
|
| $image_id |
|
| |||
|
| $pair_id |
|
| |||
|
| $object_type |
|
| |||
|
| $_image_file |
|
| |||
|
|
|
|
| |||
625 | get_image_pairs_pre |
|
|
| |||
|
| $object_ids |
|
| |||
|
| $object_type |
|
| |||
|
| $pair_type |
|
| |||
|
| $get_icon |
|
| |||
|
| $get_detailed |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
626 | get_image_pairs_post |
|
|
| |||
|
| $object_ids |
|
| |||
|
| $object_type |
|
| |||
|
| $pair_type |
|
| |||
|
| $get_icon |
|
| |||
|
| $get_detailed |
|
| |||
|
| $lang_code |
|
| |||
|
| $pairs_data |
|
| |||
|
|
|
|
| |||
627 | update_image_pairs |
|
|
| |||
|
| $pair_ids |
|
| |||
|
| $icons |
|
| |||
|
| $detailed |
|
| |||
|
| $pairs_data |
|
| |||
|
| $object_id |
|
| |||
|
| $object_type |
|
| |||
|
| $object_ids |
|
| |||
|
| $update_alt_desc |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
628 | delete_image_pair |
|
|
| |||
|
| $pair_id |
|
| |||
|
| $object_type |
|
| |||
|
|
|
|
| |||
629 | generate_thumbnail_pre |
|
|
| |||
| Actions before thumbnail generate | $image_path | string | Path to image | |||
|
| $width | int | Width of thumbnail | |||
|
| $height | int | Height of thumbnail | |||
|
| $make_box | bool | If true create rectangle border | |||
|
|
|
|
| |||
630 | generate_thumbnail_file_pre |
|
|
| |||
| Actions before thumbnail generate, if thumbnail is not exists, after validations |
|
| ||||
|
| $real_path | string | Real path to image | |||
|
| $lazy | string | lazy generation - returns script URL that generates thumbnail | |||
|
| $filename |
|
| |||
|
| $width |
|
| |||
|
| $height |
|
| |||
|
|
|
|
| |||
631 | generate_thumbnail_post |
|
|
| |||
| Actions after thumbnail generate | $th_filename | string | Thumbnail path | |||
|
| $lazy | string | lazy generation - returns script URL that generates thumbnail | |||
|
| $image_path | string | Path to image | |||
|
| $width | int | Width of thumbnail | |||
|
| $height | int | Height of thumbnail | |||
|
|
|
|
| |||
632 | image_to_display_post |
|
|
| |||
| Additionally processes image data | $image_data | array | Image data | |||
|
| $images | array | Array with initial images | |||
|
| $image_width |
|
| |||
|
| $image_height |
|
| |||
|
|
|
|
| |||
633 | init_templater |
|
|
| |||
| Change templater pre-init parameters | $view | object | Templater object | |||
|
|
|
|
| |||
634 | init_templater_post |
|
|
| |||
| Change templater parameters | $view | object | Templater object | |||
|
|
|
|
| |||
635 | init_company_data |
|
|
| |||
|
| $params |
|
| |||
|
| $company_id |
|
| |||
|
| $company_data |
|
| |||
|
|
|
|
| |||
636 | init_company_id |
|
|
| |||
|
| $params |
|
| |||
|
| $company_id |
|
| |||
|
| $available_company_ids |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
637 | init_currency_pre |
|
|
| |||
| Performs actions before initializing currencies | $params | array | request parameters | |||
|
| $area | string | Area ('A' for admin or 'C' for customer) | |||
|
|
|
|
| |||
638 | init_currency_post |
|
|
| |||
| Sets currencies | $params | array | request parameters | |||
|
| $area | string | Area ('A' for admin or 'C' for customer) | |||
|
| $primary_currency | string | Primary currency code | |||
|
| $secondary_currency | string | Secondary currency code | |||
|
|
|
|
| |||
639 | init_layout |
|
|
| |||
| Executes before storing viewed layout data into Registry, allows to modify layout data. | $params | array | Request parameters | |||
|
| $layout | array | Layout data | |||
|
|
|
|
| |||
640 | user_init |
|
|
| |||
|
| Tygh::$app['session']['auth'] |
|
| |||
|
| $user_info |
|
| |||
|
| $first_init |
|
| |||
|
|
|
|
| |||
641 | get_countries_pre |
|
|
| |||
| Change parameters for getting countries list | $params | array | Params list | |||
|
| $items_per_page | int | Countries per page | |||
|
| $lang_code | str | Language code | |||
|
| $default_params | array | Default params | |||
|
|
|
|
| |||
642 | get_countries |
|
|
| |||
| Prepare params for getting countries SQL query | $params | array | Params list | |||
|
| $items_per_page | int | Countries per page | |||
|
| $lang_code | str | Language code | |||
|
| $fields | array | Fields list | |||
|
| $joins | array | Joins list | |||
|
| $condition | str | Conditions query | |||
|
| $group | str | Group condition | |||
|
| $sorting | str | Sorting condition | |||
|
| $limit | str | Limit condition | |||
|
|
|
|
| |||
643 | get_countries_post |
|
|
| |||
| Actions after countries list was prepared | $params | array | Params list | |||
|
| $items_per_page | int | States per page | |||
|
| $lang_code | str | Language code | |||
|
| $states | array | List of selected states | |||
|
|
|
|
| |||
644 | get_states_pre |
|
|
| |||
| Change parameters for getting states list | $params | array | Params list | |||
|
| $items_per_page | int | States per page | |||
|
| $lang_code | str | Language code | |||
|
| $default_params | array | Default params | |||
|
|
|
|
| |||
645 | get_states |
|
|
| |||
| Prepare params for getting states SQL query | $params | array | Params list | |||
|
| $items_per_page | int | States per page | |||
|
| $lang_code | str | Language code | |||
|
| $fields | array | Fields list | |||
|
| $joins | array | Joins list | |||
|
| $condition | str | Conditions query | |||
|
| $group | str | Group condition | |||
|
| $sorting | str | Sorting condition | |||
|
| $limit | str | Limit condition | |||
|
|
|
|
| |||
646 | get_states_post |
|
|
| |||
| Actions after states list was prepared | $params | array | Params list | |||
|
| $items_per_page | int | States per page | |||
|
| $lang_code | str | Language code | |||
|
| $states | array | List of selected states | |||
|
|
|
|
| |||
647 | get_destinations |
|
|
| |||
| Prepare params for getting destinations SQL query | $lang_code | str | Language code | |||
|
| $fields | array | Fields list | |||
|
| $join | array | Joins list | |||
|
| $condition | str | Conditions query | |||
|
| $group | str | Group condition | |||
|
| $sorting | str | Sorting condition | |||
|
| $limit | str | Limit condition | |||
|
|
|
|
| |||
648 | get_destinations_post |
|
|
| |||
| Actions after getting destinations list | $lang_code | str | Language code | |||
|
| $destinations | array | Destinations list | |||
|
|
|
|
| |||
649 | get_available_destination_pre |
|
|
| |||
| Prepare params for getting available destination | $location | array | Location for which destination is required | |||
|
|
|
|
| |||
650 | get_available_destination_post |
|
|
| |||
| Post processing of available destination | $location | array | Location information | |||
|
| $result | str | Available destination | |||
|
| $concur_destinations | array | Destinations list | |||
|
|
|
|
| |||
651 | update_destination_pre |
|
|
| |||
| Adds additional params before adding or updating destination | $data | array | Array of destination data | |||
|
| $destination_id | int | destination identifier | |||
|
| $lang_code | string | language code | |||
|
|
|
|
| |||
652 | save_log |
|
|
| |||
|
| $type |
|
| |||
|
| $action |
|
| |||
|
| $data |
|
| |||
|
| $user_id |
|
| |||
|
| $content |
|
| |||
|
| $event_type |
|
| |||
|
| $object_primary_keys |
|
| |||
|
|
|
|
| |||
653 | admin_get_logs |
|
|
| |||
|
| $params |
|
| |||
|
| $condition |
|
| |||
|
| $join |
|
| |||
|
| $sorting |
|
| |||
|
|
|
|
| |||
654 | mve_place_order |
|
|
| |||
| Actions before save vendor payout | $order_info | array | Order info | |||
|
| $company_data | array | Company data info | |||
|
| $action | string | Action | |||
|
| $order_status | string | Order status | |||
|
| $cart | array | Cart array | |||
|
| $data | array | Data that will be save | |||
|
| $payout_id | int | Payout ID | |||
|
| $auth | array | Auth | |||
|
|
|
|
| |||
655 | mve_place_order_post |
|
|
| |||
| Actions after save vendor payout | $order_id | int | Order ID | |||
|
| $action | string | Action | |||
|
| $order_status | string | Order status | |||
|
| $cart | array | Cart array | |||
|
| $auth | array | Auth | |||
|
| $order_info | array | Order info | |||
|
| $company_data | array | Company data info | |||
|
| $data | array | Data that will be save | |||
|
| $payout_id | int | Payout ID | |||
|
|
|
|
| |||
656 | mve_update_order |
|
|
| |||
|
| $new_order_info |
|
| |||
|
| $order_id |
|
| |||
|
| $old_order_info |
|
| |||
|
| $company_data |
|
| |||
|
| $payout_id |
|
| |||
|
| $payout_data |
|
| |||
|
|
|
|
| |||
657 | take_payment_surcharge |
|
|
| |||
| Getting option 'take payment surcharge from vendor' | $products | array | Products array | |||
|
| $take_surcharge_from_vendor | bool | Take payment surcharge from vendor flag | |||
|
|
|
|
| |||
658 | calculate_options |
|
|
| |||
|
| $cart_products |
|
| |||
|
| $_cart |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
659 | after_options_calculation |
|
|
| |||
|
| $mode |
|
| |||
|
| $data |
|
| |||
|
|
|
|
| |||
660 | get_additional_information |
|
|
| |||
|
| $product |
|
| |||
|
| $product_data |
|
| |||
|
|
|
|
| |||
661 | get_promotions |
|
|
| |||
| This hook allows you to modify the parameters by which the selection from the database will be performed | $params | array | Search params | |||
|
| $fields | array | Selected fields | |||
|
| $sortings | array | Sorting condition | |||
|
| $condition | string | Condition for selecting | |||
|
| $join | string | Join tables | |||
|
| $group | string | Grouping condition | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
662 | get_promotions_post |
|
|
| |||
| This hook allows you to modify the parameters and the result of the function after it has been executed. | $params | array | Search params | |||
|
| $items_per_page | int | Items per page | |||
|
| $lang_code | string | Language code | |||
|
| $promotions | array | Selected promotions | |||
|
|
|
|
| |||
663 | promotion_apply_before_get_promotions |
|
|
| |||
| Executes when applying promotions, before obtaining applicable promotions. Allows to modify cached promotions list. | ||||||
|
| $zone | string | Promotiontion zone (catalog, cart) | |||
|
| $data | array | Data array (product - for catalog rules, cart - for cart rules) | |||
|
| $promotions | array | Cached promotions | |||
|
| $applied_promotions | array | Applied promotions | |||
|
| $promotions |
|
| |||
|
| $applied_promotions |
|
| |||
|
|
|
|
| |||
664 | promotion_apply_pre |
|
|
| |||
| Changes before applying promotion rules | $promotions | array | List of promotions | |||
|
| $zone | string | - promotiontion zone (catalog, cart) | |||
|
| $data | array | data array (product - for catalog rules, cart - for cart rules) | |||
|
| $auth | array | (optional) - auth array (for car rules) | |||
|
| $cart_products | array | (optional) - cart products array (for car rules) | |||
|
|
|
|
| |||
665 | pre_promotion_validate |
|
|
| |||
|
| $promotion_id |
|
| |||
|
| $promotion |
|
| |||
|
| $data |
|
| |||
|
| $stop_validating |
|
| |||
|
| $result |
|
| |||
|
| $auth |
|
| |||
|
| $cart_products |
|
| |||
|
|
|
|
| |||
666 | pre_validate_promotion_attribute |
|
|
| |||
|
| $value |
|
| |||
|
| $condition |
|
| |||
|
| $op |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
667 | pre_promotion_check_coupon |
|
|
| |||
|
| $cart['pending_coupon'] |
|
| |||
|
| $cart |
|
| |||
|
|
|
|
| |||
668 | promotion_check_coupon |
|
|
| |||
|
| $cart['pending_coupon'] |
|
| |||
|
| $cart |
|
| |||
|
|
|
|
| |||
669 | get_promotion_name_pre |
|
|
| |||
|
| $promotion_id |
|
| |||
|
| $lang_code |
|
| |||
|
| $as_array |
|
| |||
|
|
|
|
| |||
670 | delete_promotions_pre |
|
|
| |||
| This hook allows you to modify the input parameters of the function | $promotion_ids | array | - Promotion identifiers | |||
|
|
|
|
| |||
671 | delete_promotions_post |
|
|
| |||
| This hook allows you to modify the promotion identifiers after the SQL queries have been executed. | $promotion_ids | array | - Promotion identifiers | |||
|
|
|
|
| |||
672 | display_promotion_input_field_pre |
|
|
| |||
| Checks if the promotion code input field should be displayed. | $cart | array | Array of cart content and user information necessary for purchase | |||
|
|
|
|
| |||
673 | display_promotion_input_field_post |
|
|
| |||
| Modify result of the promotion code input field visibility check. | $cart | type | Array of cart content and user information necessary for purchase | |||
|
| $result | bool | Checking result | |||
|
|
|
|
| |||
674 | update_promotion_pre |
|
|
| |||
| This hook allows you to modify the input parameters of the function | $data | array | Promotion data | |||
|
| $promotion_id | int | Promotion identifier | |||
|
| $lang_code | string | Language code (ru, en, etc) | |||
|
|
|
|
| |||
675 | update_promotion_post |
|
|
| |||
| This hook allows you to modify the parameters and the result of the function after it has been executed. | $data | array | Promotion data | |||
|
| $promotion_id | int | Promotion identifier | |||
|
| $lang_code | string | Language code (ru, en, etc) | |||
|
|
|
|
| |||
676 | get_search_objects_post |
|
|
| |||
| Additionally processes search schema | $schema | array | Search objects schema | |||
|
| $area | string | Area ('A' for admin or 'C' for customer) | |||
|
| $search | array | Search objects data | |||
|
|
|
|
| |||
677 | customer_search_objects |
|
|
| |||
|
| $schema |
|
| |||
|
| $objects |
|
| |||
|
|
|
|
| |||
678 | search_by_objects |
|
|
| |||
|
| $search['conditions']['values'] |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
679 | create_pages_condition_pre |
|
|
| |||
| Modify search parameters defined in fn_search_register_object | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
|
|
|
| |||
680 | create_pages_condition_post |
|
|
| |||
| Modify prepared data | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
| $data | array | Result search scheme | |||
|
|
|
|
| |||
681 | create_products_condition_pre |
|
|
| |||
| Modify search parameters defined in fn_search_register_object | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
|
|
|
| |||
682 | create_products_condition_post |
|
|
| |||
| Modify prepared data | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
| $data | array | Result search scheme | |||
|
|
|
|
| |||
683 | create_orders_condition_pre |
|
|
| |||
| Modify search parameters defined in fn_search_register_object | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
|
|
|
| |||
684 | create_orders_condition_post |
|
|
| |||
| Modify prepared data | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
| $data | array | Result search scheme | |||
|
|
|
|
| |||
685 | create_users_condition_pre |
|
|
| |||
| Modify search parameters defined in fn_search_register_object | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
|
|
|
| |||
686 | create_users_condition_post |
|
|
| |||
| Modify prepared data | $params | array | List of search parameters | |||
|
| $lang_code | string | 2-letter language code | |||
|
| $data | array | Result search scheme | |||
|
|
|
|
| |||
687 | get_user_info_pre |
|
|
| |||
| Actions before getting user data | $user_id | string | User identifier | |||
|
| $get_profile | int | Gets profile with user or not | |||
|
| $profile_id | int | Prodile identifier to get | |||
|
|
|
|
| |||
688 | get_user_info_before |
|
|
| |||
| Prepare params for getting user info query | $condition | string | Query condition; it is treated as a WHERE clause | |||
|
| $user_id | int | User identifier | |||
|
| $user_fields | array | Array of table column names to be returned | |||
|
| $join |
|
| |||
|
|
|
|
| |||
689 | get_user_info |
|
|
| |||
| Actions after getting user data | $user_id | string | User identifier | |||
|
| $get_profile | int | Gets profile with user or not | |||
|
| $profile_id | int | Prodile identifier to get | |||
|
| $user_data | array | User data | |||
|
|
|
|
| |||
690 | get_user_short_info_pre |
|
|
| |||
| Actions before getting short user data | $user_id | int | User identifier | |||
|
| $fields | array | Fields to be retrieved | |||
|
| $condition | string | Conditions | |||
|
| $join | string | Joins | |||
|
| $group_by | string | Group by condition | |||
|
|
|
|
| |||
691 | get_usergroups_pre |
|
|
| |||
| Executes at the beginning of the function, allowing you to modify the arguments passed to the usergrousps-fetching function | $params | array | Query criteria params, for example: array('status'=>'A', 'type'=>'C') | |||
|
| $lang_code | string | Two-letter language code | |||
|
|
|
|
| |||
692 | get_usergroups |
|
|
| |||
| Executes right before performing usergroup-fetching query, allowing you to modify the SQL-query | $params | array | Query criteria params, for example: array('status'=>'A', 'type'=>'C') | |||
|
| $lang_code | string | Two-letter language code | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit | string | String containing the SQL-query LIMIT field | |||
|
|
|
|
| |||
693 | get_usergroups_post |
|
|
| |||
| Executes after all usergroups were fetched from DB and all data post-processing was done. | $usergroups | array | Usergroups list | |||
|
| $params | array | Query criteria params, for example: array('status'=>'A', 'type'=>'C') | |||
|
| $lang_code | string | Two-letter language code | |||
|
|
|
|
| |||
694 | pre_get_usergroups |
|
|
| |||
| @deprecated @since 4.3.0 | $type |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
695 | post_get_usergroups |
|
|
| |||
| @deprecated @since 4.3.0 | $usergroups |
|
| |||
|
| $type |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
696 | get_default_usergroups |
|
|
| |||
|
| $default_usergroups |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
697 | fill_user_fields |
|
|
| |||
| Allows to initialize user data fields. | $exclude | array | List of excluded fields. | |||
|
| $user_data | array | User data. | |||
|
|
|
|
| |||
698 | change_location |
|
|
| |||
|
| $location |
|
| |||
|
| $select |
|
| |||
|
| $condition |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
699 | get_profile_fields |
|
|
| |||
|
| $location |
|
| |||
|
| $select |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
700 | get_profile_fields_post |
|
|
| |||
| Actions after fetching profile fields list | $location | string | Location | |||
|
| $_auth | array | User authorization data | |||
|
| $lang_code | string | Two-letters language code | |||
|
| $params | array | Additional parameters | |||
|
| $profile_fields | array | Fetched profile fields list | |||
|
| $sections | array | Available sections | |||
|
|
|
|
| |||
701 | fill_auth |
|
|
| |||
|
| $auth |
|
| |||
|
| $user_data |
|
| |||
|
| $area |
|
| |||
|
| $original_auth |
|
| |||
|
|
|
|
| |||
702 | pre_define_usergroups |
|
|
| |||
| Executes when determining usergroups the user belongs in the very beginning of the function, allows to modify function parameters. @deprecated since 4.9.2, use define_usergroups_pre instead | $user_data | array | Logged in user data | |||
|
| $area | string | One-letter site area identifier | |||
|
|
|
|
| |||
703 | define_usergroups_pre |
|
|
| |||
| Executes when determining usergroups the user belongs in the very beginning of the function, allows to modify function parameters. | $user_data | array | Logged in user data | |||
|
| $area | string | One-letter site area identifier | |||
|
|
|
|
| |||
704 | define_usergroups |
|
|
| |||
| Executes when determining usergroup that user belongs to before fetching usergroups from the database, allows to modify SQL query parts. | $user_data | array | Logged in user data | |||
|
| $area | string | One-letter site area identifier | |||
|
| $usergroup_types |
|
| |||
|
|
|
|
| |||
705 | post_define_usergroups |
|
|
| |||
| Executes after usergroups the user belongs to are determined, allows to modify the function return result. @deprecated since 4.9.2, use define_usergroups_post instead | $user_data | array | Logged in user data | |||
|
| $area | string | One-letter site area identifier | |||
|
| $area |
|
| |||
|
|
|
|
| |||
706 | define_usergroups_post |
|
|
| |||
| Executes after usergroups the user belongs to are determined, allows to modify the function return result. | $user_data | array | Logged in user data | |||
|
| $area | string | One-letter site area identifier | |||
|
| $active_usergroups |
|
| |||
|
|
|
|
| |||
707 | get_user_type_description |
|
|
| |||
|
| $type_descr |
|
| |||
|
|
|
|
| |||
708 | get_users_pre |
|
|
| |||
| Actions before getting users list | $params | array | Params list | |||
|
| $auth | array | Auth data | |||
|
| $items_per_page | int | Items per page | |||
|
| $custom_view | str | Custom view | |||
|
|
|
|
| |||
709 | get_users |
|
|
| |||
| Prepare params for getting users query | $params | array | Params list | |||
|
| $fields | array | Fields list | |||
|
| $sortings | array | Sorting variants | |||
|
| $condition | array | Conditions set | |||
|
| $join | str | Joins list | |||
|
| $auth | array | Auth data | |||
|
|
|
|
| |||
710 | get_users_post |
|
|
| |||
| Actions after getting users list | $users | array | Users list | |||
|
| $params | array | Params list | |||
|
| $auth | array | Auth data | |||
|
|
|
|
| |||
711 | get_user_types |
|
|
| |||
|
| $types |
|
| |||
|
|
|
|
| |||
712 | get_user_edp_pre |
|
|
| |||
| Actions before getting the list of downloadable products available for the user | $params | array | Params list | |||
|
| $items_per_page | int | Items per page | |||
|
|
|
|
| |||
713 | get_user_edp |
|
|
| |||
| Modify the parameters passed to the query that gets the list of downloadable products available for the user | $params | array | Params list | |||
|
| $fields | array | Fields list | |||
|
| $where | string | String containing condition | |||
|
| $limit | string | String containing the SQL-query LIMIT field | |||
|
|
|
|
| |||
714 | get_user_edp_post |
|
|
| |||
| Actions after getting the list of downloadable products available for the user | $params | array | Params list | |||
|
| $items_per_page | int | Items per page | |||
|
| $products | array | The products that the customer can download | |||
|
|
|
|
| |||
715 | is_restricted_admin |
|
|
| |||
|
| $params |
|
| |||
|
| $is_restricted |
|
| |||
|
|
|
|
| |||
716 | init_user_session_data |
|
|
| |||
|
| $sess_data |
|
| |||
|
| $user_id |
|
| |||
|
|
|
|
| |||
717 | update_user_pre |
|
|
| |||
| Actions before updating user | $user_id | int | User ID to update (empty for new user) | |||
|
| $user_data | array | User data | |||
|
| $auth | array | Authentication information | |||
|
| $ship_to_another | bool | Flag indicates that shipping and billing fields are different | |||
|
| $notify_user | bool | Flag indicates that user should be notified | |||
|
|
|
|
| |||
718 | update_profile |
|
|
| |||
|
| $action |
|
| |||
|
| $user_data |
|
| |||
|
| $current_user_data |
|
| |||
|
|
|
|
| |||
719 | update_user_profile_pre |
|
|
| |||
| Modify profile data of registered user | $user_id | int | User identifier | |||
|
| $user_data | array | Profile information | |||
|
| $action | string | Current action (Example: 'add') | |||
|
|
|
|
| |||
720 | update_user_profile_post |
|
|
| |||
| Perform actions after user profile update | $user_id | int | User identifier | |||
|
| $user_data | array | Profile information | |||
|
| $action | string | Current action (Example: 'add') | |||
|
|
|
|
| |||
721 | compare_login_password_pre |
|
|
| |||
| Change user data | $user_data | array | user data | |||
|
| $password | string | user password | |||
|
|
|
|
| |||
722 | compare_login_password_post |
|
|
| |||
| Change user data and checking result | $user_data | array | user data | |||
|
| $password | string | user password | |||
|
| $account | string | Contains customer email | |||
|
| $result | boolean | checking result | |||
|
|
|
|
| |||
723 | user_need_login |
|
|
| |||
|
| $types |
|
| |||
|
|
|
|
| |||
724 | check_user_type |
|
|
| |||
|
| $compatible_types |
|
| |||
|
|
|
|
| |||
725 | update_usergroup |
|
|
| |||
| Update user group data | $usergroup_data | array | User group data | |||
|
| $usergroup_id | int | User group integer identifier | |||
|
| $create | boolean | Flag determines if user group was created (true) or just updated (false). | |||
|
|
|
|
| |||
726 | check_usergroup_available_for_user_post |
|
|
| |||
| Actions after checking if user has the right type for user group provided | $user_id | int | User identifiers | |||
|
| $usergroup_id | int | User group identifier | |||
|
| $result | bool | Check result | |||
|
|
|
|
| |||
727 | delete_usergroups |
|
|
| |||
| Process user groups delete | $usergroup_ids | int | User group identifiers | |||
|
|
|
|
| |||
728 | check_rights_delete_user |
|
|
| |||
| Hook for changing the result of check | $user_data |
|
| |||
|
| $result | array | Array with user data | |||
|
| $result | bool | Result of check | |||
|
|
|
|
| |||
729 | pre_delete_user |
|
|
| |||
|
| $user_id |
|
| |||
|
|
|
|
| |||
730 | delete_user |
|
|
| |||
|
| $user_id |
|
| |||
|
| $user_data |
|
| |||
|
|
|
|
| |||
731 | post_delete_user |
|
|
| |||
| Hook for deleting related user data in addons | $user_id | int | User identificator | |||
|
| $user_data | array | Array with user data (contains user_id, is_root and company_id fields) | |||
|
| count | int | of affected rows | |||
|
|
|
|
| |||
732 | login_user_pre |
|
|
| |||
| Change parameter for login user | $user_id | int | User identifier | |||
|
| $udata | array | User data | |||
|
| $auth | array | Authentication data | |||
|
| $condition | array | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
|
|
|
| |||
733 | sucess_user_login |
|
|
| |||
|
| $udata |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
734 | login_user_post |
|
|
| |||
| Modifies the result after login user | $user_id | int | User identifier | |||
|
| $cu_id | int | Cart user identifier | |||
|
| $udata | array | User data | |||
|
| $auth | array | Authentication data | |||
|
| $condition | array | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $result | string | Result user login | |||
|
|
|
|
| |||
735 | check_permission_manage_profiles |
|
|
| |||
| Changes the result of administrator access to profile management check | $result | boolean | Result of check: true if administeator has access, false otherwise | |||
|
| $user_type | char | Types of profiles | |||
|
|
|
|
| |||
736 | is_user_exists_pre |
|
|
| |||
| Change parameter for user checking | $user_id | int | User identifier | |||
|
| $user_data | type | User data | |||
|
|
|
|
| |||
737 | user_exist |
|
|
| |||
|
| $user_id |
|
| |||
|
| $user_data |
|
| |||
|
| $condition |
|
| |||
|
|
|
|
| |||
738 | is_user_exists_post |
|
|
| |||
| Change parameter for user checking | $user_id | int | User identifier | |||
|
| $user_data | array | User data | |||
|
| $is_exist | bool | Result of checking | |||
|
|
|
|
| |||
739 | get_request_user_type |
|
|
| |||
| Changes defined user type | User | char | type | |||
|
| $params | array | Request parameters | |||
|
| $area | string | current application area | |||
|
|
|
|
| |||
740 | auth_routines |
|
|
| |||
| Selects user data | $request | array | Query parameters | |||
|
| $auth | array | Authentication data | |||
|
| $field | string | SQL field to select user by | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $user_login | string | Value to select user by | |||
|
|
|
|
| |||
741 | user_logout_after |
|
|
| |||
| Allows to perform any actions after user logout. | $auth | array | Auth data from session | |||
|
|
|
|
| |||
742 | check_editable_permissions_post |
|
|
| |||
| Modifies the result of permission checking to modify profile | $auth | array | authentication information | |||
|
| $user_data | array | Edited profile | |||
|
| $has_permissions | bool | checking result | |||
|
|
|
|
| |||
743 | profile_fields_areas |
|
|
| |||
|
| $areas |
|
| |||
|
|
|
|
| |||
744 | get_privileges_post |
|
|
| |||
| Actions after getting usergroups | $usergroup | array | User group data | |||
|
| $privileges | array | User group privileges list | |||
|
|
|
|
| |||
745 | check_can_usergroup_have_privileges_post |
|
|
| |||
| Actions after checking if user group can have privileges | $usergroup | array | Usergroup data | |||
|
| $reslut | bool | Check result | |||
|
|
|
|
| |||
746 | get_payment_usergroups |
|
|
| |||
| Executes when geting the list of usergoups that are displayed on the payments management page before fetching usergroups, allows to modify parameters passed to the fn_get_usergroups function. | $params | array | Usegroup fetching params | |||
|
| $lang_code | string | Two-letter language code | |||
|
|
|
|
| |||
747 | smarty_block_hook_post |
|
|
| |||
|
| $params |
|
| |||
|
| $content |
|
| |||
|
| $overrides |
|
| |||
|
| $smarty |
|
| |||
|
| $hook_content |
|
| |||
|
|
|
|
| |||
748 | styles_block_files |
|
|
| |||
|
| $styles |
|
| |||
|
|
|
|
| |||
749 | exim_product_variant |
|
|
| |||
|
| $v |
|
| |||
|
| $variant |
|
| |||
|
|
|
|
| |||
750 | exim_product_option |
|
|
| |||
|
| $o |
|
| |||
|
| $str |
|
| |||
|
|
|
|
| |||
751 | settings_variants_image_verification_use_for |
|
|
| |||
| Add objects that should use 'Image verification' | $objects | array | Available objects | |||
|
|
|
|
| |||
752 | ajax_destruct_before_response |
|
|
| |||
| Executes before closing session and providing a response to an Ajax request, allows to modify response sent after Ajax request. | $text | string | HTML content of a page loaded via Ajax or empty string for Comet request | |||
|
| $embedded_is_enabled | bool | Whether store is loaded in the Widget mode | |||
|
| $embedded_is_enabled |
|
| |||
|
|
|
|
| |||
753 | api_handle_request |
|
|
| |||
| Rewrite default API behavior | $this | object | Api instance | |||
|
| $authorized | bool | Authorization flag | |||
|
|
|
|
| |||
754 | api_get_user_data_pre |
|
|
| |||
|
| $this |
|
| |||
|
| $this->user_data |
|
| |||
|
|
|
|
| |||
755 | api_get_user_data |
|
|
| |||
| Executes right after obtaining user authentication data from API request headers. Allows to modify data that is used to identify the user who accesses API. | $this |
|
| |||
|
| $auth |
|
| |||
|
|
|
|
| |||
756 | api_check_access |
|
|
| |||
|
| $this |
|
| |||
|
| $entity |
|
| |||
|
| $method_name |
|
| |||
|
| $can_access |
|
| |||
|
|
|
|
| |||
757 | backend_menu_generate_post |
|
|
| |||
| Changes generated menu items | $request | array | request params | |||
|
| $menu | array | items | |||
|
| $actions | array | items Action value, if exists. See: fn_get_route | |||
|
| $this- | array | >selected Menu item, selected by the dispatch | |||
|
|
|
|
| |||
758 | data_keeper_backup_files |
|
|
| |||
|
| $backup_files |
|
| |||
|
|
|
|
| |||
759 | development_show_stub |
|
|
| |||
| Executes after the "Store closed" page template was fetched from file, allows to change page template and placeholders for the error message | $placeholders | array | Placeholders | |||
|
| $append | string | Additional text | |||
|
| $content | string | Template content | |||
|
|
|
|
| |||
760 | get_menus_pre |
|
|
| |||
| Prepare params for sql query before get menus list | $lang_code | string |
| |||
|
| $condition |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
761 | get_menus_post |
|
|
| |||
| Process menus list after sql query |
|
|
| |||
|
| $menus | array | Array of menus data | |||
|
| $lang_code | string |
| |||
|
|
|
|
| |||
762 | delete_menu_pre |
|
|
| |||
| Before delete product tab | $menu_id | int | Id of product tab for delete | |||
|
|
|
|
| |||
763 | delete_menu_post |
|
|
| |||
| After delete product tab | $menu_id | int | Id of product tab for delete | |||
|
|
|
|
| |||
764 | update_menu_pre |
|
|
| |||
| Prepare params for sql query before update menu | $menu_data | array |
| |||
|
|
|
|
| |||
765 | update_menu_description |
|
|
| |||
| Prepare params for sql query before update menu description | $description | array |
| |||
|
|
|
|
| |||
766 | registry_save_pre |
|
|
| |||
| Hook is being executed before saving cache data to persistent storage and clearing expired cache. | $changed_tables | array | List of DB tables that were modified at the runtime. | |||
|
| $cached_keys | array | List of registered cache keys. | |||
|
|
|
|
| |||
767 | sid |
|
|
| |||
|
| $sess_id |
|
| |||
|
|
|
|
| |||
768 | settings_update_value_by_id_pre |
|
|
| |||
|
| $this |
|
| |||
|
| $object_id |
|
| |||
|
| $value |
|
| |||
|
| $company_id |
|
| |||
|
| $execute_functions |
|
| |||
|
| $data |
|
| |||
|
| $old_data |
|
| |||
|
| $table |
|
| |||
|
|
|
|
| |||
769 | settings_update_value_by_id_post |
|
|
| |||
|
| $this |
|
| |||
|
| $object_id |
|
| |||
|
| $value |
|
| |||
|
| $company_id |
|
| |||
|
| $execute_functions |
|
| |||
|
| $data |
|
| |||
|
| $old_data |
|
| |||
|
| $table |
|
| |||
|
|
|
|
| |||
770 | vendor_payouts_update_pre |
|
|
| |||
| Executes at the very beginning of the method, allows to modify passed arguments. |
|
| ||||
|
| $data | array | Payout data | |||
|
| $payout_id | int | Payout identifier | |||
|
| $payout_id |
|
| |||
|
|
|
|
| |||
771 | vendor_payouts_update |
|
|
| |||
|
| $this |
|
| |||
|
| $data |
|
| |||
|
| $payout_id |
|
| |||
|
| $action |
|
| |||
|
|
|
|
| |||
772 | vendor_payouts_update_post |
|
|
| |||
|
| $this |
|
| |||
|
| $data |
|
| |||
|
| $payout_id |
|
| |||
|
| $action |
|
| |||
|
|
|
|
| |||
773 | vendor_payouts_get_list |
|
|
| |||
| Executes before getting payouts list from the database, allows to modify data passed to the query. | $instance | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
| $items_per_page | int | Items per page | |||
|
| $fields | array | SQL query fields | |||
|
| $join | string | JOIN statement | |||
|
| $condition | string | General condition to filter payouts | |||
|
| $date_condition | string | Additional condition to filter payouts by date | |||
|
| $sorting | string | ORDER BY statemet | |||
|
| $limit | string | LIMIT statement | |||
|
|
|
|
| |||
774 | vendor_payouts_get_description |
|
|
| |||
| Executes before getting the payout description, allows to modify data passed to the translation function. | $payout | array | Payout data | |||
|
| $language | string | Two-letter language code | |||
|
| $fields | array | Payout fields used to translate description | |||
|
| $type | string | Payout type used to get language variable | |||
|
|
|
|
| |||
775 | get_order_payout_statuses |
|
|
| |||
| Getting order statuses that will be used for vendor payouts | $statuses | array | Statuses | |||
|
|
|
|
| |||
776 | vendor_payouts_get_income_pre |
|
|
| |||
| Executes before income calculation, allows to modify data passed to the function. | $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
|
|
|
| |||
777 | vendor_payouts_get_income |
|
|
| |||
| Executes before performing query to calculate vendor or admin income, allows to modify data passed to the query. | $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
| $fields | array | SQL query fields | |||
|
| $join | string | JOIN statement | |||
|
| $condition | string | General condition to filter payouts | |||
|
| $date_condition | string | Additional condition to filter payouts by date | |||
|
|
|
|
| |||
778 | vendor_payouts_get_income_post |
|
|
| |||
| Executes after the income is calculated, allows to modify calculated values. | $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
| $amount | float | Income | |||
|
| $amount_carried_forward |
|
| |||
|
|
|
|
| |||
779 | vendor_payouts_get_balance_pre |
|
|
| |||
| Executes before balance calculation, allows to modify data passed to the function. | $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
|
|
|
| |||
780 | vendor_payouts_get_balance |
|
|
| |||
| Executes before performing query to calculate vendor or admin withdrawals used to calculate balance, allows to modify data passed to the query. | $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
| $fields | array | SQL query fields | |||
|
| $join | string | JOIN statement | |||
|
| $condition | string | General condition to filter payouts | |||
|
| $date_condition | string | Additional condition to filter payouts by date | |||
|
|
|
|
| |||
781 | vendor_payouts_get_balance_post |
|
|
| |||
| Executes after the balance is calculated, allows to modify calculated values. |
|
| ||||
|
| $this | VendorPayouts | VendorPayouts instance | |||
|
| $params | array | Search parameters | |||
|
| $amount | float | Balance | |||
|
| $amount_carried_forward |
|
| |||
|
|
|
|
| |||
|
|
|
|
| |||
782 | addons_scheme3_get_description |
|
|
| |||
|
| $this |
|
| |||
|
| $lang_code |
|
| |||
|
| $addon_id |
|
| |||
|
| $addon_translations |
|
| |||
|
| $description |
|
| |||
|
|
|
|
| |||
783 | storage_prefix |
|
|
| |||
|
| $path |
|
| |||
|
| $this->type |
|
| |||
|
|
|
|
| |||
784 | storage_prefix |
|
|
| |||
|
| $path |
|
| |||
|
| $this->type |
|
| |||
|
|
|
|
| |||
785 | get_unique_blocks_pre |
|
|
| |||
| Prepares params for SQL query before getting unique blocks | $join | string | Query join; it is treated as a JOIN clause | |||
|
| $condition | string | Query condition; it is treated as a WHERE clause | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
786 | get_unique_blocks_post |
|
|
| |||
| Prepares params for SQL query before getting unique blocks | $lang_code | string | 2 letter language code | |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
787 | get_block_pre |
|
|
| |||
| Prepares params for SQL query before getting block data | $block_id | int | Block identifier | |||
|
| $snapping_id | int | Snapping identifier | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
788 | get_block_post |
|
|
| |||
| Processes block data after getting it | $snapping_id | int | Snapping identifier | |||
|
| $lang_code | string |
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
789 | get_blocks_pre |
|
|
| |||
| Prepares params for SQL query before getting blocks | $fields | array | Array of table column names to be returned | |||
|
| $grids_ids | array | Identifiers of grids containing the needed blocks | |||
|
| $dynamic_object | array | Dynamic object data | |||
|
| $join | string | Query join; it is treated as a JOIN clause | |||
|
| $condition | string | Query condition; it is treated as a WHERE clause | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
790 | get_blocks_post |
|
|
| |||
| Processes blocks list after getting it | $blocks | array | List of blocks data | |||
|
| $grids_ids | array | Identifiers of grids containing the needed blocks | |||
|
| $dynamic_object | array | Dynamic object data | |||
|
| $join | string | Query join; it is treated as a JOIN clause | |||
|
|
|
|
| |||
791 | update_block_pre |
|
|
| |||
| Prepares block data before updating it | $block_data | array | Array of block data | |||
|
|
|
|
| |||
792 | block_updated |
|
|
| |||
| Actions to be performed after the block is updated | $block_id | int | Block identifier | |||
|
|
|
|
| |||
793 | block_created |
|
|
| |||
| Actions to be performed after the new block is added | $block_id | int | Block identifier | |||
|
|
|
|
| |||
794 | get_grids_pre |
|
|
| |||
| Prepares params for SQL query before getting grids | $params | array | input params | |||
|
|
|
|
| |||
795 | get_grids_post |
|
|
| |||
| Processes grids list after getting it | $grids | array | Array of grids data | |||
|
|
|
|
| |||
796 | get_grid_pre |
|
|
| |||
| Prepares params for SQL query before getting grid | $grid_id | int | Grid identifier | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
797 | get_grid_post |
|
|
| |||
| Processes grid data after getting it | $grid | array | Array of grid data | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
798 | update_grid |
|
|
| |||
| Processes grid data before update it | $grid_data | int | Array of grid data | |||
|
|
|
|
| |||
799 | remove_grid |
|
|
| |||
|
| $grid_id |
|
| |||
|
|
|
|
| |||
800 | layout_get_default |
|
|
| |||
| Modifies the way to get default layout | $theme_name | string | Theme name | |||
|
| $condition | string | Conditions part of SQL query | |||
|
| $fields | array | Fields to select with SQL query | |||
|
| $join | string | Join part of SQL condition | |||
|
| $join |
|
| |||
|
|
|
|
| |||
801 | layout_set_default |
|
|
| |||
| Changes the way how layout is set as default | $this | object | Layout object | |||
|
| $layout_id | integer | layout ID | |||
|
| $condition | string | part of SQL condition | |||
|
|
|
|
| |||
802 | layout_get_list |
|
|
| |||
| Modifies layouts list |
|
|
| |||
|
| $params | array | Search params | |||
|
| $condition | string | Conditions part of SQL condition | |||
|
| $fields | array | Fields to select with SQL query | |||
|
| $join | string | Join part of SQL condition | |||
|
| $join |
|
| |||
|
|
|
|
| |||
803 | layout_update_pre |
|
|
| |||
|
| $this |
|
| |||
|
| $layout_id |
|
| |||
|
| $layout_data |
|
| |||
|
| $create |
|
| |||
|
|
|
|
| |||
804 | get_locations_pre |
|
|
| |||
| Prepares params for SQL query before getting locations | $params | array | input params | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
805 | get_locations_post |
|
|
| |||
| Processes locations list after getting it | $locations | array | Array of locations data | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
806 | get_location_pre |
|
|
| |||
| Prepares params for SQL query before getting location | $dispatch | string | URL dispatch (controller.mode.action) | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
807 | get_location_post |
|
|
| |||
| Processes location data after getting it | $location | array | Location data | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
808 | set_default_location |
|
|
| |||
| Actions before setting location as default | $location | array | Location data | |||
|
|
|
|
| |||
809 | update_location |
|
|
| |||
| Processes location data before updating it | $location_data | int | Array of location data | |||
|
|
|
|
| |||
810 | location_updated |
|
|
| |||
| Actions to be performed after the location is updated | $location_id | int | Location identifier | |||
|
|
|
|
| |||
811 | location_created |
|
|
| |||
| Actions to be performed after the location is created | $location_id | array | Location identifier | |||
|
|
|
|
| |||
812 | remove_location |
|
|
| |||
| Actions before removing location | $location_id | int | Location identifier | |||
|
| $force_removing | bool | Disable default location check | |||
|
|
|
|
| |||
813 | update_location_description |
|
|
| |||
| Processes location description before updating it | $location |
|
| |||
|
| $dispatch |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
814 | get_product_tabs_pre |
|
|
| |||
| Prepares params for SQL query before getting product tabs |
|
| ||||
|
| $fields | array | array of table column names to be returned | |||
|
| $condition | string | Query condition; it is treated as a WHERE clause | |||
|
| $lang_code | string | 2 letter language code | |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
815 | get_product_tabs_post |
|
|
| |||
| Processes product tabs list after getting it | $tabs | array | Array of product tabs data | |||
|
| $lang_code | string | 2 letter language code | |||
|
|
|
|
| |||
816 | delete_product_tab_pre |
|
|
| |||
| Before delete product tab | $tab_id | int | Id of product tab for delete | |||
|
|
|
|
| |||
817 | delete_product_tab_post |
|
|
| |||
| After delete product tab | $tab_id | int | Id of product tab for delete | |||
|
|
|
|
| |||
818 | update_product_tab_pre |
|
|
| |||
| Actions before update product tab | $tab_id | int | Id of product tab for delete | |||
|
|
|
|
| |||
819 | product_tab_updated |
|
|
| |||
| Actions after product tab was updated | $tab_id | int | Identifier of tab | |||
|
|
|
|
| |||
820 | product_tab_created |
|
|
| |||
| Actions after new product tab was created | $tab_id | int | Identifier of new tab | |||
|
|
|
|
| |||
821 | update_product_tab_description |
|
|
| |||
| Actions before updating product tab description | $tab_id | int | Product tab identifier | |||
|
| $description | array | Array of product tab description data | |||
|
|
|
|
| |||
822 | render_blocks |
|
|
| |||
| Actions before render block | $grid | array | Grid data | |||
|
| $block | array | Block data | |||
|
| $this | object | Current RenderManager object | |||
|
| $content | string | Rendered content of blocks | |||
|
|
|
|
| |||
823 | render_block_pre |
|
|
| |||
| Allows to perform any actions before rendering block. | $block | array | Block data | |||
|
| $block_schema | array | Block schema | |||
|
| $params | array | Rendering paramenters | |||
|
| $block_content |
|
| |||
|
|
|
|
| |||
824 | render_block_register_cache |
|
|
| |||
| Determines flags for Cache | $block | array | Block data | |||
|
| $cache_prefix | string | Prefix to cache block | |||
|
| $block_schema | array | Block schema | |||
|
| $cache_this_block | bool | Flag to register cache | |||
|
| $display_this_block | bool | Flag to display block | |||
|
|
|
|
| |||
825 | render_block_content_pre |
|
|
| |||
| Actions before render any variable of block content @deprecated Use "assign_block_content_variable" instead. | $template_variable | string | name of current block content variable | |||
|
| $field | array | Scheme of this content variable from block scheme content section | |||
|
| $block_schema | array | block scheme | |||
|
| $block | array | Block data | |||
|
|
|
|
| |||
826 | render_block_content_after |
|
|
| |||
| Allows to perform any actions after block content was rendered. |
|
| ||||
|
| $block_schema | array | Block schema | |||
|
| $block | array | Block data | |||
|
| $params | array | Rendering paramenters | |||
|
| $load_block_from_cache | bool | Whether block content was found at cache and was loaded out of there | |||
|
| $load_block_from_cache |
|
| |||
|
|
|
|
| |||
827 | render_block_post |
|
|
| |||
|
| $block |
|
| |||
|
| $block_schema |
|
| |||
|
| $block_content |
|
| |||
|
| $load_block_from_cache |
|
| |||
|
| $display_this_block |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
828 | robots_get |
|
|
| |||
|
| $this |
|
| |||
|
| $content |
|
| |||
|
|
|
|
| |||
829 | robots_save |
|
|
| |||
|
| $this |
|
| |||
|
| $processed |
|
| |||
|
| $content |
|
| |||
|
|
|
|
| |||
830 | robots_check |
|
|
| |||
|
| $this |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
831 | robots_get_path |
|
|
| |||
|
| $this |
|
| |||
|
| $path |
|
| |||
|
|
|
|
| |||
832 | db_query |
|
|
| |||
|
| $query |
|
| |||
|
|
|
|
| |||
833 | db_query_process |
|
|
| |||
|
| $query |
|
| |||
|
|
|
|
| |||
834 | db_query_executed |
|
|
| |||
|
| $query |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
835 | usergroup_types_get_list |
|
|
| |||
| Allows to extend the available user group types | $types | array | User group privileges list | |||
|
| $exclude | array | List for user groups to be excluded | |||
|
|
|
|
| |||
836 | usergroup_types_get_map_user_type |
|
|
| |||
| Allows to extend the mapping of user types to user group types | $map | array | The map of user types to user group types | |||
|
|
|
|
| |||
837 | vendor_payout_types_get_all |
|
|
| |||
| Allows to expand list of payout types. | $types | array | Payout types | |||
|
|
|
|
| |||
838 | get_lang_var |
|
|
| |||
|
| $fields |
|
| |||
|
| $tables |
|
| |||
|
| $left_join |
|
| |||
|
| $condition |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
839 | get_languages |
|
|
| |||
| Modify get languages list by specified parameters SQL query parameters @oaram string $limit String containing the SQL-query LIMIT field | ||||||
|
| $params | array | Extra condition for languages | |||
|
| $hash_key | string | Keys of returned array with languages | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit |
|
| |||
|
|
|
|
| |||
840 | get_all_languages |
|
|
| |||
| Modify all languages list SQL query parameters @oaram string $limit String containing the SQL-query LIMIT field | $edit | boolean | Flag that determines if language list is used to be edited | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit |
|
| |||
|
|
|
|
| |||
841 | get_translation_languages |
|
|
| |||
| Adds additional languages to all language list | $languages | array | Languages list | |||
|
| $edit | boolean | Flag that determines if language list is used to be edited | |||
|
|
|
|
| |||
842 | update_language_pre |
|
|
| |||
| Changes language data before update | $language_data | array | Language data | |||
|
| $lang_id | string | language id | |||
|
|
|
|
| |||
843 | update_language_post |
|
|
| |||
| Adds additional actions after language update | $language_data | array | Language data | |||
|
| $lang_id | string | language id | |||
|
| $action | string | Current action ('add', 'update' or bool false if failed to update language) | |||
|
|
|
|
| |||
844 | delete_languages_pre |
|
|
| |||
| Adds additional actions before languages deleting | $lang_ids | array | List of language ids | |||
|
|
|
|
| |||
845 | delete_languages_post |
|
|
| |||
| Adds additional actions after languages deleting | $lang_ids | array | List of language ids | |||
|
| $lang_codes | array | List of language codes | |||
|
| $deleted_lang_codes | array | List of deleted language codes | |||
|
|
|
|
| |||
846 | save_languages_integrity_post |
|
|
| |||
| Executes after removing usages of deleted and disabled languages. | $default_lang | string | Two-letter language code | |||
|
| $settings_changed | bool | True if language settings were changed | |||
|
|
|
|
| |||
847 | get_simple_languages |
|
|
| |||
| Modify simple languages list SQL query parameters @oaram string $limit String containing the SQL-query LIMIT field |
|
|
| |||
|
| $include_hidden | boolean | Get not-disabled languages | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit |
|
| |||
|
|
|
|
| |||
848 | get_available_languages |
|
|
| |||
| Modify available languages list SQL query parameters @oaram string $limit String containing the SQL-query LIMIT field |
|
|
| |||
|
| $area | string | One-letter site area code | |||
|
| $include_hidden | boolean | Include not-disabled languages | |||
|
| $field_list | string | String of comma-separated SQL fields to be selected in an SQL-query | |||
|
| $join | string | String with the complete JOIN information (JOIN type, tables and fields) for an SQL-query | |||
|
| $condition | string | String containing SQL-query condition possibly prepended with a logical operator (AND or OR) | |||
|
| $group_by | string | String containing the SQL-query GROUP BY field | |||
|
| $order_by | string | String containing the SQL-query ORDER BY field | |||
|
| $limit |
|
| |||
|
|
|
|
| |||
849 | delete_language_variables |
|
|
| |||
|
| $names |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
850 | get_language_variable |
|
|
| |||
|
| $fields |
|
| |||
|
| $tables |
|
| |||
|
| $left_join |
|
| |||
|
| $condition |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
851 | get_lang_var |
|
|
| |||
|
| $fields |
|
| |||
|
| $tables |
|
| |||
|
| $left_join |
|
| |||
|
| $condition |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
852 | get_lang_var |
|
|
| |||
|
| $fields |
|
| |||
|
| $tables |
|
| |||
|
| $left_join |
|
| |||
|
| $condition |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
853 | update_lang_values |
|
|
| |||
|
| $lang_data |
|
| |||
|
| $lang_code |
|
| |||
|
| $error_flag |
|
| |||
|
| $params |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
854 | send_mail_pre |
|
|
| |||
| Deprecated: This hook will be removed in version 5.x.x.. Use mailer_create_message_before instead. | $transport |
|
| |||
|
| $message |
|
| |||
|
| $area |
|
| |||
|
| $lang_code |
|
| |||
|
|
|
|
| |||
855 | mailer_create_message_before |
|
|
| |||
| Changes message params before message created | $this | Mailer | Mailer instance | |||
|
| $message | array | Message params | |||
|
| $area | string | Current working area (A-admin|C-customer) | |||
|
| $lang_code | string | Language code | |||
|
| $transport | ITransport | Instance of transport for send mail | |||
|
| $builder | IMessageBuilder | Message builder instance | |||
|
|
|
|
| |||
856 | mailer_send_pre |
|
|
| |||
| Allows to change the message before sending it. | $this | Mailer | Instance of mailer | |||
|
| $transport | ITransport | Instance of transport for send mail | |||
|
| $message | Message | Instance of message | |||
|
| $area | string | Current working area (A-admin|C-customer) | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
857 | mailer_send_post |
|
|
| |||
| Allows to check the result of sending the message. | $this | Mailer | Instance of mailer | |||
|
| $transport | ITransport | Instance of transport for send mail | |||
|
| $message | Message | Instance of message | |||
|
| $result | SendResult | Instance of send result | |||
|
| $area | string | Current working area (A-admin|C-customer) | |||
|
| $lang_code | string | Language code | |||
|
|
|
|
| |||
858 | send_mail |
|
|
| |||
|
| $this |
|
| |||
|
|
|
|
| |||
859 | add_breadcrumb |
|
|
| |||
|
| $title |
|
| |||
|
| $link |
|
| |||
|
|
|
|
| |||
860 | view_process_results_pre |
|
|
| |||
|
| $func |
|
| |||
|
| $items |
|
| |||
|
| $params |
|
| |||
|
|
|
|
| |||
861 | realtime_services_process_response_post |
|
|
| |||
| This hook allows you to modify the processed data received from a realtime shipping service. | $result | array | The result returned by the shipping service | |||
|
| $shipping_key | integer | Shipping service array position | |||
|
| $object | object | The object of the shipping method, the rates of which have just been calculated | |||
|
| $rate | array | The result of the shipping rate calculation | |||
|
|
|
|
| |||
862 | shippings_group_products_list |
|
|
| |||
|
| $products |
|
| |||
|
| $groups |
|
| |||
|
|
|
|
| |||
863 | shippings_get_package_info_pre |
|
|
| |||
| Executes before calculating package information, allowing you to modify the arguments passed to the function | $group | array | Product group information | |||
|
| $include_free_shipping | bool | Include free shipped products into calculation | |||
|
|
|
|
| |||
864 | shippings_get_package_info |
|
|
| |||
| Executes right after cost, weight, amount of products and shipping freight for the package are calculated, allowing you to modify the data and to affect the further repacking of products by shipping parameters | $group | array | Product group information | |||
|
| $include_free_shipping | bool | Include free shipped products into calculation | |||
|
| $package_info | array | Package info with cost, weight and amount of products calculated | |||
|
|
|
|
| |||
865 | shippings_get_package_info_post |
|
|
| |||
| Executes right before returning package information, allowing you to modify it | $group | array | Product group information | |||
|
| $include_free_shipping | bool | Include free shipped products into calculation | |||
|
| $package_info | array | Package info with cost, weight and amount of products calculated | |||
|
| $package_groups | array | Products repacked by shipping properties | |||
|
|
|
|
| |||
866 | shippings_get_shippings_list_pre |
|
|
| |||
| Changes params before shipping list selecting | $group | array | Group products information | |||
|
| $lang_code | string | 2 letters language code | |||
|
| $area | string | Current working area | |||
|
|
|
|
| |||
867 | shippings_get_shippings_list |
|
|
| |||
| Changes company shipping list before main selecting | $group | array | Group products information | |||
|
| $shippings | array | List of company shippings | |||
|
| $condition | string | WHERE condition | |||
|
|
|
|
| |||
868 | shippings_get_shippings_list_conditions |
|
|
| |||
|
| $group |
|
| |||
|
| $shippings |
|
| |||
|
| $fields |
|
| |||
|
| $join |
|
| |||
|
| $condition |
|
| |||
|
| $order_by |
|
| |||
|
|
|
|
| |||
869 | shippings_get_shippings_list_post |
|
|
| |||
| Changes shippings data | $group | array | Group products information | |||
|
| $lang_code | string | 2 letters language code | |||
|
| $area | string | Current working area | |||
|
| $shippings_info | array | List of selected shippings | |||
|
|
|
|
| |||
870 | shippings_get_company_shipping_ids |
|
|
| |||
| Executes after company shipping identifiers are retrieved, allowing to modify them | $company_id | int | Company ID | |||
|
| $shipping_ids | array | List of company shippings identifiers | |||
|
|
|
|
| |||
871 | shippings_calculate_rates_post |
|
|
| |||
| Executes after shipping rates are calculated allowing to modify them. | $shippings | array | List all shippings with information about them | |||
|
| $rates | array | Rates list | |||
|
|
|
|
| |||
872 | smarty_display_mail |
|
|
| |||
| Actions before processing mail content via Smarty |
|
|
| |||
|
| $this | object | Smarty instance | |||
|
| $template | string | Template name | |||
|
| $to_screen | bool | To screen flag | |||
|
| $area | string | Area name | |||
|
| $company_id | int | Company ID | |||
|
| $lang_code | string | Language code | |||
|
| $original_lang_code |
|
| |||
|
| $result |
|
| |||
|
|
|
|
| |||
873 | template_document_get_name |
|
|
| |||
| Allows to change the name of the document template. | $this | Document | Instance of document. | |||
|
| $result | string | Current document name. | |||
|
|
|
|
| |||
874 | template_document_remove_post |
|
|
| |||
| Allows to perform additional actions after deleting a document template. | $this | self | Instance of document template repository. | |||
|
| $document | Document | Instance of document template. | |||
|
|
|
|
| |||
875 | template_document_order_context_init |
|
|
| |||
| Allows to change the context of documents of the “order” type. | $this | self | Instance of order. | |||
|
| $order_id | int | Order identifier. | |||
|
|
|
|
| |||
876 | template_email_remove_post |
|
|
| |||
| Allows to perform additional actions after deleting an email template. | $this | self | Instance of email template repository. | |||
|
| $template | Template | Instance of email template. | |||
|
|
|
|
| |||
877 | template_email_get_name |
|
|
| |||
| Allows to change the name of the email template. | $this | Template | Instance of email template. | |||
|
| $result | string | Current template name. | |||
|
|
|
|
| |||
878 | template_snippet_import |
|
|
| |||
| Allows to perform additional actions after importing a snippet. | $this | self | Instance of snippet exim service. | |||
|
| $data | array | Imported snippet data. | |||
|
| $snippet | Snippet | Instance of snippet. | |||
|
| $result | OperationResult | Export result. | |||
|
|
|
|
| |||
879 | template_snippet_export |
|
|
| |||
| Allows to change snippet data before the export. | $this | self | Instance of snippet exim service. | |||
|
| $snippet | Snippet | Instance of snippet. | |||
|
| $result | array | Export result. | |||
|
|
|
|
| |||
880 | template_snippet_save_post |
|
|
| |||
| Allows to perform additional actions after saving a snippet. | $this | self | Instance of snippet repository. | |||
|
| $snippet | Snippet | Instance of snippet. | |||
|
| $lang_code | string | Language code. | |||
|
|
|
|
| |||
881 | template_snippet_update_status_post |
|
|
| |||
| Allows to perform additional actions after changing the status of a snippet. | $this | self | Instance of snippet repository. | |||
|
| $snippet | Snippet | Instance of snippet. | |||
|
| $new_status | string | New status. | |||
|
|
|
|
| |||
882 | template_snippet_remove_post |
|
|
| |||
| Allows to perform additional actions after deleting a snippet template. | $this | self | Instance of snippet repository. | |||
|
| $snippet | Snippet | Instance of snippet. | |||
|
|
|
|
| |||
883 | template_snippet_render_pre |
|
|
| |||
| Allows to affect the snippet rendering in some way. | $snippet | Snippet | Instance of snippet. | |||
|
| $context | IContext | Instance of context. | |||
|
| $variable_collection | Collection | Instance of variable collection. | |||
|
|
|
|
| |||
884 | template_snippet_render_post |
|
|
| |||
| Allows to affect the results of snippet rendering. | $snippet | Snippet | Instance of snippet. | |||
|
| $context | IContext | Instance of context. | |||
|
| $variable_collection | Collection | Instance of variable collection. | |||
|
| $result | string | Result of render. | |||
|
|
|
|
| |||
885 | patterns_save |
|
|
| |||
| Executes before saving uploading pattern files, allows to modify uploaded files and location. |
| |||||
|
| $style_id | string | Style name | |||
|
| $style | array | Style data | |||
|
| $uploaded_data | array | Uploaded files | |||
|
| $path | string | Path where patterns will be saved | |||
|
| $rel_path | string | Relative patterns path | |||
|
| $rel_path |
|
| |||
|
|
|
|
| |||
886 | patterns_get_path |
|
|
| |||
| Modifies path to patterns | $this | object | Patterns object | |||
|
| $path | string | current path | |||
|
| $style_id | string | style to get path for | |||
|
|
|
|
| |||
887 | patterns_get_rel_path |
|
|
| |||
| Executes when getting relative path to patterns directory, allows to modify it. | $path | string | Relative path to patterns dir | |||
|
| $style_id | string | Style name | |||
|
| $style_id |
|
| |||
|
|
|
|
| |||
888 | styles_get_list |
|
|
| |||
| Modifies styles list | $this | object | Styles object | |||
|
| $style_files | array | style files list | |||
|
| $params | array | search params | |||
|
|
|
|
| |||
889 | styles_get |
|
|
| |||
| Modifies style data | $this | object | Styles object | |||
|
| $less_content | string | style LESS content | |||
|
| $style_id | string | style ID | |||
|
|
|
|
| |||
890 | styles_get_post |
|
|
| |||
| Modifies style data (post-processing) | $this | object | Styles object | |||
|
| $style_id | string | style ID | |||
|
| $params | array | style retrieval params | |||
|
| $style | array | style data | |||
|
|
|
|
| |||
891 | styles_update |
|
|
| |||
| Executes before saving style LESS content into a file, allows to modify style data and saving path. | $style_id | string | File name of the style schema (like: "satori") | |||
|
| $style | array | Style data | |||
|
| $style_path | string | Path to save style to | |||
|
| $less | string | LESS content of the style | |||
|
| $less |
|
| |||
|
|
|
|
| |||
892 | styles_delete_before_logos |
|
|
| |||
| Executes before deleting logos when deleting a style, allows to cancel logos removal. | $style_id | string | Style name | |||
|
| $delete_logos | bool | Indicates if logos for the style have to be deleted | |||
|
| $delete_logos |
|
| |||
|
|
|
|
| |||
893 | delete_style_post |
|
|
| |||
|
| $style_id |
|
| |||
|
|
|
|
| |||
894 | styles_get_manifest |
|
|
| |||
| Modifies the path to style manifest | $this | object | Styles object | |||
|
| $path | string | current path | |||
|
|
|
|
| |||
895 | styles_set_style_pre |
|
|
| |||
| Executes before updating layout style in the DB, allows to prevent this action. |
|
| ||||
|
| $layout_id | int | Layout ID | |||
|
| $style_id | string | Style name | |||
|
| $update_for_layout | bool | Whether update layout information | |||
|
| $result | bool | Return value | |||
|
| $result |
|
| |||
|
|
|
|
| |||
896 | styles_copy |
|
|
| |||
| Executes before copying styles file, allows to modify source and destination files path. |
|
| ||||
|
| $from | array | Source style info: name, less path, css path | |||
|
| $to | array | Destination file info: name, less path, css path | |||
|
| $clone_logos | bool | Indicates if logos have to be cloned for the new style | |||
|
| $clone_logos |
|
| |||
|
|
|
|
| |||
897 | styles_get_style_file |
|
|
| |||
| Modifies the path to style file | $this | object | Styles object | |||
|
| $path | string | current path | |||
|
| $style_id | string | style ID | |||
|
| $type | string | file type | |||
|
|
|
|
| |||
898 | styles_add_custom_css |
|
|
| |||
| Executes before saving style custom CSS content into a file, allows to modify style data and saving path. | $style_id | string | File name of the style schema (like: "satori") | |||
|
| $style_path | string | Path to save style to | |||
|
| $custom_css | string | Custom CSS content of the style | |||
|
| $custom_css |
|
| |||
|
|
|
|
| |||
899 | styles_is_removable_post |
|
|
| |||
| Executes after removability of style is checked, allows to modify the check results. | $style | array | Style data | |||
|
| $is_removable | bool | Whether style can be removed | |||
|
| $is_removable |
|
| |||
|
|
|
|
| |||
900 | sanitize_html |
|
|
| |||
| Allows to configure HTMLPurifier before it purifies given HTML. |
|
| ||||
|
| $raw_html | string | HTML to be purified | |||
|
| $raw_html |
|
| |||
|
|
|
|
| |||
901 | session_set_name_before |
|
|
| |||
| Actions before setting session name | $account_type | string | Current account type | |||
|
| $sess_postfix | string | Session postfix | |||
|
|
|
|
| |||
902 | session_regenerate_id |
|
|
| |||
| Actions after regenerate session id | $old_id | string | Old session Id | |||
|
| $new_id | string | New session Id | |||
|
|
|
|
| |||
903 | sid |
|
|
| |||
|
| $session_id |
|
| |||
|
|
|
|
| |||
904 | companies:apply_for_vendor_company_name |
|
|
| |||
|
|
|
|
| |||
905 | companies:manage_tools_list |
|
|
| |||
|
|
|
|
| |||
906 | wrapper:mainbox_general_title_wrapper |
|
|
| |||
|
|
|
|
| |||
907 | wrapper:mainbox_general_title |
|
|
| |||
|
|
|
|
| |||
908 | wrapper:mainbox_simple_title |
|
|
| |||
|
|
|
|
| |||
909 | wrapper:onclick_dropdown_title |
|
|
| |||
|
|
|
|
| |||
910 | wrapper:sidebox_general_title |
|
|
| |||
|
|
|
|
| |||
911 | wrapper:sidebox_important_title |
|
|
| |||
|
|
|
|
| |||
912 | vendors:apply_page |
|
|
| |||
|
|
|
|
| |||
913 | vendors:apply_fields |
|
|
| |||
|
|
|
|
| |||
914 | wrapper:footer_general_title |
|
|
| |||
|
|
|
|
| |||
915 | wrapper:mainbox_general_title_wrapper |
|
|
| |||
|
|
|
|
| |||
916 | wrapper:mainbox_general_title |
|
|
| |||
|
|
|
|
| |||
917 | wrapper:mainbox_simple_title |
|
|
| |||
|
|
|
|
| |||
918 | wrapper:onclick_dropdown_title |
|
|
| |||
|
|
|
|
| |||
919 | wrapper:sidebox_general_title |
|
|
| |||
|
|
|
|
| |||
920 | wrapper:sidebox_important_title |
|
|
| |||
|
|
|
|
| |||
921 | vendors:apply_page |
|
|
| |||
|
|
|
|
| |||
922 | vendors:apply_fields |
|
|
| |||
|
|
|
|
| |||
923 | vendors:apply_description |
|
|
| |||