-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
130 lines (82 loc) · 4.86 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
=== SEO Writing Assistant SEMrush Custom Fields ===
Contributors: enrico.sorcinelli
Tags: seo, readability, content analysis, content marketing, custom fields, page builder
Requires at least: 4.4
Requires PHP: 5.2.4
Tested up to: 5.2.1
Stable tag: 1.1.0
License: GPLv2 or later
== Description ==
The [SEMrush SEO Writing Assistant](https://wordpress.org/plugins/semrush-seo-writing-assistant/) plugin read only from post `title` and post `content` elements for the real time check.
This lightweight plugin allows you to use an arbitrary value for that check in addition to those values.
So, if you are using some kind of a page builders, field managers and so on, you have only to define a constant in your _wp_config.php_ file and eventually to write a little bit of JavaScript code in order to specify which fields.
Note that the plugin don't replace _SEMrush SEO Writing Assistant_ but is intended to be used together.
== Installation ==
This section describes how to install the plugin and get it working.
* Upload the plugin files to the `/wp-content/plugins/seo-writing-assistant-semrush-custom-fields` directory, or install the plugin through the WordPress _Plugins_ screen directly.
* Activate the plugin through the _Plugins_ screen in WordPress.
== Usage ==
Once the plugin is activated you can configure it by defining following constants in your _wp-config.php_:
* `SWA_SEMRUSH_CUSTOM_FIELDS_PLUGIN_AUTOENABLE`
Automatically enable use of additional text value for SEMrush check. The default value is `false`.
This is the only configuration you have to do in order to have the plugin feature working.
For example:
`define( 'SWA_SEMRUSH_CUSTOM_FIELDS_PLUGIN_AUTOENABLE', true );`
* `SWA_SEMRUSH_CUSTOM_FIELDS_PLUGIN_INTERVAL`
Allows to change the interval between automatic updates of the text used by SEMrush checks.
The default value is `5` seconds.For example:
`define( 'SWA_SEMRUSH_CUSTOM_FIELDS_PLUGIN_INTERVAL', 10 );`
You can alernatavely control the plugins programmatically, by using
`semrush_seo_writing_assistant_post_types` (optional) filter and `SeoWritingAssistantSEMrushCustomFields` JavaScript object (see below).
== API ==
= WordPress Hooks =
**`swa_semrush_custom_fields_settings` **
Filters plugin settings values.
`apply_filters( 'swa_semrush_custom_fields_settings', array $settings )`
**`semrush_seo_writing_assistant_post_types`**
Filters post types where to enable plugin. Default to `array( 'post', 'page', 'product' )`.
`apply_filters( 'semrush_seo_writing_assistant_post_types', array $post_types )`
The filter has the same name as the one used by _SEMrush SEO Writing Assistant_ plugin (since version 1.0.4) used for the same purpose.
= JavaScript Event =
**`seo-writing-assistant-semrush`**
This event allows you to update the text for SEMrush analysis.
The following example will update text for SEMrush check every 5 seconds, using `excerpt` and `my_custom_fields` custom field values (working both with block and classic editors):
`
jQuery( document ).ready( function() {
var swa = new SeoWritingAssistantSEMrushCustomFields( { interval: 5 } );
jQuery( document ).on( 'seo-writing-assistant-semrush', function( event, data ) {
data.html += jQuery( '#excerpt' ).val() + "\n"
+ jQuery( '.editor-post-excerpt__textarea textarea').val() + "\n"
+ jQuery( '#my_custom_fields' ).val();
} )
} );
`
Note that if you have previously defined constant `SWA_SEMRUSH_CUSTOM_FIELDS_PLUGIN_AUTOENABLE` to `true`,
you don't have to create new `SeoWritingAssistantSEMrushCustomFields` object.
= JavaScript API =
**`setHtml()`**
The following example will update programmatically the text used by SEMrush check with an arbitrary value:
`
jQuery( document ).ready( function() {
var swa = new SeoWritingAssistantSEMrushCustomFields( { interval: 0 } );
swa.setHtml( 'foo baz bar' );
} );
`
= Advanced Custom Fields =
The plugin checks if _Advanced Custom Fields_ is active in your WordPress instance and adds a custom setting to each field
(only for `input` within _text_, _radio_ and _checkbox_ type, `textarea` and `select` elements) allowing you to add his value
to SEMrush check without having to write any additional JavaScript code.
= Autodiscovery =
The plugin also automatically add to text used by SEMrush checks, the values of all HTML elements
with `swa-scf` class or `data-swa-scf` attribute.
This will applied only for `input` (within _text_, _radio_ and _checkbox_ type), `textarea`, and `select` elements.
== Frequently Asked Questions ==
= Does it work with Gutenberg? =
Yes.
== Screenshots ==
1. The Advanced Custom Fields custom setting.
== Changelog ==
For SEO Writing Assistant SEMrush Custom Fields changelog, please see [the Releases page on GitHub](https://github.com/enrico-sorcinelli/seo-writing-assistant-semrush-custom-fields/releases).
== Upgrade Notice ==
= 1.1.0 =
Added support for Advanced Custom Fields; added autoenabling and autodiscovery field feature.