1 | <?php |
||||
2 | /** |
||||
3 | * @author Podlove <[email protected]> |
||||
4 | * @copyright Copyright (c) 2014-2018, Podlove |
||||
5 | * @license https://github.com/podlove/podlove-subscribe-button-wp-plugin/blob/master/LICENSE MIT |
||||
6 | * @package Podlove\PodloveSubscribeButton |
||||
7 | * @version 1.4.0-beta |
||||
8 | */ |
||||
9 | |||||
10 | /** |
||||
11 | * Plugin Name: Podlove Subscribe Button |
||||
12 | * Plugin URI: https://wordpress.org/plugins/podlove-subscribe-button/ |
||||
13 | * Description: Brings the Podlove Subscribe Button to your WordPress installation. |
||||
14 | * Version: 1.4.0-beta |
||||
15 | * Author: Podlove |
||||
16 | * Author URI: https://podlove.org/ |
||||
17 | * License: MIT |
||||
18 | * License URI: license.txt |
||||
19 | * Text Domain: podlove-subscribe-button |
||||
20 | */ |
||||
21 | |||||
22 | /** Check if PHP version is sufficient */ |
||||
23 | if ( ! version_compare( phpversion(), '5.4', ">=" ) ) { |
||||
0 ignored issues
–
show
|
|||||
24 | |||||
25 | function podlove_psb_php_notice() { |
||||
0 ignored issues
–
show
|
|||||
26 | ?> |
||||
27 | <div id="message" class="error"> |
||||
28 | <p> |
||||
29 | <strong>The Podlove Subscribe Button Plugin could not be activated</strong> |
||||
30 | </p> |
||||
31 | <p> |
||||
32 | The Podlove Subscribe Button Plugin requires <code>PHP 5.3</code> or higher.<br> |
||||
33 | You are running <code>PHP <?php echo phpversion(); ?></code>.<br> |
||||
34 | Please ask your hoster how to upgrade to an up-to-date PHP version. |
||||
35 | </p> |
||||
36 | </div> |
||||
37 | <?php |
||||
38 | } |
||||
39 | |||||
40 | function podlove_psb_deactivate() { |
||||
0 ignored issues
–
show
|
|||||
41 | deactivate_plugins( plugin_basename( __FILE__ ) ); |
||||
42 | } |
||||
43 | |||||
44 | add_action( 'admin_notices', 'podlove_psb_php_notice' ); |
||||
45 | add_action( 'admin_init', 'podlove_psb_deactivate' ); |
||||
46 | |||||
47 | return; |
||||
48 | |||||
49 | } |
||||
50 | |||||
51 | require_once __DIR__ . '/vendor/autoload.php'; |
||||
52 | |||||
53 | register_activation_hook( __FILE__, array( 'PodloveSubscribeButton\Setup', 'activation' ) ); |
||||
54 | register_uninstall_hook( __FILE__, array( 'PodloveSubscribeButton\Setup', 'uninstall' ) ); |
||||
55 | |||||
56 | PodloveSubscribeButton\Migration::eval_db(); |
||||
57 | PodloveSubscribeButton::run(); |
||||
58 | |||||
59 | /** |
||||
60 | * Class PodloveSubscribeButton |
||||
61 | */ |
||||
62 | class PodloveSubscribeButton { |
||||
63 | |||||
64 | /** |
||||
0 ignored issues
–
show
|
|||||
65 | * @var string current plugin version |
||||
66 | */ |
||||
67 | public static $version = '1.4.0-beta'; |
||||
68 | |||||
69 | public static function run() { |
||||
70 | |||||
71 | add_action( 'plugins_loaded', array( __CLASS__, 'load_translations' ) ); |
||||
72 | add_action( 'init', array( __CLASS__, 'register_shortcode' ) ); |
||||
73 | add_action( 'admin_init', array( 'PodloveSubscribeButton\Options', 'register_settings' ) ); |
||||
74 | add_action( 'admin_init', array( 'PodloveSubscribeButton\Settings\Buttons', 'process_form' ) ); |
||||
75 | add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_assets' ) ); |
||||
76 | add_action( 'widgets_init', array( __CLASS__, 'widgets' ) ); |
||||
77 | add_action( 'network_admin_edit_podlove_psb_update_network_options', array( 'PodloveSubscribeButton\Settings\Buttons', 'podlove_psb_update_network_options' ) ); |
||||
78 | |||||
79 | if ( is_multisite() ) { |
||||
80 | add_filter( 'podlove_psb_defaults_options', array( __CLASS__, 'get_network_defaults' ) ); |
||||
81 | } |
||||
82 | |||||
83 | self::menu(); |
||||
84 | |||||
85 | } |
||||
86 | |||||
87 | public static function get_network_defaults( $options ) { |
||||
0 ignored issues
–
show
The parameter
$options is not used and could be removed.
(
Ignorable by Annotation
)
If this is a false-positive, you can also ignore this issue in your code via the
This check looks for parameters that have been defined for a function or method, but which are not used in the method body. ![]() |
|||||
88 | $network_defaults = get_site_option( 'podlove_psb_defaults' ); |
||||
89 | |||||
90 | return $network_defaults; |
||||
91 | } |
||||
92 | |||||
93 | public static function widgets() { |
||||
0 ignored issues
–
show
|
|||||
94 | register_widget( '\PodloveSubscribeButton\Widget' ); |
||||
95 | |||||
96 | } |
||||
97 | |||||
98 | public static function menu() { |
||||
0 ignored issues
–
show
|
|||||
99 | add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu' ) ); |
||||
100 | |||||
101 | if ( is_network_admin() ) { |
||||
102 | add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu' ) ); |
||||
103 | } |
||||
104 | |||||
105 | } |
||||
106 | |||||
107 | public static function enqueue_assets( $hook ) { |
||||
108 | |||||
109 | $pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' ); |
||||
110 | |||||
111 | if ( ! in_array( $hook, $pages ) ) { |
||||
112 | return; |
||||
113 | } |
||||
114 | |||||
115 | add_action( 'admin_print_footer_scripts', array( __CLASS__, 'admin_inline_js' ) ); |
||||
116 | |||||
117 | $suffix = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min'; |
||||
118 | |||||
119 | // CSS Stylesheet |
||||
120 | wp_register_style( 'podlove-subscribe-button', \PodloveSubscribeButton\Helpers::get_url( '' ) . 'css/style.css', false, self::$version ); |
||||
0 ignored issues
–
show
false of type false is incompatible with the type array expected by parameter $deps of wp_register_style() .
(
Ignorable by Annotation
)
If this is a false-positive, you can also ignore this issue in your code via the
![]() |
|||||
121 | wp_enqueue_style( 'podlove-subscribe-button' ); |
||||
122 | |||||
123 | // Clipboard.js |
||||
124 | wp_register_script( 'clipboard.js', \PodloveSubscribeButton\Helpers::get_url( '' ) . "js/clipboard{$suffix}.js", array(), '2.0.1' ); |
||||
125 | wp_enqueue_script( 'clipboard.js' ); |
||||
126 | |||||
127 | // Admin JS |
||||
128 | wp_enqueue_style( 'wp-color-picker' ); |
||||
129 | wp_register_script( 'podlove-subscribe-button-admin-tools', \PodloveSubscribeButton\Helpers::get_url( '' ) . 'js/admin.js', array( 'jquery', 'wp-color-picker' ), self::$version ); |
||||
0 ignored issues
–
show
|
|||||
130 | $js_translations = array( |
||||
131 | 'media_library' => __( 'Media Library', 'podlove-subscribe-button' ), |
||||
132 | 'use_for' => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ), |
||||
133 | ); |
||||
134 | wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations ); |
||||
135 | wp_enqueue_script( 'podlove-subscribe-button-admin-tools' ); |
||||
136 | |||||
137 | } |
||||
138 | |||||
139 | public static function admin_inline_js() { |
||||
0 ignored issues
–
show
|
|||||
140 | echo "<script type=\"text/javascript\">var clipboard = new ClipboardJS('.copy-btn');</script>"; |
||||
141 | } |
||||
142 | |||||
143 | public static function admin_menu() { |
||||
144 | add_options_page( |
||||
145 | __( 'Podlove Subscribe Button Options', 'podlove-subscribe-button' ), |
||||
146 | __( 'Podlove Subscribe Button', 'podlove-subscribe-button' ), |
||||
147 | 'manage_options', |
||||
148 | 'podlove-subscribe-button', |
||||
149 | array( 'PodloveSubscribeButton\Settings\Buttons', 'page' ) |
||||
150 | ); |
||||
151 | |||||
152 | } |
||||
153 | |||||
154 | public static function admin_network_menu() { |
||||
155 | add_submenu_page( |
||||
156 | 'settings.php', |
||||
157 | __( 'Podlove Subscribe Button Options', 'podlove-subscribe-button' ), |
||||
158 | __( 'Podlove Subscribe Button', 'podlove-subscribe-button' ), |
||||
159 | 'manage_options', |
||||
160 | 'podlove-subscribe-button', |
||||
161 | array( 'PodloveSubscribeButton\Settings\Buttons', 'page' ) |
||||
162 | ); |
||||
163 | |||||
164 | } |
||||
165 | |||||
166 | public static function load_translations() { |
||||
0 ignored issues
–
show
|
|||||
167 | load_plugin_textdomain( 'podlove-subscribe-button' ); |
||||
168 | |||||
169 | } |
||||
170 | |||||
171 | /** |
||||
0 ignored issues
–
show
|
|||||
172 | * Get value from the associative array of the plugin defaults option |
||||
173 | * |
||||
174 | * @param $key |
||||
0 ignored issues
–
show
|
|||||
175 | * @param bool $default |
||||
176 | * |
||||
177 | * @return string|bool |
||||
178 | */ |
||||
179 | public static function get_option( $key, $default = false ) { |
||||
0 ignored issues
–
show
|
|||||
180 | |||||
181 | $options = \get_option( 'podlove_psb_defaults' ); |
||||
182 | |||||
183 | if ( array_key_exists( $key, $options ) ) { |
||||
0 ignored issues
–
show
It seems like
$options can also be of type false ; however, parameter $search of array_key_exists() does only seem to accept array , maybe add an additional type check?
(
Ignorable by Annotation
)
If this is a false-positive, you can also ignore this issue in your code via the
![]() |
|||||
184 | return $options[ $key ]; |
||||
185 | } |
||||
186 | |||||
187 | return $default; |
||||
188 | } // END get_option() |
||||
189 | |||||
190 | public static function register_shortcode() { |
||||
0 ignored issues
–
show
|
|||||
191 | add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) ); |
||||
192 | } |
||||
193 | |||||
194 | /** |
||||
0 ignored issues
–
show
|
|||||
195 | * Add the shortcode |
||||
196 | * |
||||
197 | * @param $args |
||||
0 ignored issues
–
show
|
|||||
198 | * |
||||
199 | * @return string|void |
||||
200 | */ |
||||
201 | public static function shortcode( $args ) { |
||||
202 | if ( ! $args || ! isset( $args['button'] ) ) { |
||||
203 | return __( 'You need to create a Button first and provide its ID.', 'podlove-subscribe-button' ); |
||||
204 | } else { |
||||
205 | $buttonid = $args['button']; |
||||
206 | } |
||||
207 | |||||
208 | // Fetch the (network)button by it's name |
||||
209 | if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name( $args['button'] ) ) { |
||||
0 ignored issues
–
show
|
|||||
210 | return sprintf( __( 'Oops. There is no button with the ID "%s".', 'podlove-subscribe-button' ), $args['button'] ); |
||||
211 | } |
||||
212 | |||||
213 | // Get button styling and options |
||||
214 | $autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback( $args, 'width' ) ); |
||||
215 | $size = self::get_attribute( 'size', self::get_array_value_with_fallback( $args, 'size' ) ); |
||||
216 | $style = self::get_attribute( 'style', self::get_array_value_with_fallback( $args, 'style' ) ); |
||||
217 | $format = self::get_attribute( 'format', self::get_array_value_with_fallback( $args, 'format' ) ); |
||||
218 | |||||
219 | if ( isset( $args['language'] ) ) { |
||||
220 | $language = $args['language']; |
||||
221 | } else { |
||||
222 | $language = self::get_attribute( 'language', self::get_array_value_with_fallback( $args, 'language' ) ); |
||||
223 | } |
||||
224 | |||||
225 | if ( isset( $args['color'] ) ) { |
||||
226 | $color = $args['color']; |
||||
227 | } else { |
||||
228 | $color = self::get_attribute( 'color', self::get_array_value_with_fallback( $args, 'color' ) ); |
||||
229 | } |
||||
230 | |||||
231 | if ( isset( $args['hide'] ) && $args['hide'] == 'true' ) { |
||||
232 | $hide = true; |
||||
233 | } else { |
||||
234 | $hide = false; |
||||
235 | } |
||||
236 | |||||
237 | // Render button |
||||
238 | return $button->render( $size, $autowidth, $style, $format, $color, $hide, $buttonid, $language ); |
||||
239 | |||||
240 | } |
||||
241 | |||||
242 | public static function get_array_value_with_fallback( $args, $key ) { |
||||
243 | if ( isset( $args[ $key ] ) ) { |
||||
244 | return $args[ $key ]; |
||||
245 | } |
||||
246 | |||||
247 | return false; |
||||
248 | |||||
249 | } |
||||
250 | |||||
251 | /** |
||||
0 ignored issues
–
show
|
|||||
252 | * @param string $attribute |
||||
253 | * @param string $attribute_value |
||||
254 | * |
||||
255 | * @return string |
||||
256 | */ |
||||
257 | private static function get_attribute( $attribute = null, $attribute_value = null ) { |
||||
258 | if ( isset( $attribute_value ) && ctype_alnum( $attribute_value ) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) { |
||||
259 | return $attribute_value; |
||||
260 | } else { |
||||
261 | $default = get_option( 'podlove_psb_defaults', \PodloveSubscribeButton\Defaults::options() ); |
||||
262 | |||||
263 | return $default[ $attribute ]; |
||||
264 | } |
||||
265 | |||||
266 | } |
||||
267 | |||||
268 | /** |
||||
269 | * Interprets the provided width attribute and return either auto- or a specific width |
||||
270 | * |
||||
271 | * @param string $width_attribute |
||||
0 ignored issues
–
show
|
|||||
272 | * |
||||
273 | * @return string |
||||
274 | */ |
||||
275 | private static function interpret_width_attribute( $width_attribute = null ) { |
||||
276 | if ( $width_attribute == 'auto' ) { |
||||
277 | return 'on'; |
||||
278 | } |
||||
279 | |||||
280 | if ( $width_attribute && $width_attribute !== 'auto' ) { |
||||
281 | return 'off'; |
||||
282 | } |
||||
283 | |||||
284 | return self::get_option( 'autowidth', 'on' ); |
||||
0 ignored issues
–
show
'on' of type string is incompatible with the type boolean expected by parameter $default of PodloveSubscribeButton::get_option() .
(
Ignorable by Annotation
)
If this is a false-positive, you can also ignore this issue in your code via the
![]() |
|||||
285 | |||||
286 | } |
||||
287 | |||||
288 | public static function plugin_file() { |
||||
0 ignored issues
–
show
|
|||||
289 | return __FILE__; |
||||
290 | } |
||||
291 | |||||
292 | } // END class |
||||
293 |
PHP provides two ways to mark string literals. Either with single quotes
'literal'
or with double quotes"literal"
. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (
\'
) and the backslash (\\
). Every other character is displayed as is.Double quoted string literals may contain other variables or more complex escape sequences.
will print an indented:
Single is Value
If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.
For more information on PHP string literals and available escape sequences see the PHP core documentation.