|
1 | | -=== Plugin Name === |
2 | | -Contributors: (this should be a list of wordpress.org userid's) |
3 | | -Donate link: http://example.com/ |
4 | | -Tags: comments, spam |
5 | | -Requires at least: 3.0.1 |
6 | | -Tested up to: 3.4 |
7 | | -Stable tag: 4.3 |
8 | | -License: GPLv2 or later |
9 | | -License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 1 | +# Custom Fields Permalink |
10 | 2 |
|
11 | | -Here is a short description of the plugin. This should be no more than 150 characters. No markup here. |
| 3 | +Plugin allows to use post's custom fields values in permalink structure by adding %field_fieldname%, for posts, pages and custom post types. |
12 | 4 |
|
13 | | -== Description == |
| 5 | +--- |
14 | 6 |
|
15 | | -This is the long description. No limit, and you can use Markdown (as well as in the following sections). |
| 7 | +* Contributors: <a href="https://github.com/athlan">athlan</a> |
| 8 | +* Plugin url: [http://athlan.pl/wordpres-custom-fields-permalink-plugin/](http://athlan.pl/wordpres-custom-fields-permalink-plugin/) |
| 9 | +* Tags: custom fields, permalinks, permalink, url, custom post types, post type, tax, taxonomy, types |
| 10 | +* Requires at least: 3.0.1 |
| 11 | +* Tested up to: 3.9.1 |
| 12 | +* Stable tag: 1.0 |
| 13 | +* License: MIT |
| 14 | +* License URI: http://opensource.org/licenses/MIT |
16 | 15 |
|
17 | | -For backwards compatibility, if this section is missing, the full length of the short description will be used, and |
18 | | -Markdown parsed. |
| 16 | +## Description |
19 | 17 |
|
20 | | -A few notes about the sections above: |
| 18 | +Plugin allows to use post's custom fields values in permalink structure by adding `%field_fieldname%` rewrite tag. |
21 | 19 |
|
22 | | -* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames |
23 | | -* "Tags" is a comma separated list of tags that apply to the plugin |
24 | | -* "Requires at least" is the lowest version that the plugin will work on |
25 | | -* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on |
26 | | -higher versions... this is just the highest one you've verified. |
27 | | -* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for |
28 | | -stable. |
| 20 | +Examples: |
29 | 21 |
|
30 | | - Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so |
31 | | -if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used |
32 | | -for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt` |
33 | | -is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in |
34 | | -your in-development version, without having that information incorrectly disclosed about the current stable version |
35 | | -that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag. |
| 22 | +* `http://example.com/%field_event_date_from%/%postname%/` |
| 23 | +* `http://example.com/post-type/%field_event_date_from%/%postname%/` (with <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin) |
36 | 24 |
|
37 | | - If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where |
38 | | -you put the stable version, in order to eliminate any doubt. |
| 25 | +You can also set different permalink structure depending on custom post type using <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin. You can create own post types by using <a href="https://wordpress.org/plugins/custom-post-type-ui/">Custom Post Type UI</a> plugin. |
39 | 26 |
|
40 | | -== Installation == |
| 27 | +The plugin works for: |
41 | 28 |
|
42 | | -This section describes how to install the plugin and get it working. |
| 29 | +* posts |
| 30 | +* pages |
| 31 | +* custom post types |
43 | 32 |
|
44 | | -e.g. |
| 33 | +Plugin is also avaliable on GitHub: |
| 34 | +<a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin">https://github.com/athlan/wordpress-custom-fields-permalink-plugin</a> |
45 | 35 |
|
46 | | -1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory |
47 | | -1. Activate the plugin through the 'Plugins' menu in WordPress |
48 | | -1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates |
| 36 | +## Installation |
49 | 37 |
|
50 | | -== Frequently Asked Questions == |
| 38 | +* Download the wordpress-custom-fields-permalink-plugin.zip file to your computer. |
| 39 | +* Unzip the file. |
| 40 | +* Upload the `wordpress-custom-fields-permalink-plugin` directory to your `/wp-content/plugins/` directory. |
| 41 | +* Activate the plugin through the 'Plugins' menu in WordPress. |
| 42 | +* Now you can use `%field_fieldname%` tag in Settings -> Permalinks. |
51 | 43 |
|
52 | | -= A question that someone might have = |
| 44 | +## Changelog |
53 | 45 |
|
54 | | -An answer to that question. |
| 46 | +### 1.0 |
| 47 | +* Plugin released. |
55 | 48 |
|
56 | | -= What about foo bar? = |
| 49 | +## Upgrade Notice |
57 | 50 |
|
58 | | -Answer to foo bar dilemma. |
59 | | - |
60 | | -== Screenshots == |
61 | | - |
62 | | -1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from |
63 | | -the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets |
64 | | -directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` |
65 | | -(or jpg, jpeg, gif). |
66 | | -2. This is the second screen shot |
67 | | - |
68 | | -== Changelog == |
69 | | - |
70 | | -= 1.0 = |
71 | | -* A change since the previous version. |
72 | | -* Another change. |
73 | | - |
74 | | -= 0.5 = |
75 | | -* List versions from most recent at top to oldest at bottom. |
76 | | - |
77 | | -== Upgrade Notice == |
78 | | - |
79 | | -= 1.0 = |
80 | | -Upgrade notices describe the reason a user should upgrade. No more than 300 characters. |
81 | | - |
82 | | -= 0.5 = |
83 | | -This version fixes a security related bug. Upgrade immediately. |
84 | | - |
85 | | -== Arbitrary section == |
86 | | - |
87 | | -You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated |
88 | | -plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or |
89 | | -"installation." Arbitrary sections will be shown below the built-in sections outlined above. |
90 | | - |
91 | | -== A brief Markdown Example == |
92 | | - |
93 | | -Ordered list: |
94 | | - |
95 | | -1. Some feature |
96 | | -1. Another feature |
97 | | -1. Something else about the plugin |
98 | | - |
99 | | -Unordered list: |
100 | | - |
101 | | -* something |
102 | | -* something else |
103 | | -* third thing |
104 | | - |
105 | | -Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. |
106 | | -Titles are optional, naturally. |
107 | | - |
108 | | -[markdown syntax]: http://daringfireball.net/projects/markdown/syntax |
109 | | - "Markdown is what the parser uses to process much of the readme file" |
110 | | - |
111 | | -Markdown uses email style notation for blockquotes and I've been told: |
112 | | -> Asterisks for *emphasis*. Double it up for **strong**. |
113 | | -
|
114 | | -`<?php code(); // goes in backticks ?>` |
| 51 | +No upgrade notices. |
0 commit comments