3 * WordPress Plugin Install Administration API
6 * @subpackage Administration
10 * Retrieve plugin installer pages from WordPress Plugins API.
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.
17 * The first filter, 'plugins_api_args', is for the args and gives the action as
18 * the second parameter. The hook for 'plugins_api_args' must ensure that an
21 * The second filter, 'plugins_api', is the result that would be returned.
25 * @param string $action
26 * @param array|object $args Optional. Arguments to serialize for the Plugin Info API.
27 * @return object plugins_api response object on success, WP_Error on failure.
29 function plugins_api($action, $args = null) {
31 if ( is_array( $args ) ) {
32 $args = (object) $args;
35 if ( ! isset( $args->per_page ) ) {
39 if ( ! isset( $args->locale ) ) {
40 $args->locale = get_locale();
44 * Override the Plugin Install API arguments.
46 * Please ensure that an object is returned.
50 * @param object $args Plugin API arguments.
51 * @param string $action The type of information being requested from the Plugin Install API.
53 $args = apply_filters( 'plugins_api_args', $args, $action );
56 * Allows a plugin to override the WordPress.org Plugin Install API entirely.
58 * Please ensure that an object is returned.
62 * @param bool|object $result The result object. Default false.
63 * @param string $action The type of information being requested from the Plugin Install API.
64 * @param object $args Plugin API arguments.
66 $res = apply_filters( 'plugins_api', false, $action, $args );
68 if ( false === $res ) {
69 $url = $http_url = 'http://api.wordpress.org/plugins/info/1.0/';
70 if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
71 $url = set_url_scheme( $url, 'https' );
77 'request' => serialize( $args )
80 $request = wp_remote_post( $url, $http_args );
82 if ( $ssl && is_wp_error( $request ) ) {
83 trigger_error( __( '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="https://wordpress.org/support/">support forums</a>.' ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ), headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE );
84 $request = wp_remote_post( $http_url, $http_args );
87 if ( is_wp_error($request) ) {
88 $res = new WP_Error('plugins_api_failed', __( '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="https://wordpress.org/support/">support forums</a>.' ), $request->get_error_message() );
90 $res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
91 if ( ! is_object( $res ) && ! is_array( $res ) )
92 $res = new WP_Error('plugins_api_failed', __( '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="https://wordpress.org/support/">support forums</a>.' ), wp_remote_retrieve_body( $request ) );
94 } elseif ( !is_wp_error($res) ) {
95 $res->external = true;
99 * Filter the Plugin Install API response results.
103 * @param object|WP_Error $res Response object or WP_Error.
104 * @param string $action The type of information being requested from the Plugin Install API.
105 * @param object $args Plugin API arguments.
107 return apply_filters( 'plugins_api_result', $res, $action, $args );
111 * Retrieve popular WordPress plugin tags.
118 function install_popular_tags( $args = array() ) {
119 $key = md5(serialize($args));
120 if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
123 $tags = plugins_api('hot_tags', $args);
125 if ( is_wp_error($tags) )
128 set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
133 function install_dashboard() {
135 <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 via <a href="%2$s">this page</a>.' ), 'https://wordpress.org/plugins/', self_admin_url( 'plugin-install.php?tab=upload' ) ); ?></p>
137 <?php display_plugins_table(); ?>
139 <h3><?php _e( 'Popular tags' ) ?></h3>
140 <p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ) ?></p>
143 $api_tags = install_popular_tags();
145 echo '<p class="popular-tags">';
146 if ( is_wp_error($api_tags) ) {
147 echo $api_tags->get_error_message();
149 //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
151 foreach ( (array)$api_tags as $tag )
152 $tags[ $tag['name'] ] = (object) array(
153 'link' => esc_url( self_admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
154 'name' => $tag['name'],
155 'id' => sanitize_title_with_dashes($tag['name']),
156 'count' => $tag['count'] );
157 echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) );
159 echo '</p><br class="clear" />';
161 add_action( 'install_plugins_featured', 'install_dashboard' );
164 * Display search form for searching plugins.
168 function install_search_form( $type_selector = true ) {
169 $type = isset($_REQUEST['type']) ? wp_unslash( $_REQUEST['type'] ) : 'term';
170 $term = isset($_REQUEST['s']) ? wp_unslash( $_REQUEST['s'] ) : '';
172 $button_type = 'button screen-reader-text';
174 // assume no $type_selector means it's a simplified search form
175 if ( ! $type_selector ) {
176 $input_attrs = 'class="wp-filter-search" placeholder="' . esc_attr__( 'Search Plugins' ) . '" ';
179 ?><form class="search-form search-plugins" method="get">
180 <input type="hidden" name="tab" value="search" />
181 <?php if ( $type_selector ) : ?>
182 <select name="type" id="typeselector">
183 <option value="term"<?php selected('term', $type) ?>><?php _e('Keyword'); ?></option>
184 <option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option>
185 <option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option>
188 <label><span class="screen-reader-text"><?php _e('Search Plugins'); ?></span>
189 <input type="search" name="s" value="<?php echo esc_attr($term) ?>" <?php echo $input_attrs; ?>/>
191 <?php submit_button( __( 'Search Plugins' ), $button_type, false, false, array( 'id' => 'search-submit' ) ); ?>
199 function install_plugins_upload() {
201 <div class="upload-plugin">
202 <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.'); ?></p>
203 <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo self_admin_url('update.php?action=upload-plugin'); ?>">
204 <?php wp_nonce_field( 'plugin-upload'); ?>
205 <label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label>
206 <input type="file" id="pluginzip" name="pluginzip" />
207 <?php submit_button( __( 'Install Now' ), 'button', 'install-plugin-submit', false ); ?>
212 add_action('install_plugins_upload', 'install_plugins_upload' );
215 * Show a username form for the favorites page
219 function install_plugins_favorites_form() {
220 $user = ! empty( $_GET['user'] ) ? wp_unslash( $_GET['user'] ) : get_user_option( 'wporg_favorites' );
222 <p class="install-help"><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>
224 <input type="hidden" name="tab" value="favorites" />
226 <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>
227 <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />
228 <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />
235 * Display plugin content based on plugin list.
239 function display_plugins_table() {
240 global $wp_list_table;
242 switch ( current_filter() ) {
243 case 'install_plugins_favorites' :
244 if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {
248 case 'install_plugins_recommended' :
249 echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>';
254 <form id="plugin-filter" method="post">
255 <?php $wp_list_table->display(); ?>
259 add_action( 'install_plugins_search', 'display_plugins_table' );
260 add_action( 'install_plugins_popular', 'display_plugins_table' );
261 add_action( 'install_plugins_recommended', 'display_plugins_table' );
262 add_action( 'install_plugins_new', 'display_plugins_table' );
263 add_action( 'install_plugins_beta', 'display_plugins_table' );
264 add_action( 'install_plugins_favorites', 'display_plugins_table' );
267 * Determine the status we can perform on a plugin.
271 function install_plugin_install_status($api, $loop = false) {
272 // This function is called recursively, $loop prevents further loops.
273 if ( is_array($api) )
274 $api = (object) $api;
276 // Default to a "new" plugin
279 $update_file = false;
282 * Check to see if this plugin is known to be installed,
283 * and has an update awaiting it.
285 $update_plugins = get_site_transient('update_plugins');
286 if ( isset( $update_plugins->response ) ) {
287 foreach ( (array)$update_plugins->response as $file => $plugin ) {
288 if ( $plugin->slug === $api->slug ) {
289 $status = 'update_available';
290 $update_file = $file;
291 $version = $plugin->new_version;
292 if ( current_user_can('update_plugins') )
293 $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
299 if ( 'install' == $status ) {
300 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
301 $installed_plugin = get_plugins('/' . $api->slug);
302 if ( empty($installed_plugin) ) {
303 if ( current_user_can('install_plugins') )
304 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
306 $key = array_keys( $installed_plugin );
307 $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
308 $update_file = $api->slug . '/' . $key;
309 if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
310 $status = 'latest_installed';
311 } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
312 $status = 'newer_installed';
313 $version = $installed_plugin[ $key ]['Version'];
315 //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
317 delete_site_transient('update_plugins');
319 return install_plugin_install_status($api, true);
324 // "install" & no directory with that slug
325 if ( current_user_can('install_plugins') )
326 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
329 if ( isset($_GET['from']) )
330 $url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) );
332 $file = $update_file;
333 return compact( 'status', 'url', 'version', 'file' );
337 * Display plugin information in dialog box form.
341 function install_plugin_information() {
344 if ( empty( $_REQUEST['plugin'] ) ) {
348 $api = plugins_api( 'plugin_information', array(
349 'slug' => wp_unslash( $_REQUEST['plugin'] ),
350 'is_ssl' => is_ssl(),
354 'downloaded' => false,
355 'active_installs' => true
359 if ( is_wp_error( $api ) ) {
363 $plugins_allowedtags = array(
364 'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ),
365 'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ),
366 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
367 'div' => array( 'class' => array() ), 'span' => array( 'class' => array() ),
368 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
369 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
370 'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() )
373 $plugins_section_titles = array(
374 'description' => _x( 'Description', 'Plugin installer section title' ),
375 'installation' => _x( 'Installation', 'Plugin installer section title' ),
376 'faq' => _x( 'FAQ', 'Plugin installer section title' ),
377 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ),
378 'changelog' => _x( 'Changelog', 'Plugin installer section title' ),
379 'reviews' => _x( 'Reviews', 'Plugin installer section title' ),
380 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' )
384 foreach ( (array) $api->sections as $section_name => $content ) {
385 $api->sections[$section_name] = wp_kses( $content, $plugins_allowedtags );
388 foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
389 if ( isset( $api->$key ) ) {
390 $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
394 $_tab = esc_attr( $tab );
396 $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; // Default to the Description tab, Do not translate, API returns English.
397 if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
398 $section_titles = array_keys( (array) $api->sections );
399 $section = reset( $section_titles );
402 iframe_header( __( 'Plugin Install' ) );
406 if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) {
407 $_with_banner = 'with-banner';
408 $low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low'];
409 $high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high'];
411 <style type="text/css">
412 #plugin-information-title.with-banner {
413 background-image: url( <?php echo esc_url( $low ); ?> );
415 @media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) {
416 #plugin-information-title.with-banner {
417 background-image: url( <?php echo esc_url( $high ); ?> );
424 echo '<div id="plugin-information-scrollable">';
425 echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>";
426 echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n";
428 foreach ( (array) $api->sections as $section_name => $content ) {
429 if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) {
433 if ( isset( $plugins_section_titles[ $section_name ] ) ) {
434 $title = $plugins_section_titles[ $section_name ];
436 $title = ucwords( str_replace( '_', ' ', $section_name ) );
439 $class = ( $section_name === $section ) ? ' class="current"' : '';
440 $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
441 $href = esc_url( $href );
442 $san_section = esc_attr( $section_name );
443 echo "\t<a name='$san_section' href='$href' $class>$title</a>\n";
448 $date_format = __( 'M j, Y @ H:i' );
449 $last_updated_timestamp = strtotime( $api->last_updated );
451 <div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'>
454 <?php if ( ! empty( $api->version ) ) { ?>
455 <li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li>
456 <?php } if ( ! empty( $api->author ) ) { ?>
457 <li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li>
458 <?php } if ( ! empty( $api->last_updated ) ) { ?>
459 <li><strong><?php _e( 'Last Updated:' ); ?></strong> <span title="<?php echo esc_attr( date_i18n( $date_format, $last_updated_timestamp ) ); ?>">
460 <?php printf( __( '%s ago' ), human_time_diff( $last_updated_timestamp ) ); ?>
462 <?php } if ( ! empty( $api->requires ) ) { ?>
463 <li><strong><?php _e( 'Requires WordPress Version:' ); ?></strong> <?php printf( __( '%s or higher' ), $api->requires ); ?></li>
464 <?php } if ( ! empty( $api->tested ) ) { ?>
465 <li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li>
466 <?php } if ( ! empty( $api->active_installs ) ) { ?>
467 <li><strong><?php _e( 'Active Installs:' ); ?></strong> <?php
468 if ( $api->active_installs >= 1000000 ) {
469 _ex( '1+ Million', 'Active plugin installs' );
471 echo number_format_i18n( $api->active_installs ) . '+';
474 <?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?>
475 <li><a target="_blank" href="https://wordpress.org/plugins/<?php echo $api->slug; ?>/"><?php _e( 'WordPress.org Plugin Page »' ); ?></a></li>
476 <?php } if ( ! empty( $api->homepage ) ) { ?>
477 <li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage »' ); ?></a></li>
478 <?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?>
479 <li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a></li>
482 <?php if ( ! empty( $api->rating ) ) { ?>
483 <h3><?php _e( 'Average Rating' ); ?></h3>
484 <?php wp_star_rating( array( 'rating' => $api->rating, 'type' => 'percent', 'number' => $api->num_ratings ) ); ?>
485 <small><?php printf( _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ), number_format_i18n( $api->num_ratings ) ); ?></small>
488 if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) {
489 foreach( $api->ratings as $key => $ratecount ) {
490 // Avoid div-by-zero.
491 $_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0;
493 <div class="counter-container">
494 <span class="counter-label"><a href="https://wordpress.org/support/view/plugin-reviews/<?php echo $api->slug; ?>?filter=<?php echo $key; ?>"
496 title="<?php echo esc_attr( sprintf( _n( 'Click to see reviews that provided a rating of %d star', 'Click to see reviews that provided a rating of %d stars', $key ), $key ) ); ?>"><?php printf( _n( '%d star', '%d stars', $key ), $key ); ?></a></span>
497 <span class="counter-back">
498 <span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span>
500 <span class="counter-count"><?php echo number_format_i18n( $ratecount ); ?></span>
505 if ( ! empty( $api->contributors ) ) { ?>
506 <h3><?php _e( 'Contributors' ); ?></h3>
507 <ul class="contributors">
509 foreach ( (array) $api->contributors as $contrib_username => $contrib_profile ) {
510 if ( empty( $contrib_username ) && empty( $contrib_profile ) ) {
513 if ( empty( $contrib_username ) ) {
514 $contrib_username = preg_replace( '/^.+\/(.+)\/?$/', '\1', $contrib_profile );
516 $contrib_username = sanitize_user( $contrib_username );
517 if ( empty( $contrib_profile ) ) {
518 echo "<li><img src='https://wordpress.org/grav-redirect.php?user={$contrib_username}&s=36' width='18' height='18' />{$contrib_username}</li>";
520 echo "<li><a href='{$contrib_profile}' target='_blank'><img src='https://wordpress.org/grav-redirect.php?user={$contrib_username}&s=36' width='18' height='18' />{$contrib_username}</a></li>";
525 <?php if ( ! empty( $api->donate_link ) ) { ?>
526 <a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a>
530 <div id="section-holder" class="wrap">
532 if ( ! empty( $api->tested ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->tested ) ), $api->tested, '>' ) ) {
533 echo '<div class="notice notice-warning"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>';
534 } elseif ( ! empty( $api->requires ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->requires ) ), $api->requires, '<' ) ) {
535 echo '<div class="notice notice-warning"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been marked as compatible</strong> with your version of WordPress.') . '</p></div>';
538 foreach ( (array) $api->sections as $section_name => $content ) {
539 $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' );
540 $content = links_add_target( $content, '_blank' );
542 $san_section = esc_attr( $section_name );
544 $display = ( $section_name === $section ) ? 'block' : 'none';
546 echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n";
552 echo "</div>\n"; // #plugin-information-scrollable
553 echo "<div id='$tab-footer'>\n";
554 if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) {
555 $status = install_plugin_install_status( $api );
556 switch ( $status['status'] ) {
558 if ( $status['url'] ) {
559 echo '<a class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Now' ) . '</a>';
562 case 'update_available':
563 if ( $status['url'] ) {
564 echo '<a data-slug="' . esc_attr( $api->slug ) . '" id="plugin_update_from_iframe" class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Update Now' ) .'</a>';
567 case 'newer_installed':
568 echo '<a class="button button-primary right disabled">' . sprintf( __( 'Newer Version (%s) Installed'), $status['version'] ) . '</a>';
570 case 'latest_installed':
571 echo '<a class="button button-primary right disabled">' . __( 'Latest Version Installed' ) . '</a>';
580 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');