-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathreadme.txt
65 lines (44 loc) · 2.3 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
=== My Favorites ===
Contributors: takashimatsuyama
Donate link:
Tags: favorites, likes, accessibility, favorite posts
Requires at least: 4.8
Tested up to: 6.6
Requires PHP: 5.4.0
Stable tag: 1.4.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Save user's favorite posts and list them.
== Description ==
Save user's favorite posts and list them.
This plugin is simple. You can save the user's favorite posts just a install and display them anywhere you want with just a shortcode.
The logged-in user's data is saved in the user meta. Other user's data is saved to Web Storage (localStorage).
== Usage ==
* **Shortcode:** `[ccc_my_favorite_select_button post_id="" style=""]`
* **Shortcode:** `[ccc_my_favorite_list_menu slug="" text="" style=""]`
* **Shortcode:** `[ccc_my_favorite_list_results class="" style=""]`
For pages with a shortcode for list view ([ccc_my_favorite_list_results]).
"Load More" is displayed with "posts_per_page".
It will be displayed when the user has more favorite posts than "posts_per_page".
* **Shortcode:** `[ccc_my_favorite_list_results posts_per_page="10"]` default is 100 posts.
You can display the post's "excerpt".
This value is the char length.
If not needed, use "no excerpt" or "0".
* **Shortcode:** `[ccc_my_favorite_list_results excerpt="30"]`
If you want, you can change the code for list view yourself.
* **Shortcode:** `[ccc_my_favorite_list_custom_template style=""]`
For pages with a shortcode for custom list view ([ccc_my_favorite_list_custom_template]).
Add the function (`function ccc_my_favorite_list_custom_template( $my_favorite_post_id ) { }`) for your list view to `your-theme/functions.php`.
`$my_favorite_post_id` is array.
`style="none"` excludes the default CSS for the list.
Detailed usage is under preparation.
== Discover More ==
This plugin is [developed on GitHub](https://github.com/takashi-matsuyama/my-favorites)
== Installation ==
1. Upload `my-favorites` to the `/wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
3. Use shortcodes to display the favorite posts list and an icon for save and a menu for link to list.
== Changelog ==
= 1.4.3 =
Add escapes to attributes to prevent XSS attacks
See the [release notes on GitHub](https://github.com/takashi-matsuyama/my-favorites/releases).