Skip to content

Commit 6cb297b

Browse files
author
CJ
committed
Updated wishlist readme file
1 parent 38d712e commit 6cb297b

File tree

1 file changed

+100
-2
lines changed

1 file changed

+100
-2
lines changed

app/code/Magento/Wishlist/README.md

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,100 @@
1-
The Magento_Wishlist implements the Wishlist functionality.
2-
This allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends.
1+
# Magento_Wishlist module
2+
3+
The **Magento_Wishlist** module implements the Wishlist functionality.
4+
5+
This module allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends.
6+
7+
## Installation details
8+
9+
Before installing this module, note that the **Magento_Wishlist** is dependent on the following modules:
10+
11+
- Magento_Captcha
12+
- Magento_Catalog
13+
- Magento_Customer
14+
15+
Before disabling or uninstalling this module, please consider the following dependencies:
16+
17+
- Magento_WishlistAnalytics
18+
19+
Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
20+
21+
## Structure
22+
23+
`Pricing/` - the directory that contain solutions for configurable and downloadable product price.
24+
25+
For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
26+
27+
## Extensibility
28+
29+
Extension developers can interact with the Magento_Wishlist module. For more information about the Magento extension mechanism, see [Magento plug-ins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
30+
31+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Wishlist module.
32+
33+
### Events
34+
35+
The module dispatches the following events:
36+
37+
- `product_option_renderer_init` event in the `\Magento\Wishlist\Block\Customer\Wishlist\Item\Options::_construct()` method. Parameters:
38+
- `block` is a Wishlist block customer items (`\Magento\Wishlist\Block\Customer\Wishlist\Item\Options` class).
39+
- `rss_wishlist_xml_callback` event in the `\Magento\Wishlist\Model\Rss\Wishlist::getRssData()` method. Parameters:
40+
- `$args` is a array of product object (`\Magento\Catalog\Model\Product` class).
41+
- `wishlist_add_item` event in the `\Magento\Wishlist\Model\Wishlist::addItem()` method. Parameters:
42+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
43+
- `wishlist_add_product` event in the `\Magento\Wishlist\Controller\Index\Add::execute()` method. Parameters:
44+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
45+
- `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class).
46+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
47+
- `wishlist_item_collection_products_after_load` event in the `\Magento\Wishlist\Model\ResourceModel\Item\Collection::_assignProducts()` method. Parameters:
48+
- `product_collection` is a product collection object (`\Magento\Catalog\Model\ResourceModel\Product\Collection` class).
49+
- `wishlist_items_renewed` event in the `\Magento\Wishlist\Helper\Data::calculate()` method.
50+
- `wishlist_product_add_after` event in the `\Magento\Wishlist\Model\Wishlist::addNewItem()` method. Parameters:
51+
- `items` is an array of item object (`\Magento\Wishlist\Model\Item` class).
52+
- `wishlist_share` event in the `\Magento\Wishlist\Controller\Index\Send::execute()` method. Parameters:
53+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
54+
- `wishlist_update_item` event in the `\Magento\Wishlist\Controller\Index\UpdateItemOptions::execute()` method. Parameters:
55+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
56+
- `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class).
57+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
58+
59+
For information about the event system in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
60+
61+
### Layouts
62+
63+
This module introduces the following layouts and layout handles in the directories:
64+
65+
- `view/adminhtml/layout`:
66+
- `customer_index_wishlist`
67+
- `view/base/layout`:
68+
- `catalog_product_prices`
69+
- `view/frantend/layout`:
70+
- `catalog_category_view`
71+
- `catalog_product_view`
72+
- `catalogsearch_advanced_result`
73+
- `checkout_cart_index`
74+
- `checkout_cart_item_renderers`
75+
- `customer_account`
76+
- `default`
77+
- `wishlist_email_items`
78+
- `wishlist_email_rss`
79+
- `wishlist_index_configure`
80+
- `wishlist_index_configure_type_bundle`
81+
- `wishlist_index_configure_type_configurable`
82+
- `wishlist_index_configure_type_downloadable`
83+
- `wishlist_index_configure_type_grouped`
84+
- `wishlist_index_configure_type_simple`
85+
- `wishlist_index_index`
86+
- `wishlist_index_share`
87+
- `wishlist_shared_index.xml`
88+
89+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
90+
91+
### UI components
92+
93+
You can extend a customer form and widgets using the configuration files located in the directories
94+
- `view/base/ui_component`:
95+
- `customer_form`
96+
- `view/frontend/ui_component`:
97+
- `widget_recently_compared`
98+
- `widget_recently_viewed`
99+
100+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).

0 commit comments

Comments
 (0)