-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathreadme.txt
175 lines (113 loc) · 8.43 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
=== WP SEO ===
Contributors: alleyinteractive, mboynes, potatomaster, davisshaver, dlh
Tags: seo
Requires at least: 4.6.0
Tested up to: 4.8.0
Stable tag: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
An SEO plugin that stays out of your way.
== Description ==
WP SEO is designed for professionals who want to build a solid foundation for an SEO-friendly website.
It allows you to create templates for the title tag, meta description, and meta keywords on your posts, pages, custom post types, archives, and more. The templates can be populated dynamically with built-in formatting tags like `#title#` or `#author_name#`. You can even allow authors to create custom title and meta values for individual entries.
Meanwhile, it leaves other features like Open Graph metadata and XML sitemaps to more-specialized plugins.
For developers, WP SEO is welcoming. It applies filters all over the place, and extending the plugin with your own custom formatting tags is a cinch.
== Installation ==
1. Upload to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Visit Settings > SEO to begin setting up the plugin.
== Usage ==
WordPress SEO allows you to customize the default format of `<title>` tags, `<meta>` descriptions, and `<meta>` keywords for your home page, single posts and custom post types, taxonomy and date archives, and more.
Most of this customization happens on the WP SEO settings page, which you can access in the Dashboard at Settings > SEO.
=== Basic usage ===
The settings page has headings for each group of fields you can customize. Groups are hidden by default; click the heading to expand it.
For example, to customize the defaults for your Posts, use the fields under the heading "Single Post Defaults." To customize the default for author archives, use the fields under the heading "Author Archives."
When you're done editing fields, save your changes using the button at the bottom of the page.
A "format" can be regular text. For example, you could set the `<title>` tag of all date archives to be "Posts from our time machine."
==== Formatting tags ====
The power of formats, though, is in formatting tags, which create dynamic text that responds to the content of the page.
A formatting tag looks like `#site_name#` or `#author#` or `#archive_date#`.
With formatting tags, setting the `<title>` tag format of your date archive to "Time machine set to #archive_date#" would display something like "Time machine set to September 2014" -- and the date would change automatically based on the archive the user looked at.
WP SEO comes bundled with many formatting tags. Some more examples:
* If you wanted to include the author name and tags by default in your `<meta>` keywords for all Posts, you could go to "Single Post Defaults" and, under "Meta Keywords Format," use "#author#, #tags#."
* If you wanted to use category descriptions in the `<meta>` description field, you could go to "Category Archives" and, under "Meta Description Format", use #term_description#."
* If you had a custom "Review" post type and wanted the `<title>` tag to include the date each review was last updated, you could go to "Single Review Defaults" and, under "Title Tag Format," use "#title# Review (Updated #date_modified#).
These formatting tags are available out-of-the-box:
* `#archive_date#`
* `#author#`
* `#categories#`
* `#date_modified#`
* `#date_published#`
* `#excerpt#`
* `#post_type_plural_name#`
* `#post_type_singular_name#`
* `#search_term#`
* `#site_description#`
* `#site_name#`
* `#tags#`
* `#term_description#`
* `#term_name#`
* `#thumbnail_url#`
* `#title#`
Any WordPress plugin or theme can register their own tags, too. For example, a social media plugin could add a `#twitter_handle#` formatting tag that displayed a post author's Twitter username.
More details about each tag are available under the "Help" button in the upper-right corner of the settings page.
=== Per-entry and per-term fields ===
The WP SEO Settings page allows you to set global defaults. But WP SEO also supports setting custom title, description, and keyword values for your site's individual entries and taxonomy terms.
You can enable these fields on a per-post type basis under the "Post Types" heading on the WP SEO Settings page. Check the box next to a post type to enable the fields, and the fields will appear on the "Edit" page for each post type.
You can enable the fields on a per-taxonomy basis under the "Taxonomies" heading on the WP SEO Settings page. Check the box next to a taxonomy to enable the fields, and the fields will appear in the "Add New" form for each taxonomy and the "Edit" page for each taxonomy term.
=== Custom meta tags ===
In addition to the core support for `<meta>` description and keywords, WP SEO allows you to set custom `<meta>` tags that are used throughout your site. These are managed under the "Other Meta Tags" heading on the WP SEO Settings page.
For example, if you wanted to add a Google Verification `<meta>` tag for your site, you could go to "Other Meta Tags," add "google-site-verification" under the "Name" field, and the value under the "Content" field.
Use the "Add another" button to add as many custom `<meta>` tags as you need.
Use the "Remove group" button, or just remove the field content, to remove a custom `<meta>` tag.
== Frequently Asked Questions ==
= How can I change who has access to the SEO settings page? =
In your plugin or theme, return your capability of choice to the `'wp_seo_options_capability'` filter. For example:
// Allow users with the 'edit_posts' capability to access Settings > SEO.
add_filter( 'wp_seo_options_capability', function () {
return 'edit_posts';
} );
// Do not allow anyone to access Settings > SEO.
add_filter( 'wp_seo_options_capability', function () {
return 'do_not_allow';
} );
== Formatting Tag "Safe Mode" ==
You can enable formatting tag "safe mode" by calling `wp_seo_enable_formatting_tag_safe_mode()` in your plugin or theme. For example: `add_action( 'template_redirect', 'wp_seo_enable_formatting_tag_safe_mode' )`.
"Safe mode" means that WP SEO will not set any `<title>` tags or include any `<meta>` tags that would contain an unrecognized formatting tag.
An "unrecognized" formatting tag could be one with typo, like `#categoories#`. Or it could be a formatting tag from another plugin that was later uninstalled.
When "safe mode" is disabled, WP SEO will include the unrecognized formatting tag in `<title>` or `<meta>` tags as regular text.
"Safe mode" is disabled by default. Which mode to use is up to you. It's easy to spot mistakes when safe mode is disabled, but potentially unhelpful to your site if the mistakes aren't caught.
== Screenshots ==
1. Settings page
2. The on-screen documentation for the included formatting tags
3. Setting title and meta fields for a post
== Changelog ==
= 1.0.0 =
This is the final major version release planned for WP SEO. There are no plans for additional feature development.
* Breaking change: Always filter the title, description, and keyword formats. Props Sean Fisher.
* Added: `wp_seo_after_post_meta_fields` action, `wp_seo_saveable_fields` filter, and `wp_seo_character_count_fields` filter. Props Sean Fisher.
* Added: Composer installation support. Props Griffen Fargo.
= 0.13.0 =
* Added: 'wp_seo_meta_field_content' filter. Props Arun Chaitanya Jami.
* Changed: Improve post meta box UI when placed in the sidebar. Props John Blackbourn.
* Changed: Raised minimum WordPress version to 4.6.0.
= 0.12.0 =
* Added: `#thumbnail_url#` formatting tag, which represents the URL for the featured image of the content being viewed.
* Added: Formatting Tag "Safe Mode" for preventing the display of unrecognized formatting tags.
* Added: Print an HTML comment next to WP SEO meta tags to help spot them while debugging.
* Fixed: Added translator comments to strings with placeholders.
* Changed: Raised minimum WordPress version to 4.4.0.
= 0.11.3-beta1 =
* Changed: Announced planned changes to default filters.
= 0.11.2 =
* Fixed: On the settings page, make the "Search" section heading's font size consistent with other section headings.
= 0.11.1 =
* Fixed: Update to latest Underscore `_.template()` syntax.
= 0.11.0 =
* Add hooks for customizing post- and term-field markup.
= 0.10.0 =
* Add support for title tags generated with `wp_get_document_title()`, introduced in WordPress 4.4.
= 0.9.1 =
* Fix an error that could occur when attempting to process invalid meta tag values.
= 0.9.0 =
* Initial release.