README.md 7.42 KB
Newer Older
Lester Chan's avatar
EOL    
Lester Chan committed
1
# WP-Polls
Lester Chan's avatar
Lester Chan committed
2
Contributors: GamerZ  
Lester Chan's avatar
Lester Chan committed
3
Donate link: https://lesterchan.net/site/donation/  
Lester Chan's avatar
Lester Chan committed
4
Tags: poll, polls, polling, vote, booth, democracy, ajax, survey, post, widget  
5
Requires at least: 4.9.6  
Lester Chan's avatar
Lester Chan committed
6
Tested up to: 4.9  
7
Stable tag: 2.74
Lester Chan's avatar
EOL    
Lester Chan committed
8
9
10
11
12
13

Adds an AJAX poll system to your WordPress blog. You can also easily add a poll into your WordPress's blog post/page.

## Description
WP-Polls is extremely customizable via templates and css styles and there are tons of options for you to choose to ensure that WP-Polls runs the way you wanted. It now supports multiple selection of answers.

Lester Chan's avatar
Lester Chan committed
14
15
16
### Build Status
[![Build Status](https://travis-ci.org/lesterchan/wp-polls.svg?branch=master)](https://travis-ci.org/lesterchan/wp-polls)

Lester Chan's avatar
EOL    
Lester Chan committed
17
### Development
Lester Chan's avatar
Lester Chan committed
18
[https://github.com/lesterchan/wp-polls](https://github.com/lesterchan/wp-polls "https://github.com/lesterchan/wp-polls")
Lester Chan's avatar
EOL    
Lester Chan committed
19
20

### Credits
Lester Chan's avatar
Lester Chan committed
21
* Plugin icon by [Freepik](http://www.freepik.com) from [Flaticon](http://www.flaticon.com)
Lester Chan's avatar
EOL    
Lester Chan committed
22
23

### Donations
Lester's avatar
-m    
Lester committed
24
I spent most of my free time creating, updating, maintaining and supporting these plugins, if you really love my plugins and could spare me a couple of bucks, I will really appreciate it. If not feel free to use it without any obligations.
Lester Chan's avatar
EOL    
Lester Chan committed
25
26

## Changelog
27
### Version 2.74
Lester Chan's avatar
Lester Chan committed
28
* NEW: Hashed IP and anonymize Hostname to make it GDPR compliance
29
* NEW: If Do Not Log is set in Poll Options, do not log to DB
30

Lester Chan's avatar
Bump    
Lester Chan committed
31
32
33
34
### Version 2.73.8
* FIXED: Bug fixes and stricter type checking

### Version 2.73.7
Lester Chan's avatar
Lester Chan committed
35
36
* FIXED: Unable to save input HTML tags for footer templates

Lester Chan's avatar
Lester Chan committed
37
38
### Version 2.73.6
* FIXED: Unable to vote for multiple answers
39
* FIXED: input HTML tags being removed when saving templates
Lester Chan's avatar
Lester Chan committed
40

Lester Chan's avatar
Lester Chan committed
41
42
43
### Version 2.73.5
* FIXED: Parsed error in SERVER variable.

44
45
46
### Version 2.73.4
* FIXED: sanitize_key on top of intval.

47
### Version 2.73.3
48
* NEW: Added sort by votes casted to poll answers.
Lester Chan's avatar
Lester Chan committed
49
* NEW: For polls with mutiple answers, we divided by total votes instead of total voters. Props @ljxprime.
50
* FIXED: Do not display poll option is not respected when poll is closed.
51
52
* FIXED: pollip_qid, pollip_aid, pollip_timestamp are now int(10) in pollsip table.
* FIXED: pollq_expiry is now int(10) in pollsq table.
Lester Chan's avatar
Lester Chan committed
53

Lester Chan's avatar
Lester Chan committed
54
### Version 2.73.2
Lester Chan's avatar
Lester Chan committed
55
* NEW: Bump WordPress 4.7
Lester Chan's avatar
Lester Chan committed
56
57
* FIXED: Change cron to hourly instead of twice daily.

Lester Chan's avatar
Lester Chan committed
58
59
### Version 2.73.1
* FIXED: Allow local IP
Lester's avatar
Lester committed
60
61
* FIXED: XSS on Poll bar option. Props [Netsparker Web Application Security Scanner](https://www.netsparker.com/)
* FIXED: Stricter Poll pptions check
Lester Chan's avatar
Lester Chan committed
62
 
Lester's avatar
Lester committed
63
64
65
66
### Version 2.73
* NEW: Display Poll Questions at the top of the Poll Logs table
* FIXED: Remove slashes

67
68
69
70
### Version 2.72
* NEW: Use translate.wordpress.org to translate the plugin
* FIXED: SQL Injection fixes. Props [Jay Dansand](https://github.com/jaydansand)
* FIXED: Use $wpdb->insert(), $wpdb->update() and $wpdb->delete() as much as possible
Lester's avatar
Lester committed
71
* FIXED Remove poll_archive_show option from UI
72

Lester's avatar
Lester committed
73
### Version 2.71
Lester's avatar
Lester committed
74
* FIXED: Use wp_kses_post() to get filter always bad tags
Lester's avatar
Lester committed
75

76
### Version 2.70
77
* NEW: Add wp_polls_vote_poll_success action hook
Lester's avatar
Lester committed
78
79
80
* NEW: Add wp_polls_add_poll, wp_polls_update_poll, wp_polls_delete_poll action hooks
* FIXED: PHP Notices
* FIXED: Removed not needed wp_print_scripts
Lester's avatar
Lester committed
81
* FIXED: Use esc_attr() and esc_textarea() instead of htmlspecialchars(). Props [Govind Singh](https://in.linkedin.com/pub/govind-singh/21/1a9/bab)
82

Lester Chan's avatar
EOL    
Lester Chan committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
## Screenshots

1. Admin - All Poll
2. Admin - Manage Polls
3. Admin - Poll Options
4. Admin - Poll Templates
5. Admin - Poll Widget
6. Admin - Uninstall Poll
7. Poll - Single Poll Answer
8. Poll - Mutiple Poll Answers
9. Poll - Results
10. Poll - Archive

## Frequently Asked Questions
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

### General Usage (Without Widget)

```php
<?php if ( function_exists( 'vote_poll' ) && ! in_pollarchive() ): ?>
	<li>
		<h2>Polls</h2>
		<ul>
			<li><?php get_poll();?></li>
		</ul>
		<?php display_polls_archive_link(); ?>
	</li>
<?php endif; ?>
```

* To show specific poll, use `<?php get_poll(2); ?>` where 2 is your poll id.
* To show random poll, use `<?php get_poll(-2); ?>`
* To embed a specific poll in your post, use `[poll id="2"]` where 2 is your poll id.
* To embed a random poll in your post, use `[poll id="-2"]`
* To embed a specific poll's result in your post, use `[poll id="2" type="result"]` where 2 is your poll id.

### General Usage (With Widget)
1. Go to `WP-Admin -> Appearance -> Widgets`.
2. You can add the Polls Widget by clicking on the 'Add' link besides it.
3. After adding, you can configure the Polls Widget by clicking on the 'Edit' link besides it.
4. Click 'Save Changes'.
5. Scroll down for instructions on how to create a Polls Archive.

Lester Chan's avatar
EOL    
Lester Chan committed
125
126
127
128
129
130
131
132
133
134
### How To Add A Polls Archive?
1. Go to `WP-Admin -> Pages -> Add New`.
2. Type any title you like in the post's title area.
3. If you ARE  using nice permalinks,  after typing the title, WordPress will generate the permalink to the page. You will see an 'Edit' link just beside the permalink.
4. Click 'Edit' and type in `pollsarchive` in the text field and click 'Save'.
5. Type `[page_polls]` in the post's content area.
6. Click 'Publish'.

* If you ARE NOT using nice permalinks, you need to go to `WP-Admin -> Polls -> Poll Options` and under `Poll Archive -> Polls Archive URL`, you need to fill in the URL to the Polls Archive Page you created above.

135
### Why doesn't my poll's answers add up to 100%?
Lester Chan's avatar
Add ;    
Lester Chan committed
136
* It is because of rounding issues. To make it always round up to 100%, the last poll's answer will get the remainding percentage added to it. To enable this feature, add this to your theme's functions.php: `add_filter( 'wp_polls_round_percentage', '__return_true' );`
137

Lester Chan's avatar
EOL    
Lester Chan committed
138
### How Does WP-Polls Load CSS?
Lester Chan's avatar
Lester Chan committed
139
140
* WP-Polls will load `polls-css.css` from your theme's directory if it exists.
* If it doesn't exists, it will just load the default `polls-css.css` that comes with WP-Polls.
Lester Chan's avatar
EOL    
Lester Chan committed
141
142
143
144
145
146
147
148
149
150
151
152
* This will allow you to upgrade WP-Polls without worrying about overwriting your polls styles that you have created.

### Why In Internet Explorer (IE) The poll's Text Appear Jagged?
* To solve this issue, Open poll-css.css
* Find: `/* background-color: #ffffff; */`
* Replace: `background-color: #ffffff;` (where #ffffff should be your background color for the poll.)

### How Do I Have Individual Colors For Each Poll's Bar?
* Courtesy Of [TreedBox.com](http://treedbox.com "TreedBox.com")
* Open poll-css.css
* Add to the end of the file:

Lester Chan's avatar
Lester Chan committed
153
```
Lester Chan's avatar
Lester Chan committed
154
155
156
157
158
159
160
161
162
163
164
.wp-polls-ul li:nth-child(01) .pollbar{ background:#8FA0C5}
.wp-polls-ul li:nth-child(02) .pollbar{ background:#FF8}
.wp-polls-ul li:nth-child(03) .pollbar{ background:#ff8a3b}
.wp-polls-ul li:nth-child(04) .pollbar{ background:#a61e2a}
.wp-polls-ul li:nth-child(05) .pollbar{ background:#4ebbff}
.wp-polls-ul li:nth-child(06) .pollbar{ background:#fbca54}
.wp-polls-ul li:nth-child(07) .pollbar{ background:#aad34f}
.wp-polls-ul li:nth-child(08) .pollbar{ background:#66cc9a}
.wp-polls-ul li:nth-child(09) .pollbar{ background:#98CBCB}
.wp-polls-ul li:nth-child(10) .pollbar{ background:#a67c52}
.wp-polls-ul li .pollbar{ transition: background 0.7s ease-in-out }
Lester Chan's avatar
Lester Chan committed
165
.wp-polls-ul li .pollbar:hover{ background:#F00 }
Lester Chan's avatar
Lester Chan committed
166
```
Lester Chan's avatar
EOL    
Lester Chan committed
167
168

### To Display Total Polls
Lester Chan's avatar
Lester Chan committed
169

Lester Chan's avatar
Lester Chan committed
170
```php
Lester Chan's avatar
Lester Chan committed
171
172
173
<?php if ( function_exists( 'get_pollquestions' ) ): ?>
	<?php get_pollquestions(); ?>
<?php endif; ?> 
Lester Chan's avatar
Lester Chan committed
174
```
Lester Chan's avatar
Lester Chan committed
175
 
Lester Chan's avatar
EOL    
Lester Chan committed
176
### To Display Total Poll Answers
Lester Chan's avatar
Lester Chan committed
177

Lester Chan's avatar
Lester Chan committed
178
```php
Lester Chan's avatar
Lester Chan committed
179
180
181
182
<?php if ( function_exists( 'get_pollanswers' ) ): ?>
	<?php get_pollanswers(); ?>
<?php endif; ?> 
```
Lester Chan's avatar
Lester Chan committed
183
 
Lester Chan's avatar
EOL    
Lester Chan committed
184
### To Display Total Poll Votes
Lester Chan's avatar
Lester Chan committed
185

Lester Chan's avatar
Lester Chan committed
186
```php
Lester Chan's avatar
Lester Chan committed
187
188
189
190
<?php if ( function_exists( 'get_pollvotes' ) ): ?>
	<?php get_pollvotes(); ?>
<?php endif; ?> 
```
Lester Chan's avatar
Lester Chan committed
191
 
Lester Chan's avatar
EOL    
Lester Chan committed
192
### To Display Total Poll Voters
Lester Chan's avatar
Lester Chan committed
193

Lester Chan's avatar
Lester Chan committed
194
```php
Lester Chan's avatar
Lester Chan committed
195
196
197
198
<?php if ( function_exists( 'get_pollvoters' ) ): ?>
	<?php get_pollvoters(); ?>
<?php endif; ?> 
```