1<?php
2/**
3 * WordPress Plugin Install Administration API
4 *
5 * @package WordPress
6 * @subpackage Administration
7 */
8
9/**
10 * Retrieves plugin installer pages from the WordPress.org Plugins API.
11 *
12 * It is possible for a plugin to override the Plugin API result with three
13 * filters. Assume this is for plugins, which can extend on the Plugin Info to
14 * offer more choices. This is very powerful and must be used with care when
15 * overriding the filters.
16 *
17 * The first filter, {@see 'plugins_api_args'}, is for the args and gives the action
18 * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that
19 * an object is returned.
20 *
21 * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
22 * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information',
23 * an object MUST be passed. If `$action` is 'hot_tags', an array MUST be passed.
24 *
25 * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the
26 * response object or array, depending on the `$action` type.
27 *
28 * Supported arguments per action:
29 *
30 * | Argument Name | query_plugins | plugin_information | hot_tags |
31 * | -------------------- | :-----------: | :----------------: | :------: |
32 * | `$slug` | No | Yes | No |
33 * | `$per_page` | Yes | No | No |
34 * | `$page` | Yes | No | No |
35 * | `$number` | No | No | Yes |
36 * | `$search` | Yes | No | No |
37 * | `$tag` | Yes | No | No |
38 * | `$author` | Yes | No | No |
39 * | `$user` | Yes | No | No |
40 * | `$browse` | Yes | No | No |
41 * | `$locale` | Yes | Yes | No |
42 * | `$installed_plugins` | Yes | No | No |
43 * | `$is_ssl` | Yes | Yes | No |
44 * | `$fields` | Yes | Yes | No |
45 *
46 * @since 2.7.0
47 *
48 * @param string $action API action to perform: 'query_plugins', 'plugin_information',
49 * or 'hot_tags'.
50 * @param array|object $args {
51 * Optional. Array or object of arguments to serialize for the Plugin Info API.
52 *
53 * @type string $slug The plugin slug. Default empty.
54 * @type int $per_page Number of plugins per page. Default 24.
55 * @type int $page Number of current page. Default 1.
56 * @type int $number Number of tags or categories to be queried.
57 * @type string $search A search term. Default empty.
58 * @type string $tag Tag to filter plugins. Default empty.
59 * @type string $author Username of an plugin author to filter plugins. Default empty.
60 * @type string $user Username to query for their favorites. Default empty.
61 * @type string $browse Browse view: 'popular', 'new', 'beta', 'recommended'.
62 * @type string $locale Locale to provide context-sensitive results. Default is the value
63 * of get_locale().
64 * @type string $installed_plugins Installed plugins to provide context-sensitive results.
65 * @type bool $is_ssl Whether links should be returned with https or not. Default false.
66 * @type array $fields {
67 * Array of fields which should or should not be returned.
68 *
69 * @type bool $short_description Whether to return the plugin short description. Default true.
70 * @type bool $description Whether to return the plugin full description. Default false.
71 * @type bool $sections Whether to return the plugin readme sections: description, installation,
72 * FAQ, screenshots, other notes, and changelog. Default false.
73 * @type bool $tested Whether to return the 'Compatible up to' value. Default true.
74 * @type bool $requires Whether to return the required WordPress version. Default true.
75 * @type bool $requires_php Whether to return the required PHP version. Default true.
76 * @type bool $rating Whether to return the rating in percent and total number of ratings.
77 * Default true.
78 * @type bool $ratings Whether to return the number of rating for each star (1-5). Default true.
79 * @type bool $downloaded Whether to return the download count. Default true.
80 * @type bool $downloadlink Whether to return the download link for the package. Default true.
81 * @type bool $last_updated Whether to return the date of the last update. Default true.
82 * @type bool $added Whether to return the date when the plugin was added to the wordpress.org
83 * repository. Default true.
84 * @type bool $tags Whether to return the assigned tags. Default true.
85 * @type bool $compatibility Whether to return the WordPress compatibility list. Default true.
86 * @type bool $homepage Whether to return the plugin homepage link. Default true.
87 * @type bool $versions Whether to return the list of all available versions. Default false.
88 * @type bool $donate_link Whether to return the donation link. Default true.
89 * @type bool $reviews Whether to return the plugin reviews. Default false.
90 * @type bool $banners Whether to return the banner images links. Default false.
91 * @type bool $icons Whether to return the icon links. Default false.
92 * @type bool $active_installs Whether to return the number of active installations. Default false.
93 * @type bool $contributors Whether to return the list of contributors. Default false.
94 * }
95 * }
96 * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the
97 * {@link https://developer.wordpress.org/reference/functions/plugins_api/ function reference article}
98 * for more information on the make-up of possible return values depending on the value of `$action`.
99 */
100function plugins_api( $action, $args = array() ) {
101 if ( is_array( $args ) ) {
102 $args = (object) $args;
103 }
104
105 if ( 'query_plugins' === $action ) {
106 if ( ! isset( $args->per_page ) ) {
107 $args->per_page = 24;
108 }
109 }
110
111 if ( ! isset( $args->locale ) ) {
112 $args->locale = get_user_locale();
113 }
114
115 if ( ! isset( $args->wp_version ) ) {
116 $args->wp_version = substr( wp_get_wp_version(), 0, 3 ); // x.y
117 }
118
119 /**
120 * Filters the WordPress.org Plugin Installation API arguments.
121 *
122 * Important: An object MUST be returned to this filter.
123 *
124 * @since 2.7.0
125 *
126 * @param object $args Plugin API arguments.
127 * @param string $action The type of information being requested from the Plugin Installation API.
128 */
129 $args = apply_filters( 'plugins_api_args', $args, $action );
130
131 /**
132 * Filters the response for the current WordPress.org Plugin Installation API request.
133 *
134 * Returning a non-false value will effectively short-circuit the WordPress.org API request.
135 *
136 * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.
137 * If `$action` is 'hot_tags', an array should be passed.
138 *
139 * @since 2.7.0
140 *
141 * @param false|object|array $result The result object or array. Default false.
142 * @param string $action The type of information being requested from the Plugin Installation API.
143 * @param object $args Plugin API arguments.
144 */
145 $res = apply_filters( 'plugins_api', false, $action, $args );
146
147 if ( false === $res ) {
148
149 $url = 'http://api.wordpress.org/plugins/info/1.2/';
150 $url = add_query_arg(
151 array(
152 'action' => $action,
153 'request' => $args,
154 ),
155 $url
156 );
157
158 $http_url = $url;
159 $ssl = wp_http_supports( array( 'ssl' ) );
160 if ( $ssl ) {
161 $url = set_url_scheme( $url, 'https' );
162 }
163
164 $http_args = array(
165 'timeout' => 15,
166 'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ),
167 );
168 $request = wp_remote_get( $url, $http_args );
169
170 if ( $ssl && is_wp_error( $request ) ) {
171 if ( ! wp_is_json_request() ) {
172 wp_trigger_error(
173 __FUNCTION__,
174 sprintf(
175 /* translators: %s: Support forums URL. */
176 __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
177 __( 'https://wordpress.org/support/forums/' )
178 ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),
179 headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
180 );
181 }
182
183 $request = wp_remote_get( $http_url, $http_args );
184 }
185
186 if ( is_wp_error( $request ) ) {
187 $res = new WP_Error(
188 'plugins_api_failed',
189 sprintf(
190 /* translators: %s: Support forums URL. */
191 __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
192 __( 'https://wordpress.org/support/forums/' )
193 ),
194 $request->get_error_message()
195 );
196 } else {
197 $res = json_decode( wp_remote_retrieve_body( $request ), true );
198 if ( is_array( $res ) ) {
199 // Object casting is required in order to match the info/1.0 format.
200 $res = (object) $res;
201 } elseif ( null === $res ) {
202 $res = new WP_Error(
203 'plugins_api_failed',
204 sprintf(
205 /* translators: %s: Support forums URL. */
206 __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
207 __( 'https://wordpress.org/support/forums/' )
208 ),
209 wp_remote_retrieve_body( $request )
210 );
211 }
212
213 if ( isset( $res->error ) ) {
214 $res = new WP_Error( 'plugins_api_failed', $res->error );
215 }
216 }
217 } elseif ( ! is_wp_error( $res ) ) {
218 $res->external = true;
219 }
220
221 /**
222 * Filters the Plugin Installation API response results.
223 *
224 * @since 2.7.0
225 *
226 * @param object|WP_Error $res Response object or WP_Error.
227 * @param string $action The type of information being requested from the Plugin Installation API.
228 * @param object $args Plugin API arguments.
229 */
230 return apply_filters( 'plugins_api_result', $res, $action, $args );
231}
232
233/**
234 * Retrieves popular WordPress plugin tags.
235 *
236 * @since 2.7.0
237 *
238 * @param array $args
239 * @return array|WP_Error
240 */
241function install_popular_tags( $args = array() ) {
242 $key = md5( serialize( $args ) );
243 $tags = get_site_transient( 'poptags_' . $key );
244 if ( false !== $tags ) {
245 return $tags;
246 }
247
248 $tags = plugins_api( 'hot_tags', $args );
249
250 if ( is_wp_error( $tags ) ) {
251 return $tags;
252 }
253
254 set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
255
256 return $tags;
257}
258
259/**
260 * Displays the Featured tab of Add Plugins screen.
261 *
262 * @since 2.7.0
263 */
264function install_dashboard() {
265 display_plugins_table();
266 ?>
267
268 <div class="plugins-popular-tags-wrapper">
269 <h2><?php _e( 'Popular tags' ); ?></h2>
270 <p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ); ?></p>
271 <?php
272
273 $api_tags = install_popular_tags();
274
275 echo '<p class="popular-tags">';
276 if ( is_wp_error( $api_tags ) ) {
277 echo $api_tags->get_error_message();
278 } else {
279 // Set up the tags in a way which can be interpreted by wp_generate_tag_cloud().
280 $tags = array();
281 foreach ( (array) $api_tags as $tag ) {
282 $url = self_admin_url( 'plugin-install.php?tab=search&type=tag&s=' . urlencode( $tag['name'] ) );
283 $data = array(
284 'link' => esc_url( $url ),
285 'name' => $tag['name'],
286 'slug' => $tag['slug'],
287 'id' => sanitize_title_with_dashes( $tag['name'] ),
288 'count' => $tag['count'],
289 );
290 $tags[ $tag['name'] ] = (object) $data;
291 }
292 echo wp_generate_tag_cloud(
293 $tags,
294 array(
295 /* translators: %s: Number of plugins. */
296 'single_text' => __( '%s plugin' ),
297 /* translators: %s: Number of plugins. */
298 'multiple_text' => __( '%s plugins' ),
299 )
300 );
301 }
302 echo '</p><br class="clear" /></div>';
303}
304
305/**
306 * Displays a search form for searching plugins.
307 *
308 * @since 2.7.0
309 * @since 4.6.0 The `$type_selector` parameter was deprecated.
310 *
311 * @param bool $deprecated Not used.
312 */
313function install_search_form( $deprecated = true ) {
314 $type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';
315 $term = isset( $_REQUEST['s'] ) ? urldecode( wp_unslash( $_REQUEST['s'] ) ) : '';
316 ?>
317 <form class="search-form search-plugins" method="get">
318 <input type="hidden" name="tab" value="search" />
319 <label for="search-plugins"><?php _e( 'Search Plugins' ); ?></label>
320 <input type="search" name="s" id="search-plugins" value="<?php echo esc_attr( $term ); ?>" class="wp-filter-search" />
321 <label class="screen-reader-text" for="typeselector">
322 <?php
323 /* translators: Hidden accessibility text. */
324 _e( 'Search plugins by:' );
325 ?>
326 </label>
327 <select name="type" id="typeselector">
328 <option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option>
329 <option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option>
330 <option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option>
331 </select>
332 <?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?>
333 </form>
334 <?php
335}
336
337/**
338 * Displays a form to upload plugins from zip files.
339 *
340 * @since 2.8.0
341 */
342function install_plugins_upload() {
343 ?>
344<div class="upload-plugin">
345 <p class="install-help"><?php _e( 'If you have a plugin in a .zip format, you may install or update it by uploading it here.' ); ?></p>
346 <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo esc_url( self_admin_url( 'update.php?action=upload-plugin' ) ); ?>">
347 <?php wp_nonce_field( 'plugin-upload' ); ?>
348 <label class="screen-reader-text" for="pluginzip">
349 <?php
350 /* translators: Hidden accessibility text. */
351 _e( 'Plugin zip file' );
352 ?>
353 </label>
354 <input type="file" id="pluginzip" name="pluginzip" accept=".zip" />
355 <?php submit_button( _x( 'Install Now', 'plugin' ), '', 'install-plugin-submit', false ); ?>
356 </form>
357</div>
358 <?php
359}
360
361/**
362 * Shows a username form for the favorites page.
363 *
364 * @since 3.5.0
365 */
366function install_plugins_favorites_form() {
367 $user = get_user_option( 'wporg_favorites' );
368 $action = 'save_wporg_username_' . get_current_user_id();
369 ?>
370 <p><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>
371 <form method="get">
372 <input type="hidden" name="tab" value="favorites" />
373 <p>
374 <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>
375 <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />
376 <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />
377 <input type="hidden" id="wporg-username-nonce" name="_wpnonce" value="<?php echo esc_attr( wp_create_nonce( $action ) ); ?>" />
378 </p>
379 </form>
380 <?php
381}
382
383/**
384 * Displays plugin content based on plugin list.
385 *
386 * @since 2.7.0
387 *
388 * @global WP_List_Table $wp_list_table
389 */
390function display_plugins_table() {
391 global $wp_list_table;
392
393 switch ( current_filter() ) {
394 case 'install_plugins_beta':
395 printf(
396 /* translators: %s: URL to "Features as Plugins" page. */
397 '<p>' . __( 'You are using a development version of WordPress. These feature plugins are also under development. <a href="%s">Learn more</a>.' ) . '</p>',
398 'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/'
399 );
400 break;
401 case 'install_plugins_featured':
402 echo '<br>';
403 break;
404 case 'install_plugins_recommended':
405 echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>';
406 break;
407 case 'install_plugins_favorites':
408 if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {
409 return;
410 }
411 break;
412 }
413 ?>
414 <form id="plugin-filter" method="post">
415 <?php $wp_list_table->display(); ?>
416 </form>
417 <?php
418}
419
420/**
421 * Determines the status we can perform on a plugin.
422 *
423 * @since 3.0.0
424 *
425 * @param array|object $api Data about the plugin retrieved from the API.
426 * @param bool $loop Optional. Disable further loops. Default false.
427 * @return array {
428 * Plugin installation status data.
429 *
430 * @type string $status Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'.
431 * @type string $url Plugin installation URL.
432 * @type string $version The most recent version of the plugin.
433 * @type string $file Plugin filename relative to the plugins directory.
434 * }
435 */
436function install_plugin_install_status( $api, $loop = false ) {
437 // This function is called recursively, $loop prevents further loops.
438 if ( is_array( $api ) ) {
439 $api = (object) $api;
440 }
441
442 // Default to a "new" plugin.
443 $status = 'install';
444 $url = false;
445 $update_file = false;
446 $version = '';
447
448 /*
449 * Check to see if this plugin is known to be installed,
450 * and has an update awaiting it.
451 */
452 $update_plugins = get_site_transient( 'update_plugins' );
453 if ( isset( $update_plugins->response ) ) {
454 foreach ( (array) $update_plugins->response as $file => $plugin ) {
455 if ( $plugin->slug === $api->slug ) {
456 $status = 'update_available';
457 $update_file = $file;
458 $version = $plugin->new_version;
459 if ( current_user_can( 'update_plugins' ) ) {
460 $url = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . $update_file ), 'upgrade-plugin_' . $update_file );
461 }
462 break;
463 }
464 }
465 }
466
467 if ( 'install' === $status ) {
468 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
469 $installed_plugin = get_plugins( '/' . $api->slug );
470 if ( empty( $installed_plugin ) ) {
471 if ( current_user_can( 'install_plugins' ) ) {
472 $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug );
473 }
474 } else {
475 $key = array_keys( $installed_plugin );
476 /*
477 * Use the first plugin regardless of the name.
478 * Could have issues for multiple plugins in one directory if they share different version numbers.
479 */
480 $key = reset( $key );
481
482 $update_file = $api->slug . '/' . $key;
483 if ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '=' ) ) {
484 $status = 'latest_installed';
485 } elseif ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '<' ) ) {
486 $status = 'newer_installed';
487 $version = $installed_plugin[ $key ]['Version'];
488 } else {
489 // If the above update check failed, then that probably means that the update checker has out-of-date information, force a refresh.
490 if ( ! $loop ) {
491 delete_site_transient( 'update_plugins' );
492 wp_update_plugins();
493 return install_plugin_install_status( $api, true );
494 }
495 }
496 }
497 } else {
498 // "install" & no directory with that slug.
499 if ( current_user_can( 'install_plugins' ) ) {
500 $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug );
501 }
502 }
503 }
504 if ( isset( $_GET['from'] ) ) {
505 $url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) );
506 }
507
508 $file = $update_file;
509 return compact( 'status', 'url', 'version', 'file' );
510}
511
512/**
513 * Displays plugin information in dialog box form.
514 *
515 * @since 2.7.0
516 *
517 * @global string $tab
518 */
519function install_plugin_information() {
520 global $tab;
521
522 if ( empty( $_REQUEST['plugin'] ) ) {
523 return;
524 }
525
526 $api = plugins_api(
527 'plugin_information',
528 array(
529 'slug' => wp_unslash( $_REQUEST['plugin'] ),
530 )
531 );
532
533 if ( is_wp_error( $api ) ) {
534 wp_die( $api );
535 }
536
537 $plugins_allowedtags = array(
538 'a' => array(
539 'href' => array(),
540 'title' => array(),
541 'target' => array(),
542 ),
543 'abbr' => array( 'title' => array() ),
544 'acronym' => array( 'title' => array() ),
545 'code' => array(),
546 'pre' => array(),
547 'em' => array(),
548 'strong' => array(),
549 'div' => array( 'class' => array() ),
550 'span' => array( 'class' => array() ),
551 'p' => array(),
552 'br' => array(),
553 'ul' => array(),
554 'ol' => array(),
555 'li' => array(),
556 'h1' => array(),
557 'h2' => array(),
558 'h3' => array(),
559 'h4' => array(),
560 'h5' => array(),
561 'h6' => array(),
562 'img' => array(
563 'src' => array(),
564 'class' => array(),
565 'alt' => array(),
566 ),
567 'blockquote' => array( 'cite' => true ),
568 );
569
570 $plugins_section_titles = array(
571 'description' => _x( 'Description', 'Plugin installer section title' ),
572 'installation' => _x( 'Installation', 'Plugin installer section title' ),
573 'faq' => _x( 'FAQ', 'Plugin installer section title' ),
574 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ),
575 'changelog' => _x( 'Changelog', 'Plugin installer section title' ),
576 'reviews' => _x( 'Reviews', 'Plugin installer section title' ),
577 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' ),
578 );
579
580 // Sanitize HTML.
581 foreach ( (array) $api->sections as $section_name => $content ) {
582 $api->sections[ $section_name ] = wp_kses( $content, $plugins_allowedtags );
583 }
584
585 foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
586 if ( isset( $api->$key ) ) {
587 $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
588 }
589 }
590
591 $_tab = esc_attr( $tab );
592
593 // Default to the Description tab, Do not translate, API returns English.
594 $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description';
595 if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
596 $section_titles = array_keys( (array) $api->sections );
597 $section = reset( $section_titles );
598 }
599
600 iframe_header( __( 'Plugin Installation' ) );
601
602 $_with_banner = '';
603
604 if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) {
605 $_with_banner = 'with-banner';
606 $low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low'];
607 $high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high'];
608 ?>
609 <style type="text/css">
610 #plugin-information-title.with-banner {
611 background-image: url( <?php echo esc_url( $low ); ?> );
612 }
613 @media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) {
614 #plugin-information-title.with-banner {
615 background-image: url( <?php echo esc_url( $high ); ?> );
616 }
617 }
618 </style>
619 <?php
620 }
621
622 echo '<div id="plugin-information-scrollable">';
623 echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>";
624 echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n";
625
626 foreach ( (array) $api->sections as $section_name => $content ) {
627 if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) {
628 continue;
629 }
630
631 if ( isset( $plugins_section_titles[ $section_name ] ) ) {
632 $title = $plugins_section_titles[ $section_name ];
633 } else {
634 $title = ucwords( str_replace( '_', ' ', $section_name ) );
635 }
636
637 $class = ( $section_name === $section ) ? ' class="current"' : '';
638 $href = add_query_arg(
639 array(
640 'tab' => $tab,
641 'section' => $section_name,
642 )
643 );
644 $href = esc_url( $href );
645 $san_section = esc_attr( $section_name );
646 echo "\t<a name='$san_section' href='$href' $class>$title</a>\n";
647 }
648
649 echo "</div>\n";
650
651 ?>
652<div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'>
653 <div class="fyi">
654 <ul>
655 <?php if ( ! empty( $api->version ) ) { ?>
656 <li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li>
657 <?php } if ( ! empty( $api->author ) ) { ?>
658 <li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li>
659 <?php } if ( ! empty( $api->last_updated ) ) { ?>
660 <li><strong><?php _e( 'Last Updated:' ); ?></strong>
661 <?php
662 /* translators: %s: Human-readable time difference. */
663 printf( __( '%s ago' ), human_time_diff( strtotime( $api->last_updated ) ) );
664 ?>
665 </li>
666 <?php } if ( ! empty( $api->requires ) ) { ?>
667 <li>
668 <strong><?php _e( 'Requires WordPress Version:' ); ?></strong>
669 <?php
670 /* translators: %s: Version number. */
671 printf( __( '%s or higher' ), $api->requires );
672 ?>
673 </li>
674 <?php } if ( ! empty( $api->tested ) ) { ?>
675 <li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li>
676 <?php } if ( ! empty( $api->requires_php ) ) { ?>
677 <li>
678 <strong><?php _e( 'Requires PHP Version:' ); ?></strong>
679 <?php
680 /* translators: %s: Version number. */
681 printf( __( '%s or higher' ), $api->requires_php );
682 ?>
683 </li>
684 <?php } if ( isset( $api->active_installs ) ) { ?>
685 <li><strong><?php _e( 'Active Installations:' ); ?></strong>
686 <?php
687 if ( $api->active_installs >= 1000000 ) {
688 $active_installs_millions = floor( $api->active_installs / 1000000 );
689 printf(
690 /* translators: %s: Number of millions. */
691 _nx( '%s+ Million', '%s+ Million', $active_installs_millions, 'Active plugin installations' ),
692 number_format_i18n( $active_installs_millions )
693 );
694 } elseif ( $api->active_installs < 10 ) {
695 _ex( 'Less Than 10', 'Active plugin installations' );
696 } else {
697 echo number_format_i18n( $api->active_installs ) . '+';
698 }
699 ?>
700 </li>
701 <?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?>
702 <li><a target="_blank" href="<?php echo esc_url( __( 'https://wordpress.org/plugins/' ) . $api->slug ); ?>/"><?php _e( 'WordPress.org Plugin Page »' ); ?></a></li>
703 <?php } if ( ! empty( $api->homepage ) ) { ?>
704 <li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage »' ); ?></a></li>
705 <?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?>
706 <li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a></li>
707 <?php } ?>
708 </ul>
709 <?php if ( ! empty( $api->rating ) ) { ?>
710 <h3><?php _e( 'Average Rating' ); ?></h3>
711 <?php
712 wp_star_rating(
713 array(
714 'rating' => $api->rating,
715 'type' => 'percent',
716 'number' => $api->num_ratings,
717 )
718 );
719 ?>
720 <p aria-hidden="true" class="fyi-description">
721 <?php
722 printf(
723 /* translators: %s: Number of ratings. */
724 _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ),
725 number_format_i18n( $api->num_ratings )
726 );
727 ?>
728 </p>
729 <?php
730 }
731
732 if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) {
733 ?>
734 <h3><?php _e( 'Reviews' ); ?></h3>
735 <p class="fyi-description"><?php _e( 'Read all reviews on WordPress.org or write your own!' ); ?></p>
736 <?php
737 foreach ( $api->ratings as $key => $ratecount ) {
738 // Avoid div-by-zero.
739 $_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0;
740 $aria_label = esc_attr(
741 sprintf(
742 /* translators: 1: Number of stars (used to determine singular/plural), 2: Number of reviews. */
743 _n(
744 'Reviews with %1$d star: %2$s. Opens in a new tab.',
745 'Reviews with %1$d stars: %2$s. Opens in a new tab.',
746 $key
747 ),
748 $key,
749 number_format_i18n( $ratecount )
750 )
751 );
752 ?>
753 <div class="counter-container">
754 <span class="counter-label">
755 <?php
756 printf(
757 '<a href="%s" target="_blank" aria-label="%s">%s</a>',
758 "https://wordpress.org/support/plugin/{$api->slug}/reviews/?filter={$key}",
759 $aria_label,
760 /* translators: %s: Number of stars. */
761 sprintf( _n( '%d star', '%d stars', $key ), $key )
762 );
763 ?>
764 </span>
765 <span class="counter-back">
766 <span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span>
767 </span>
768 <span class="counter-count" aria-hidden="true"><?php echo number_format_i18n( $ratecount ); ?></span>
769 </div>
770 <?php
771 }
772 }
773 if ( ! empty( $api->contributors ) ) {
774 ?>
775 <h3><?php _e( 'Contributors' ); ?></h3>
776 <ul class="contributors">
777 <?php
778 foreach ( (array) $api->contributors as $contrib_username => $contrib_details ) {
779 $contrib_name = $contrib_details['display_name'];
780 if ( ! $contrib_name ) {
781 $contrib_name = $contrib_username;
782 }
783 $contrib_name = esc_html( $contrib_name );
784
785 $contrib_profile = esc_url( $contrib_details['profile'] );
786 $contrib_avatar = esc_url( add_query_arg( 's', '36', $contrib_details['avatar'] ) );
787
788 echo "<li><a href='{$contrib_profile}' target='_blank'><img src='{$contrib_avatar}' width='18' height='18' alt='' />{$contrib_name}</a></li>";
789 }
790 ?>
791 </ul>
792 <?php if ( ! empty( $api->donate_link ) ) { ?>
793 <a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a>
794 <?php } ?>
795 <?php } ?>
796 </div>
797 <div id="section-holder">
798 <?php
799 $requires_php = isset( $api->requires_php ) ? $api->requires_php : null;
800 $requires_wp = isset( $api->requires ) ? $api->requires : null;
801
802 $compatible_php = is_php_version_compatible( $requires_php );
803 $compatible_wp = is_wp_version_compatible( $requires_wp );
804 $tested_wp = ( empty( $api->tested ) || version_compare( get_bloginfo( 'version' ), $api->tested, '<=' ) );
805
806 if ( ! $compatible_php ) {
807 $compatible_php_notice_message = '<p>';
808 $compatible_php_notice_message .= __( '<strong>Error:</strong> This plugin <strong>requires a newer version of PHP</strong>.' );
809
810 if ( current_user_can( 'update_php' ) ) {
811 $compatible_php_notice_message .= sprintf(
812 /* translators: %s: URL to Update PHP page. */
813 ' ' . __( '<a href="%s" target="_blank">Click here to learn more about updating PHP</a>.' ),
814 esc_url( wp_get_update_php_url() )
815 ) . wp_update_php_annotation( '</p><p><em>', '</em>', false );
816 } else {
817 $compatible_php_notice_message .= '</p>';
818 }
819
820 wp_admin_notice(
821 $compatible_php_notice_message,
822 array(
823 'type' => 'error',
824 'additional_classes' => array( 'notice-alt' ),
825 'paragraph_wrap' => false,
826 )
827 );
828 }
829
830 if ( ! $tested_wp ) {
831 wp_admin_notice(
832 __( '<strong>Warning:</strong> This plugin <strong>has not been tested</strong> with your current version of WordPress.' ),
833 array(
834 'type' => 'warning',
835 'additional_classes' => array( 'notice-alt' ),
836 )
837 );
838 } elseif ( ! $compatible_wp ) {
839 $compatible_wp_notice_message = __( '<strong>Error:</strong> This plugin <strong>requires a newer version of WordPress</strong>.' );
840 if ( current_user_can( 'update_core' ) ) {
841 $compatible_wp_notice_message .= sprintf(
842 /* translators: %s: URL to WordPress Updates screen. */
843 ' ' . __( '<a href="%s" target="_parent">Click here to update WordPress</a>.' ),
844 esc_url( self_admin_url( 'update-core.php' ) )
845 );
846 }
847
848 wp_admin_notice(
849 $compatible_wp_notice_message,
850 array(
851 'type' => 'error',
852 'additional_classes' => array( 'notice-alt' ),
853 )
854 );
855 }
856
857 foreach ( (array) $api->sections as $section_name => $content ) {
858 $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' );
859 $content = links_add_target( $content, '_blank' );
860
861 $san_section = esc_attr( $section_name );
862
863 $display = ( $section_name === $section ) ? 'block' : 'none';
864
865 echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n";
866 echo $content;
867 echo "\t</div>\n";
868 }
869 echo "</div>\n";
870 echo "</div>\n";
871 echo "</div>\n"; // #plugin-information-scrollable
872 echo "<div id='$tab-footer'>\n";
873 if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) {
874 $button = wp_get_plugin_action_button( $api->name, $api, $compatible_php, $compatible_wp );
875 $button = str_replace( 'class="', 'class="right ', $button );
876
877 if ( ! str_contains( $button, _x( 'Activate', 'plugin' ) ) ) {
878 $button = str_replace( 'class="', 'id="plugin_install_from_iframe" class="', $button );
879 }
880
881 echo wp_kses_post( $button );
882 }
883 echo "</div>\n";
884
885 wp_print_request_filesystem_credentials_modal();
886 wp_print_admin_notice_templates();
887
888 iframe_footer();
889 exit;
890}
891
892/**
893 * Gets the markup for the plugin install action button.
894 *
895 * @since 6.5.0
896 *
897 * @param string $name Plugin name.
898 * @param array|object $data {
899 * An array or object of plugin data. Can be retrieved from the API.
900 *
901 * @type string $slug The plugin slug.
902 * @type string[] $requires_plugins An array of plugin dependency slugs.
903 * @type string $version The plugin's version string. Used when getting the install status.
904 * }
905 * @param bool $compatible_php The result of a PHP compatibility check.
906 * @param bool $compatible_wp The result of a WP compatibility check.
907 * @return string The markup for the dependency row button. An empty string if the user does not have capabilities.
908 */
909function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) {
910 $button = '';
911 $data = (object) $data;
912 $status = install_plugin_install_status( $data );
913 $requires_plugins = $data->requires_plugins ?? array();
914
915 // Determine the status of plugin dependencies.
916 $installed_plugins = get_plugins();
917 $active_plugins = get_option( 'active_plugins', array() );
918 $plugin_dependencies_count = count( $requires_plugins );
919 $installed_plugin_dependencies_count = 0;
920 $active_plugin_dependencies_count = 0;
921 foreach ( $requires_plugins as $dependency ) {
922 foreach ( array_keys( $installed_plugins ) as $installed_plugin_file ) {
923 if ( str_contains( $installed_plugin_file, '/' ) && explode( '/', $installed_plugin_file )[0] === $dependency ) {
924 ++$installed_plugin_dependencies_count;
925 }
926 }
927
928 foreach ( $active_plugins as $active_plugin_file ) {
929 if ( str_contains( $active_plugin_file, '/' ) && explode( '/', $active_plugin_file )[0] === $dependency ) {
930 ++$active_plugin_dependencies_count;
931 }
932 }
933 }
934 $all_plugin_dependencies_installed = $installed_plugin_dependencies_count === $plugin_dependencies_count;
935 $all_plugin_dependencies_active = $active_plugin_dependencies_count === $plugin_dependencies_count;
936
937 if ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) {
938 switch ( $status['status'] ) {
939 case 'install':
940 if ( $status['url'] ) {
941 if ( $compatible_php && $compatible_wp && $all_plugin_dependencies_installed && ! empty( $data->download_link ) ) {
942 $button = sprintf(
943 '<a class="install-now button" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>',
944 esc_attr( $data->slug ),
945 esc_url( $status['url'] ),
946 /* translators: %s: Plugin name and version. */
947 esc_attr( sprintf( _x( 'Install %s now', 'plugin' ), $name ) ),
948 esc_attr( $name ),
949 _x( 'Install Now', 'plugin' )
950 );
951 } else {
952 $button = sprintf(
953 '<button type="button" class="install-now button button-disabled" disabled="disabled">%s</button>',
954 _x( 'Install Now', 'plugin' )
955 );
956 }
957 }
958 break;
959
960 case 'update_available':
961 if ( $status['url'] ) {
962 if ( $compatible_php && $compatible_wp ) {
963 $button = sprintf(
964 '<a class="update-now button aria-button-if-js" data-plugin="%s" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>',
965 esc_attr( $status['file'] ),
966 esc_attr( $data->slug ),
967 esc_url( $status['url'] ),
968 /* translators: %s: Plugin name and version. */
969 esc_attr( sprintf( _x( 'Update %s now', 'plugin' ), $name ) ),
970 esc_attr( $name ),
971 _x( 'Update Now', 'plugin' )
972 );
973 } else {
974 $button = sprintf(
975 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>',
976 _x( 'Update Now', 'plugin' )
977 );
978 }
979 }
980 break;
981
982 case 'latest_installed':
983 case 'newer_installed':
984 if ( is_plugin_active( $status['file'] ) ) {
985 $button = sprintf(
986 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>',
987 _x( 'Active', 'plugin' )
988 );
989 } elseif ( current_user_can( 'activate_plugin', $status['file'] ) ) {
990 if ( $compatible_php && $compatible_wp && $all_plugin_dependencies_active ) {
991 $button_text = _x( 'Activate', 'plugin' );
992 /* translators: %s: Plugin name. */
993 $button_label = _x( 'Activate %s', 'plugin' );
994 $activate_url = add_query_arg(
995 array(
996 '_wpnonce' => wp_create_nonce( 'activate-plugin_' . $status['file'] ),
997 'action' => 'activate',
998 'plugin' => $status['file'],
999 ),
1000 network_admin_url( 'plugins.php' )
1001 );
1002
1003 if ( is_network_admin() ) {
1004 $button_text = _x( 'Network Activate', 'plugin' );
1005 /* translators: %s: Plugin name. */
1006 $button_label = _x( 'Network Activate %s', 'plugin' );
1007 $activate_url = add_query_arg( array( 'networkwide' => 1 ), $activate_url );
1008 }
1009
1010 $button = sprintf(
1011 '<a href="%1$s" data-name="%2$s" data-slug="%3$s" data-plugin="%4$s" class="button button-primary activate-now" aria-label="%5$s" role="button">%6$s</a>',
1012 esc_url( $activate_url ),
1013 esc_attr( $name ),
1014 esc_attr( $data->slug ),
1015 esc_attr( $status['file'] ),
1016 esc_attr( sprintf( $button_label, $name ) ),
1017 $button_text
1018 );
1019 } else {
1020 $button = sprintf(
1021 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>',
1022 is_network_admin() ? _x( 'Network Activate', 'plugin' ) : _x( 'Activate', 'plugin' )
1023 );
1024 }
1025 } else {
1026 $button = sprintf(
1027 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>',
1028 _x( 'Installed', 'plugin' )
1029 );
1030 }
1031 break;
1032 }
1033 }
1034
1035 return $button;
1036}
1037