forked from matthiassiegel/Related
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
144 lines (86 loc) · 5.73 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
=== Related ===
Contributors: chipsandtv
Donate link: https://github.com/matthiassiegel/Related
Tags: related posts, related, post
Requires at least: 2.9
Tested up to: 3.3
Stable tag: 1.1.2
A simple 'related posts' plugin that lets you select related posts manually instead of automatically generating the list.
== Description ==
A simple 'related posts' plugin that lets you select related posts manually instead of automatically generating the list. Supports any post types in WordPress, including custom ones.
Features:
* Add related posts to your blog posts, pages etc.
* Choose from posts, pages or any other post type
* Support for custom post types
* Re-order related posts via drag and drop
* Custom markup possible, or simply use the default output
I wrote the plugin because I wanted to have the option to add related posts to each blog post using a simple but functional plugin without a lot of junk. Unlike other 'related posts' plugins that use algorithms to automatically generate a list of posts, I wanted to be able to select the related posts myself.
The plugin targets small and medium sized blogs. On blogs with lots of posts (500+) it might not be very comfortable to choose the posts via select box.
You can contribute improvements to this plugin by forking it on [GitHub](https://github.com/matthiassiegel/Related).
To display the related posts, simply add the following line in your template, inside the WordPress loop.
<?php echo $related->show(get_the_ID()); ?>
For advanced options, see the installation docs.
== Installation ==
**Option 1 - Automatic install**
Use the plugin installer built into WordPress to search for the plugin. WordPress will then download and install it for you.
**Option 2 - Manual install**
1. Make sure the files are within a folder.
2. Copy the whole folder inside the wp-content/plugins/ folder.
3. In the backend, activate the plugin. You can now select related posts when you create or edit blog posts, pages etc.
**How to display the related posts on your website**
The related posts are displayed by adding
<?php echo $related->show($post_id); ?>
to your template. Replace `` $post_id `` with a post ID. If you call it within the WordPress loop, you can use
<?php echo $related->show(get_the_ID()); ?>
You have the option of either outputting a pre-formatted list or returning a PHP array of related posts to customise the
markup yourself.
**Examples**
*Example 1: Using the default output*
<?php echo $related->show(get_the_ID()); ?>
This can be called within the WordPress loop. It will output a `` <ul> `` list with links.
*Example 2: Returning an array*
<?php $rel = $related->show(get_the_ID(), true); ?>
With the second argument set to true, it will return an array of post objects. Use it to generate your own custom markup.
Here is an example:
<?php
$rel = $related->show(get_the_ID(), true);
// Display the title of each related post
foreach ($rel as $r) :
echo $r->post_title . '<br />';
endforeach;
?>
== Frequently Asked Questions ==
= Who should use this plugin? =
People who want to list 'related posts' in their blog posts or pages, and want to choose the related posts themselves, instead of
having a list generated automatically like other plugins do, using weird algorithms that often create comical results.
= Where does the plugin store its data? =
Data is stored in the existing postmeta table in the WordPress database. No additional tables are created.
= How many related posts can I add? =
As many as you like, there's no limit.
= WordPress version 2.9 is listed as minimum required version. Any chance it will work with earlier versions? =
There's a chance it will work with earlier versions, but I haven't tested it.
= I have 500+ posts on my blog and selecting the posts with the one select box isn't very comfortable, lots of scrolling. =
That's true, it isn't ideal for large blogs. This might get improved in future releases, feel free to submit ideas.
= In WordPress 2.9, a strange error appears when I try to delete the plugin. =
Yes, I don't know what the problem is. It's only in WordPress 2.9. Just delete the plugin directory manually from wp-content/plugins.
= When I delete the plugin, will it delete the related posts data? =
With version 1.1, all data remains in the database when the plugin files are deleted through the plugins page in WordPress. So if you accidentally delete the plugin, or if you decide to install it again later, your data should still be there.
= Is this plugin actively maintained? =
Not very actively, mostly because my focus is on Ruby development, so my interest in WordPress/PHP is limited. However I get quite a few emails from people who enjoy using the plugin, so if there are any major issues I will look into it.
If you're a developer you are encouraged to submit improvements. Just fork it on [GitHub](https://github.com/matthiassiegel/Related) and submit changes. Every now and then I might find time to incorporate improvements and push out a new release.
== Screenshots ==
1. Choosing related posts in the edit post screen
== Changelog ==
= 1.1.1 =
* Minor rewrites that may prevent interference with other plugins
= 1.1 =
* Bugfix: related posts are now correctly saved (deleted) when all related posts are removed from the current post
* Feature: all post types in WordPress are now supported (including custom ones)
* Improvement: select box now sorts posts by title and displays post type
* Improvement: current post is now excluded from the list of posts
* Improvement: data now remains stored in database when plugin is deleted, to avoid accidental loss of data
* Improvement: general code quality improvements
= 1.0 =
* Initial release. No known issues.
== Upgrade Notice ==
Either let WordPress do the upgrade or just overwrite the files.