plugin-install.php 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726
  1. <?php
  2. /**
  3. * WordPress Plugin Install Administration API
  4. *
  5. * @package WordPress
  6. * @subpackage Administration
  7. */
  8. /**
  9. * Retrieves plugin installer pages from the WordPress.org Plugins API.
  10. *
  11. * It is possible for a plugin to override the Plugin API result with three
  12. * filters. Assume this is for plugins, which can extend on the Plugin Info to
  13. * offer more choices. This is very powerful and must be used with care when
  14. * overriding the filters.
  15. *
  16. * The first filter, {@see 'plugins_api_args'}, is for the args and gives the action
  17. * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that
  18. * an object is returned.
  19. *
  20. * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
  21. * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information',
  22. * an object MUST be passed. If `$action` is 'hot_tags' or 'hot_categories', an array MUST
  23. * 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 | hot_categories |
  31. * | -------------------- | :-----------: | :----------------: | :------: | :------------: |
  32. * | `$slug` | No | Yes | No | No |
  33. * | `$per_page` | Yes | No | No | No |
  34. * | `$page` | Yes | No | No | No |
  35. * | `$number` | No | No | Yes | Yes |
  36. * | `$search` | Yes | No | No | No |
  37. * | `$tag` | Yes | No | No | No |
  38. * | `$author` | Yes | No | No | No |
  39. * | `$user` | Yes | No | No | No |
  40. * | `$browse` | Yes | No | No | No |
  41. * | `$locale` | Yes | Yes | No | No |
  42. * | `$installed_plugins` | Yes | No | No | No |
  43. * | `$is_ssl` | Yes | Yes | No | No |
  44. * | `$fields` | Yes | Yes | No | No |
  45. *
  46. * @since 2.7.0
  47. *
  48. * @param string $action API action to perform: 'query_plugins', 'plugin_information',
  49. * 'hot_tags' or 'hot_categories'.
  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 $rating Whether to return the rating in percent and total number of ratings.
  76. * Default true.
  77. * @type bool $ratings Whether to return the number of rating for each star (1-5). Default true.
  78. * @type bool $downloaded Whether to return the download count. Default true.
  79. * @type bool $downloadlink Whether to return the download link for the package. Default true.
  80. * @type bool $last_updated Whether to return the date of the last update. Default true.
  81. * @type bool $added Whether to return the date when the plugin was added to the wordpress.org
  82. * repository. Default true.
  83. * @type bool $tags Whether to return the assigned tags. Default true.
  84. * @type bool $compatibility Whether to return the WordPress compatibility list. Default true.
  85. * @type bool $homepage Whether to return the plugin homepage link. Default true.
  86. * @type bool $versions Whether to return the list of all available versions. Default false.
  87. * @type bool $donate_link Whether to return the donation link. Default true.
  88. * @type bool $reviews Whether to return the plugin reviews. Default false.
  89. * @type bool $banners Whether to return the banner images links. Default false.
  90. * @type bool $icons Whether to return the icon links. Default false.
  91. * @type bool $active_installs Whether to return the number of active installations. Default false.
  92. * @type bool $group Whether to return the assigned group. 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. */
  100. function plugins_api( $action, $args = array() ) {
  101. if ( is_array( $args ) ) {
  102. $args = (object) $args;
  103. }
  104. if ( ! isset( $args->per_page ) ) {
  105. $args->per_page = 24;
  106. }
  107. if ( ! isset( $args->locale ) ) {
  108. $args->locale = get_user_locale();
  109. }
  110. /**
  111. * Filters the WordPress.org Plugin Installation API arguments.
  112. *
  113. * Important: An object MUST be returned to this filter.
  114. *
  115. * @since 2.7.0
  116. *
  117. * @param object $args Plugin API arguments.
  118. * @param string $action The type of information being requested from the Plugin Installation API.
  119. */
  120. $args = apply_filters( 'plugins_api_args', $args, $action );
  121. /**
  122. * Filters the response for the current WordPress.org Plugin Installation API request.
  123. *
  124. * Passing a non-false value will effectively short-circuit the WordPress.org API request.
  125. *
  126. * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.
  127. * If `$action` is 'hot_tags' or 'hot_categories', an array should be passed.
  128. *
  129. * @since 2.7.0
  130. *
  131. * @param false|object|array $result The result object or array. Default false.
  132. * @param string $action The type of information being requested from the Plugin Installation API.
  133. * @param object $args Plugin API arguments.
  134. */
  135. $res = apply_filters( 'plugins_api', false, $action, $args );
  136. if ( false === $res ) {
  137. // include an unmodified $wp_version
  138. include( ABSPATH . WPINC . '/version.php' );
  139. $url = $http_url = 'http://api.wordpress.org/plugins/info/1.0/';
  140. if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
  141. $url = set_url_scheme( $url, 'https' );
  142. $http_args = array(
  143. 'timeout' => 15,
  144. 'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ),
  145. 'body' => array(
  146. 'action' => $action,
  147. 'request' => serialize( $args )
  148. )
  149. );
  150. $request = wp_remote_post( $url, $http_args );
  151. if ( $ssl && is_wp_error( $request ) ) {
  152. trigger_error(
  153. sprintf(
  154. /* translators: %s: support forums URL */
  155. __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
  156. __( 'https://wordpress.org/support/' )
  157. ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),
  158. headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
  159. );
  160. $request = wp_remote_post( $http_url, $http_args );
  161. }
  162. if ( is_wp_error($request) ) {
  163. $res = new WP_Error( 'plugins_api_failed',
  164. sprintf(
  165. /* translators: %s: support forums URL */
  166. __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
  167. __( 'https://wordpress.org/support/' )
  168. ),
  169. $request->get_error_message()
  170. );
  171. } else {
  172. $res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
  173. if ( ! is_object( $res ) && ! is_array( $res ) ) {
  174. $res = new WP_Error( 'plugins_api_failed',
  175. sprintf(
  176. /* translators: %s: support forums URL */
  177. __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
  178. __( 'https://wordpress.org/support/' )
  179. ),
  180. wp_remote_retrieve_body( $request )
  181. );
  182. }
  183. }
  184. } elseif ( !is_wp_error($res) ) {
  185. $res->external = true;
  186. }
  187. /**
  188. * Filters the Plugin Installation API response results.
  189. *
  190. * @since 2.7.0
  191. *
  192. * @param object|WP_Error $res Response object or WP_Error.
  193. * @param string $action The type of information being requested from the Plugin Installation API.
  194. * @param object $args Plugin API arguments.
  195. */
  196. return apply_filters( 'plugins_api_result', $res, $action, $args );
  197. }
  198. /**
  199. * Retrieve popular WordPress plugin tags.
  200. *
  201. * @since 2.7.0
  202. *
  203. * @param array $args
  204. * @return array
  205. */
  206. function install_popular_tags( $args = array() ) {
  207. $key = md5(serialize($args));
  208. if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
  209. return $tags;
  210. $tags = plugins_api('hot_tags', $args);
  211. if ( is_wp_error($tags) )
  212. return $tags;
  213. set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
  214. return $tags;
  215. }
  216. /**
  217. * @since 2.7.0
  218. */
  219. function install_dashboard() {
  220. ?>
  221. <p><?php printf( __( 'Plugins extend and expand the functionality of WordPress. You may automatically install plugins from the <a href="%1$s">WordPress Plugin Directory</a> or upload a plugin in .zip format by clicking the button at the top of this page.' ), __( 'https://wordpress.org/plugins/' ) ); ?></p>
  222. <?php display_plugins_table(); ?>
  223. <div class="plugins-popular-tags-wrapper">
  224. <h2><?php _e( 'Popular tags' ) ?></h2>
  225. <p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ) ?></p>
  226. <?php
  227. $api_tags = install_popular_tags();
  228. echo '<p class="popular-tags">';
  229. if ( is_wp_error($api_tags) ) {
  230. echo $api_tags->get_error_message();
  231. } else {
  232. //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
  233. $tags = array();
  234. foreach ( (array) $api_tags as $tag ) {
  235. $url = self_admin_url( 'plugin-install.php?tab=search&type=tag&s=' . urlencode( $tag['name'] ) );
  236. $data = array(
  237. 'link' => esc_url( $url ),
  238. 'name' => $tag['name'],
  239. 'slug' => $tag['slug'],
  240. 'id' => sanitize_title_with_dashes( $tag['name'] ),
  241. 'count' => $tag['count']
  242. );
  243. $tags[ $tag['name'] ] = (object) $data;
  244. }
  245. echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) );
  246. }
  247. echo '</p><br class="clear" /></div>';
  248. }
  249. /**
  250. * Displays a search form for searching plugins.
  251. *
  252. * @since 2.7.0
  253. * @since 4.6.0 The `$type_selector` parameter was deprecated.
  254. *
  255. * @param bool $deprecated Not used.
  256. */
  257. function install_search_form( $deprecated = true ) {
  258. $type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';
  259. $term = isset( $_REQUEST['s'] ) ? wp_unslash( $_REQUEST['s'] ) : '';
  260. ?><form class="search-form search-plugins" method="get">
  261. <input type="hidden" name="tab" value="search" />
  262. <label class="screen-reader-text" for="typeselector"><?php _e( 'Search plugins by:' ); ?></label>
  263. <select name="type" id="typeselector">
  264. <option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option>
  265. <option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option>
  266. <option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option>
  267. </select>
  268. <label><span class="screen-reader-text"><?php _e( 'Search Plugins' ); ?></span>
  269. <input type="search" name="s" value="<?php echo esc_attr( $term ) ?>" class="wp-filter-search" placeholder="<?php esc_attr_e( 'Search plugins...' ); ?>" />
  270. </label>
  271. <?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?>
  272. </form><?php
  273. }
  274. /**
  275. * Upload from zip
  276. * @since 2.8.0
  277. */
  278. function install_plugins_upload() {
  279. ?>
  280. <div class="upload-plugin">
  281. <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.'); ?></p>
  282. <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo self_admin_url('update.php?action=upload-plugin'); ?>">
  283. <?php wp_nonce_field( 'plugin-upload' ); ?>
  284. <label class="screen-reader-text" for="pluginzip"><?php _e( 'Plugin zip file' ); ?></label>
  285. <input type="file" id="pluginzip" name="pluginzip" />
  286. <?php submit_button( __( 'Install Now' ), '', 'install-plugin-submit', false ); ?>
  287. </form>
  288. </div>
  289. <?php
  290. }
  291. /**
  292. * Show a username form for the favorites page
  293. * @since 3.5.0
  294. *
  295. */
  296. function install_plugins_favorites_form() {
  297. $user = get_user_option( 'wporg_favorites' );
  298. $action = 'save_wporg_username_' . get_current_user_id();
  299. ?>
  300. <p class="install-help"><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>
  301. <form method="get">
  302. <input type="hidden" name="tab" value="favorites" />
  303. <p>
  304. <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>
  305. <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />
  306. <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />
  307. <input type="hidden" id="wporg-username-nonce" name="_wpnonce" value="<?php echo esc_attr( wp_create_nonce( $action ) ); ?>" />
  308. </p>
  309. </form>
  310. <?php
  311. }
  312. /**
  313. * Display plugin content based on plugin list.
  314. *
  315. * @since 2.7.0
  316. *
  317. * @global WP_List_Table $wp_list_table
  318. */
  319. function display_plugins_table() {
  320. global $wp_list_table;
  321. switch ( current_filter() ) {
  322. case 'install_plugins_favorites' :
  323. if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {
  324. return;
  325. }
  326. break;
  327. case 'install_plugins_recommended' :
  328. echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>';
  329. break;
  330. case 'install_plugins_beta' :
  331. printf(
  332. '<p>' . __( 'You are using a development version of WordPress. These feature plugins are also under development. <a href="%s">Learn more</a>.' ) . '</p>',
  333. 'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/'
  334. );
  335. break;
  336. }
  337. ?>
  338. <form id="plugin-filter" method="post">
  339. <?php $wp_list_table->display(); ?>
  340. </form>
  341. <?php
  342. }
  343. /**
  344. * Determine the status we can perform on a plugin.
  345. *
  346. * @since 3.0.0
  347. *
  348. * @param array|object $api Data about the plugin retrieved from the API.
  349. * @param bool $loop Optional. Disable further loops. Default false.
  350. * @return array {
  351. * Plugin installation status data.
  352. *
  353. * @type string $status Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'.
  354. * @type string $url Plugin installation URL.
  355. * @type string $version The most recent version of the plugin.
  356. * @type string $file Plugin filename relative to the plugins directory.
  357. * }
  358. */
  359. function install_plugin_install_status($api, $loop = false) {
  360. // This function is called recursively, $loop prevents further loops.
  361. if ( is_array($api) )
  362. $api = (object) $api;
  363. // Default to a "new" plugin
  364. $status = 'install';
  365. $url = false;
  366. $update_file = false;
  367. /*
  368. * Check to see if this plugin is known to be installed,
  369. * and has an update awaiting it.
  370. */
  371. $update_plugins = get_site_transient('update_plugins');
  372. if ( isset( $update_plugins->response ) ) {
  373. foreach ( (array)$update_plugins->response as $file => $plugin ) {
  374. if ( $plugin->slug === $api->slug ) {
  375. $status = 'update_available';
  376. $update_file = $file;
  377. $version = $plugin->new_version;
  378. if ( current_user_can('update_plugins') )
  379. $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
  380. break;
  381. }
  382. }
  383. }
  384. if ( 'install' == $status ) {
  385. if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
  386. $installed_plugin = get_plugins('/' . $api->slug);
  387. if ( empty($installed_plugin) ) {
  388. if ( current_user_can('install_plugins') )
  389. $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
  390. } else {
  391. $key = array_keys( $installed_plugin );
  392. $key = reset( $key ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
  393. $update_file = $api->slug . '/' . $key;
  394. if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
  395. $status = 'latest_installed';
  396. } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
  397. $status = 'newer_installed';
  398. $version = $installed_plugin[ $key ]['Version'];
  399. } else {
  400. //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
  401. if ( ! $loop ) {
  402. delete_site_transient('update_plugins');
  403. wp_update_plugins();
  404. return install_plugin_install_status($api, true);
  405. }
  406. }
  407. }
  408. } else {
  409. // "install" & no directory with that slug
  410. if ( current_user_can('install_plugins') )
  411. $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
  412. }
  413. }
  414. if ( isset($_GET['from']) )
  415. $url .= '&amp;from=' . urlencode( wp_unslash( $_GET['from'] ) );
  416. $file = $update_file;
  417. return compact( 'status', 'url', 'version', 'file' );
  418. }
  419. /**
  420. * Display plugin information in dialog box form.
  421. *
  422. * @since 2.7.0
  423. *
  424. * @global string $tab
  425. */
  426. function install_plugin_information() {
  427. global $tab;
  428. if ( empty( $_REQUEST['plugin'] ) ) {
  429. return;
  430. }
  431. $api = plugins_api( 'plugin_information', array(
  432. 'slug' => wp_unslash( $_REQUEST['plugin'] ),
  433. 'is_ssl' => is_ssl(),
  434. 'fields' => array(
  435. 'banners' => true,
  436. 'reviews' => true,
  437. 'downloaded' => false,
  438. 'active_installs' => true
  439. )
  440. ) );
  441. if ( is_wp_error( $api ) ) {
  442. wp_die( $api );
  443. }
  444. $plugins_allowedtags = array(
  445. 'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ),
  446. 'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ),
  447. 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
  448. 'div' => array( 'class' => array() ), 'span' => array( 'class' => array() ),
  449. 'p' => array(), 'br' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
  450. 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
  451. 'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() ),
  452. 'blockquote' => array( 'cite' => true ),
  453. );
  454. $plugins_section_titles = array(
  455. 'description' => _x( 'Description', 'Plugin installer section title' ),
  456. 'installation' => _x( 'Installation', 'Plugin installer section title' ),
  457. 'faq' => _x( 'FAQ', 'Plugin installer section title' ),
  458. 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ),
  459. 'changelog' => _x( 'Changelog', 'Plugin installer section title' ),
  460. 'reviews' => _x( 'Reviews', 'Plugin installer section title' ),
  461. 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' )
  462. );
  463. // Sanitize HTML
  464. foreach ( (array) $api->sections as $section_name => $content ) {
  465. $api->sections[$section_name] = wp_kses( $content, $plugins_allowedtags );
  466. }
  467. foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
  468. if ( isset( $api->$key ) ) {
  469. $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
  470. }
  471. }
  472. $_tab = esc_attr( $tab );
  473. $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; // Default to the Description tab, Do not translate, API returns English.
  474. if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
  475. $section_titles = array_keys( (array) $api->sections );
  476. $section = reset( $section_titles );
  477. }
  478. iframe_header( __( 'Plugin Installation' ) );
  479. $_with_banner = '';
  480. if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) {
  481. $_with_banner = 'with-banner';
  482. $low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low'];
  483. $high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high'];
  484. ?>
  485. <style type="text/css">
  486. #plugin-information-title.with-banner {
  487. background-image: url( <?php echo esc_url( $low ); ?> );
  488. }
  489. @media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) {
  490. #plugin-information-title.with-banner {
  491. background-image: url( <?php echo esc_url( $high ); ?> );
  492. }
  493. }
  494. </style>
  495. <?php
  496. }
  497. echo '<div id="plugin-information-scrollable">';
  498. echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>";
  499. echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n";
  500. foreach ( (array) $api->sections as $section_name => $content ) {
  501. if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) {
  502. continue;
  503. }
  504. if ( isset( $plugins_section_titles[ $section_name ] ) ) {
  505. $title = $plugins_section_titles[ $section_name ];
  506. } else {
  507. $title = ucwords( str_replace( '_', ' ', $section_name ) );
  508. }
  509. $class = ( $section_name === $section ) ? ' class="current"' : '';
  510. $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
  511. $href = esc_url( $href );
  512. $san_section = esc_attr( $section_name );
  513. echo "\t<a name='$san_section' href='$href' $class>$title</a>\n";
  514. }
  515. echo "</div>\n";
  516. ?>
  517. <div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'>
  518. <div class="fyi">
  519. <ul>
  520. <?php if ( ! empty( $api->version ) ) { ?>
  521. <li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li>
  522. <?php } if ( ! empty( $api->author ) ) { ?>
  523. <li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li>
  524. <?php } if ( ! empty( $api->last_updated ) ) { ?>
  525. <li><strong><?php _e( 'Last Updated:' ); ?></strong>
  526. <?php
  527. /* translators: %s: Time since the last update */
  528. printf( __( '%s ago' ), human_time_diff( strtotime( $api->last_updated ) ) );
  529. ?>
  530. </li>
  531. <?php } if ( ! empty( $api->requires ) ) { ?>
  532. <li>
  533. <strong><?php _e( 'Requires WordPress Version:' ); ?></strong>
  534. <?php
  535. /* translators: %s: version number */
  536. printf( __( '%s or higher' ), $api->requires );
  537. ?>
  538. </li>
  539. <?php } if ( ! empty( $api->tested ) ) { ?>
  540. <li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li>
  541. <?php } if ( ! empty( $api->requires_php ) ) { ?>
  542. <li>
  543. <strong><?php _e( 'Requires PHP Version:' ); ?></strong>
  544. <?php
  545. /* translators: %s: version number */
  546. printf( __( '%s or higher' ), $api->requires_php );
  547. ?>
  548. </li>
  549. <?php } if ( isset( $api->active_installs ) ) { ?>
  550. <li><strong><?php _e( 'Active Installations:' ); ?></strong> <?php
  551. if ( $api->active_installs >= 1000000 ) {
  552. _ex( '1+ Million', 'Active plugin installations' );
  553. } elseif ( 0 == $api->active_installs ) {
  554. _ex( 'Less Than 10', 'Active plugin installations' );
  555. } else {
  556. echo number_format_i18n( $api->active_installs ) . '+';
  557. }
  558. ?></li>
  559. <?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?>
  560. <li><a target="_blank" href="<?php echo __( 'https://wordpress.org/plugins/' ) . $api->slug; ?>/"><?php _e( 'WordPress.org Plugin Page &#187;' ); ?></a></li>
  561. <?php } if ( ! empty( $api->homepage ) ) { ?>
  562. <li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage &#187;' ); ?></a></li>
  563. <?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?>
  564. <li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin &#187;' ); ?></a></li>
  565. <?php } ?>
  566. </ul>
  567. <?php if ( ! empty( $api->rating ) ) { ?>
  568. <h3><?php _e( 'Average Rating' ); ?></h3>
  569. <?php wp_star_rating( array( 'rating' => $api->rating, 'type' => 'percent', 'number' => $api->num_ratings ) ); ?>
  570. <p aria-hidden="true" class="fyi-description"><?php printf( _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ), number_format_i18n( $api->num_ratings ) ); ?></p>
  571. <?php }
  572. if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) { ?>
  573. <h3><?php _e( 'Reviews' ); ?></h3>
  574. <p class="fyi-description"><?php _e( 'Read all reviews on WordPress.org or write your own!' ); ?></p>
  575. <?php
  576. foreach ( $api->ratings as $key => $ratecount ) {
  577. // Avoid div-by-zero.
  578. $_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0;
  579. /* translators: 1: number of stars (used to determine singular/plural), 2: number of reviews */
  580. $aria_label = esc_attr( sprintf( _n( 'Reviews with %1$d star: %2$s. Opens in a new window.', 'Reviews with %1$d stars: %2$s. Opens in a new window.', $key ),
  581. $key,
  582. number_format_i18n( $ratecount )
  583. ) );
  584. ?>
  585. <div class="counter-container">
  586. <span class="counter-label"><a href="https://wordpress.org/support/plugin/<?php echo $api->slug; ?>/reviews/?filter=<?php echo $key; ?>"
  587. target="_blank" aria-label="<?php echo $aria_label; ?>"><?php printf( _n( '%d star', '%d stars', $key ), $key ); ?></a></span>
  588. <span class="counter-back">
  589. <span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span>
  590. </span>
  591. <span class="counter-count" aria-hidden="true"><?php echo number_format_i18n( $ratecount ); ?></span>
  592. </div>
  593. <?php
  594. }
  595. }
  596. if ( ! empty( $api->contributors ) ) { ?>
  597. <h3><?php _e( 'Contributors' ); ?></h3>
  598. <ul class="contributors">
  599. <?php
  600. foreach ( (array) $api->contributors as $contrib_username => $contrib_profile ) {
  601. if ( empty( $contrib_username ) && empty( $contrib_profile ) ) {
  602. continue;
  603. }
  604. if ( empty( $contrib_username ) ) {
  605. $contrib_username = preg_replace( '/^.+\/(.+)\/?$/', '\1', $contrib_profile );
  606. }
  607. $contrib_username = sanitize_user( $contrib_username );
  608. if ( empty( $contrib_profile ) ) {
  609. echo "<li><img src='https://wordpress.org/grav-redirect.php?user={$contrib_username}&amp;s=36' width='18' height='18' alt='' />{$contrib_username}</li>";
  610. } else {
  611. echo "<li><a href='{$contrib_profile}' target='_blank'><img src='https://wordpress.org/grav-redirect.php?user={$contrib_username}&amp;s=36' width='18' height='18' alt='' />{$contrib_username}</a></li>";
  612. }
  613. }
  614. ?>
  615. </ul>
  616. <?php if ( ! empty( $api->donate_link ) ) { ?>
  617. <a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin &#187;' ); ?></a>
  618. <?php } ?>
  619. <?php } ?>
  620. </div>
  621. <div id="section-holder" class="wrap">
  622. <?php
  623. $wp_version = get_bloginfo( 'version' );
  624. if ( ! empty( $api->tested ) && version_compare( substr( $wp_version, 0, strlen( $api->tested ) ), $api->tested, '>' ) ) {
  625. echo '<div class="notice notice-warning notice-alt"><p>' . __( '<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.' ) . '</p></div>';
  626. } elseif ( ! empty( $api->requires ) && version_compare( substr( $wp_version, 0, strlen( $api->requires ) ), $api->requires, '<' ) ) {
  627. echo '<div class="notice notice-warning notice-alt"><p>' . __( '<strong>Warning:</strong> This plugin has <strong>not been marked as compatible</strong> with your version of WordPress.' ) . '</p></div>';
  628. }
  629. foreach ( (array) $api->sections as $section_name => $content ) {
  630. $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' );
  631. $content = links_add_target( $content, '_blank' );
  632. $san_section = esc_attr( $section_name );
  633. $display = ( $section_name === $section ) ? 'block' : 'none';
  634. echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n";
  635. echo $content;
  636. echo "\t</div>\n";
  637. }
  638. echo "</div>\n";
  639. echo "</div>\n";
  640. echo "</div>\n"; // #plugin-information-scrollable
  641. echo "<div id='$tab-footer'>\n";
  642. if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) {
  643. $status = install_plugin_install_status( $api );
  644. switch ( $status['status'] ) {
  645. case 'install':
  646. if ( $status['url'] ) {
  647. echo '<a data-slug="' . esc_attr( $api->slug ) . '" id="plugin_install_from_iframe" class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Now' ) . '</a>';
  648. }
  649. break;
  650. case 'update_available':
  651. if ( $status['url'] ) {
  652. echo '<a data-slug="' . esc_attr( $api->slug ) . '" data-plugin="' . esc_attr( $status['file'] ) . '" id="plugin_update_from_iframe" class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Update Now' ) .'</a>';
  653. }
  654. break;
  655. case 'newer_installed':
  656. /* translators: %s: Plugin version */
  657. echo '<a class="button button-primary right disabled">' . sprintf( __( 'Newer Version (%s) Installed'), $status['version'] ) . '</a>';
  658. break;
  659. case 'latest_installed':
  660. echo '<a class="button button-primary right disabled">' . __( 'Latest Version Installed' ) . '</a>';
  661. break;
  662. }
  663. }
  664. echo "</div>\n";
  665. iframe_footer();
  666. exit;
  667. }