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 * overridding 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;
34 if ( !isset($args->per_page) )
37 // Allows a plugin to override the WordPress.org API entirely.
38 // Use the filter 'plugins_api_result' to mearly add results.
39 // Please ensure that a object is returned from the following filters.
40 $args = apply_filters('plugins_api_args', $args, $action);
41 $res = apply_filters('plugins_api', false, $action, $args);
43 if ( false === $res ) {
44 $request = wp_remote_post('http://api.wordpress.org/plugins/info/1.0/', array( 'timeout' => 15, 'body' => array('action' => $action, 'request' => serialize($args))) );
45 if ( is_wp_error($request) ) {
46 $res = new WP_Error('plugins_api_failed', __('An Unexpected HTTP Error occurred during the API request.'), $request->get_error_message() );
48 $res = unserialize($request['body']);
50 $res = new WP_Error('plugins_api_failed', __('An unknown error occurred.'), $request['body']);
52 } elseif ( !is_wp_error($res) ) {
53 $res->external = true;
56 return apply_filters('plugins_api_result', $res, $action, $args);
60 * Retrieve popular WordPress plugin tags.
67 function install_popular_tags( $args = array() ) {
68 if ( ! ($cache = wp_cache_get('popular_tags', 'api')) && ! ($cache = get_option('wporg_popular_tags')) )
69 add_option('wporg_popular_tags', array(), '', 'no'); ///No autoload.
71 if ( $cache && $cache->timeout + 3 * 60 * 60 > time() )
72 return $cache->cached;
74 $tags = plugins_api('hot_tags', $args);
76 if ( is_wp_error($tags) )
79 $cache = (object) array('timeout' => time(), 'cached' => $tags);
81 update_option('wporg_popular_tags', $cache);
82 wp_cache_set('popular_tags', $cache, 'api');
86 add_action('install_plugins_search', 'install_search', 10, 1);
89 * Display search results and display as tag cloud.
95 function install_search($page) {
96 $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
97 $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
103 $args['tag'] = sanitize_title_with_dashes($term);
106 $args['search'] = $term;
109 $args['author'] = $term;
113 $args['page'] = $page;
115 $api = plugins_api('query_plugins', $args);
117 if ( is_wp_error($api) )
120 add_action('install_plugins_table_header', 'install_search_form');
122 display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
127 add_action('install_plugins_dashboard', 'install_dashboard');
128 function install_dashboard() {
130 <p><?php _e('Plugins extend and expand the functionality of WordPress. You may automatically install plugins from the <a href="http://wordpress.org/extend/plugins/">WordPress Plugin Directory</a> or upload a plugin in .zip format via this page.') ?></p>
132 <h4><?php _e('Search') ?></h4>
133 <p class="install-help"><?php _e('Search for plugins by keyword, author, or tag.') ?></p>
134 <?php install_search_form(); ?>
136 <h4><?php _e('Popular tags') ?></h4>
137 <p class="install-help"><?php _e('You may also browse based on the most popular tags in the Plugin Directory:') ?></p>
140 $api_tags = install_popular_tags();
142 echo '<p class="popular-tags">';
143 if ( is_wp_error($api_tags) ) {
144 echo $api_tags->get_error_message();
146 //Set up the tags in a way which can be interprated by wp_generate_tag_cloud()
148 foreach ( (array)$api_tags as $tag )
149 $tags[ $tag['name'] ] = (object) array(
150 'link' => esc_url( admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
151 'name' => $tag['name'],
152 'id' => sanitize_title_with_dashes($tag['name']),
153 'count' => $tag['count'] );
154 echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%d plugin'), 'multiple_text' => __('%d plugins') ) );
156 echo '</p><br class="clear" />';
160 * Display search form for searching plugins.
164 function install_search_form(){
165 $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
166 $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
168 ?><form id="search-plugins" method="post" action="<?php echo admin_url('plugin-install.php?tab=search'); ?>">
169 <select name="type" id="typeselector">
170 <option value="term"<?php selected('term', $type) ?>><?php _e('Term'); ?></option>
171 <option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option>
172 <option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option>
174 <input type="text" name="s" value="<?php echo esc_attr($term) ?>" />
175 <label class="screen-reader-text" for="plugin-search-input"><?php _e('Search Plugins'); ?></label>
176 <input type="submit" id="plugin-search-input" name="search" value="<?php esc_attr_e('Search Plugins'); ?>" class="button" />
180 add_action('install_plugins_featured', 'install_featured', 10, 1);
182 * Display featured plugins.
186 * @param string $page
188 function install_featured($page = 1) {
189 $args = array('browse' => 'featured', 'page' => $page);
190 $api = plugins_api('query_plugins', $args);
191 if ( is_wp_error($api) )
192 wp_die($api->get_error_message() . '</p> <p class="hide-if-no-js"><a href="#" onclick="document.location.reload(); return false;">' . __('Try again') . '</a>');
193 display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
196 add_action('install_plugins_popular', 'install_popular', 10, 1);
198 * Display popular plugins.
202 * @param string $page
204 function install_popular($page = 1) {
205 $args = array('browse' => 'popular', 'page' => $page);
206 $api = plugins_api('query_plugins', $args);
207 if ( is_wp_error($api) )
208 wp_die($api->get_error_message() . '</p> <p class="hide-if-no-js"><a href="#" onclick="document.location.reload(); return false;">' . __('Try again') . '</a>');
209 display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
212 add_action('install_plugins_upload', 'install_plugins_upload', 10, 1);
217 * @param string $page
219 function install_plugins_upload( $page = 1 ) {
221 <h4><?php _e('Install a plugin in .zip format') ?></h4>
222 <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.') ?></p>
223 <form method="post" enctype="multipart/form-data" action="<?php echo admin_url('update.php?action=upload-plugin') ?>">
224 <?php wp_nonce_field( 'plugin-upload') ?>
225 <label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label>
226 <input type="file" id="pluginzip" name="pluginzip" />
227 <input type="submit" class="button" value="<?php esc_attr_e('Install Now') ?>" />
232 add_action('install_plugins_new', 'install_new', 10, 1);
234 * Display new plugins.
238 * @param string $page
240 function install_new($page = 1) {
241 $args = array('browse' => 'new', 'page' => $page);
242 $api = plugins_api('query_plugins', $args);
243 if ( is_wp_error($api) )
244 wp_die($api->get_error_message() . '</p> <p class="hide-if-no-js"><a href="#" onclick="document.location.reload(); return false;">' . __('Try again') . '</a>');
245 display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
247 add_action('install_plugins_updated', 'install_updated', 10, 1);
251 * Display recently updated plugins.
255 * @param string $page
257 function install_updated($page = 1) {
258 $args = array('browse' => 'updated', 'page' => $page);
259 $api = plugins_api('query_plugins', $args);
260 if ( is_wp_error($api) )
261 wp_die($api->get_error_message() . '</p> <p class="hide-if-no-js"><a href="#" onclick="document.location.reload(); return false;">' . __('Try again') . '</a>');
262 display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
266 * Display plugin content based on plugin list.
270 * @param array $plugins List of plugins.
271 * @param string $page
272 * @param int $totalpages Number of pages.
274 function display_plugins_table($plugins, $page = 1, $totalpages = 1){
275 $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
276 $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
278 $plugins_allowedtags = array('a' => array('href' => array(),'title' => array(), 'target' => array()),
279 'abbr' => array('title' => array()),'acronym' => array('title' => array()),
280 'code' => array(), 'pre' => array(), 'em' => array(),'strong' => array(),
281 'ul' => array(), 'ol' => array(), 'li' => array(), 'p' => array(), 'br' => array());
284 <div class="tablenav">
285 <div class="alignleft actions">
286 <?php do_action('install_plugins_table_header'); ?>
289 $url = esc_url($_SERVER['REQUEST_URI']);
290 if ( ! empty($term) )
291 $url = add_query_arg('s', $term, $url);
292 if ( ! empty($type) )
293 $url = add_query_arg('type', $type, $url);
295 $page_links = paginate_links( array(
296 'base' => add_query_arg('paged', '%#%', $url),
298 'prev_text' => __('«'),
299 'next_text' => __('»'),
300 'total' => $totalpages,
305 echo "\t\t<div class='tablenav-pages'>$page_links</div>";
309 <table class="widefat" id="install-plugins" cellspacing="0">
312 <th scope="col" class="name"><?php _e('Name'); ?></th>
313 <th scope="col" class="num"><?php _e('Version'); ?></th>
314 <th scope="col" class="num"><?php _e('Rating'); ?></th>
315 <th scope="col" class="desc"><?php _e('Description'); ?></th>
321 <th scope="col" class="name"><?php _e('Name'); ?></th>
322 <th scope="col" class="num"><?php _e('Version'); ?></th>
323 <th scope="col" class="num"><?php _e('Rating'); ?></th>
324 <th scope="col" class="desc"><?php _e('Description'); ?></th>
328 <tbody class="plugins">
330 if ( empty($plugins) )
331 echo '<tr><td colspan="5">', __('No plugins match your request.'), '</td></tr>';
333 foreach ( (array) $plugins as $plugin ){
334 if ( is_object($plugin) )
335 $plugin = (array) $plugin;
337 $title = wp_kses($plugin['name'], $plugins_allowedtags);
338 //Limit description to 400char, and remove any HTML.
339 $description = strip_tags($plugin['description']);
340 if ( strlen($description) > 400 )
341 $description = mb_substr($description, 0, 400) . '…';
342 //remove any trailing entities
343 $description = preg_replace('/&[^;\s]{0,6}$/', '', $description);
344 //strip leading/trailing & multiple consecutive lines
345 $description = trim($description);
346 $description = preg_replace("|(\r?\n)+|", "\n", $description);
348 $description = nl2br($description);
349 $version = wp_kses($plugin['version'], $plugins_allowedtags);
351 $name = strip_tags($title . ' ' . $version);
353 $author = $plugin['author'];
354 if ( ! empty($plugin['author']) )
355 $author = ' <cite>' . sprintf( __('By %s'), $author ) . '.</cite>';
357 $author = wp_kses($author, $plugins_allowedtags);
359 $action_links = array();
360 $action_links[] = '<a href="' . admin_url('plugin-install.php?tab=plugin-information&plugin=' . $plugin['slug'] .
361 '&TB_iframe=true&width=600&height=550') . '" class="thickbox" title="' .
362 esc_attr( sprintf( __( 'More information about %s' ), $name ) ) . '">' . __('Details') . '</a>';
364 if ( current_user_can('install_plugins') || current_user_can('update_plugins') ) {
365 $status = install_plugin_install_status($plugin);
367 switch ( $status['status'] ) {
369 if ( $status['url'] )
370 $action_links[] = '<a class="install-now" href="' . $status['url'] . '" title="' . esc_attr( sprintf( __( 'Install %s' ), $name ) ) . '">' . __('Install Now') . '</a>';
372 case 'update_available':
373 if ( $status['url'] )
374 $action_links[] = '<a href="' . $status['url'] . '" title="' . esc_attr( sprintf( __( 'Update to version %s' ), $status['version'] ) ) . '">' . sprintf( __('Update Now'), $status['version'] ) . '</a>';
376 case 'latest_installed':
377 case 'newer_installed':
378 $action_links[] = '<span title="' . esc_attr__( 'This plugin is already installed and is up to date' ) . ' ">' . __('Installed') . '</span>';
383 $action_links = apply_filters( 'plugin_install_action_links', $action_links, $plugin );
386 <td class="name"><strong><?php echo $title; ?></strong>
387 <div class="action-links"><?php if ( !empty($action_links) ) echo implode(' | ', $action_links); ?></div>
389 <td class="vers"><?php echo $version; ?></td>
391 <div class="star-holder" title="<?php printf(_n('(based on %s rating)', '(based on %s ratings)', $plugin['num_ratings']), number_format_i18n($plugin['num_ratings'])) ?>">
392 <div class="star star-rating" style="width: <?php echo esc_attr($plugin['rating']) ?>px"></div>
393 <div class="star star5"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('5 stars') ?>" /></div>
394 <div class="star star4"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('4 stars') ?>" /></div>
395 <div class="star star3"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('3 stars') ?>" /></div>
396 <div class="star star2"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('2 stars') ?>" /></div>
397 <div class="star star1"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('1 star') ?>" /></div>
400 <td class="desc"><?php echo $description, $author; ?></td>
408 <div class="tablenav">
409 <?php if ( $page_links )
410 echo "\t\t<div class='tablenav-pages'>$page_links</div>"; ?>
417 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');
420 * Determine the status we can perform on a plugin.
424 function install_plugin_install_status($api, $loop = false) {
425 // this function is called recursivly, $loop prevents futhur loops.
426 if ( is_array($api) )
427 $api = (object) $api;
429 //Default to a "new" plugin
433 //Check to see if this plugin is known to be installed, and has an update awaiting it.
434 $update_plugins = get_site_transient('update_plugins');
435 if ( is_object( $update_plugins ) ) {
436 foreach ( (array)$update_plugins->response as $file => $plugin ) {
437 if ( $plugin->slug === $api->slug ) {
438 $status = 'update_available';
439 $update_file = $file;
440 $version = $plugin->new_version;
441 if ( current_user_can('update_plugins') )
442 $url = wp_nonce_url(admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
448 if ( 'install' == $status ) {
449 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
450 $installed_plugin = get_plugins('/' . $api->slug);
451 if ( empty($installed_plugin) ) {
452 if ( current_user_can('install_plugins') )
453 $url = wp_nonce_url(admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
455 $key = array_shift( $key = array_keys($installed_plugin) ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
456 if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
457 $status = 'latest_installed';
458 } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
459 $status = 'newer_installed';
460 $version = $installed_plugin[ $key ]['Version'];
462 //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
464 delete_site_transient('update_plugins');
466 return install_plugin_install_status($api, true);
471 // "install" & no directory with that slug
472 if ( current_user_can('install_plugins') )
473 $url = wp_nonce_url(admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
476 if ( isset($_GET['from']) )
477 $url .= '&from=' . urlencode(stripslashes($_GET['from']));
479 return compact('status', 'url', 'version');
483 * Display plugin information in dialog box form.
487 function install_plugin_information() {
490 $api = plugins_api('plugin_information', array('slug' => stripslashes( $_REQUEST['plugin'] ) ));
492 if ( is_wp_error($api) )
495 $plugins_allowedtags = array('a' => array('href' => array(), 'title' => array(), 'target' => array()),
496 'abbr' => array('title' => array()), 'acronym' => array('title' => array()),
497 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
498 'div' => array(), 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
499 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
500 'img' => array('src' => array(), 'class' => array(), 'alt' => array()));
502 foreach ( (array)$api->sections as $section_name => $content )
503 $api->sections[$section_name] = wp_kses($content, $plugins_allowedtags);
504 foreach ( array('version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug') as $key )
505 $api->$key = wp_kses($api->$key, $plugins_allowedtags);
507 $section = isset($_REQUEST['section']) ? stripslashes( $_REQUEST['section'] ) : 'description'; //Default to the Description tab, Do not translate, API returns English.
508 if ( empty($section) || ! isset($api->sections[ $section ]) )
509 $section = array_shift( $section_titles = array_keys((array)$api->sections) );
511 iframe_header( __('Plugin Install') );
512 echo "<div id='$tab-header'>\n";
513 echo "<ul id='sidemenu'>\n";
514 foreach ( (array)$api->sections as $section_name => $content ) {
516 $title = $section_name;
517 $title = ucwords(str_replace('_', ' ', $title));
519 $class = ( $section_name == $section ) ? ' class="current"' : '';
520 $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
521 $href = esc_url($href);
522 $san_title = esc_attr(sanitize_title_with_dashes($title));
523 echo "\t<li><a name='$san_title' target='' href='$href'$class>$title</a></li>\n";
528 <div class="alignright fyi">
529 <?php if ( ! empty($api->download_link) && ( current_user_can('install_plugins') || current_user_can('update_plugins') ) ) : ?>
530 <p class="action-button">
532 $status = install_plugin_install_status($api);
533 switch ( $status['status'] ) {
535 if ( $status['url'] )
536 echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Now') . '</a>';
538 case 'update_available':
539 if ( $status['url'] )
540 echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Update Now') .'</a>';
542 case 'newer_installed':
543 echo '<a>' . sprintf(__('Newer Version (%s) Installed'), $status['version']) . '</a>';
545 case 'latest_installed':
546 echo '<a>' . __('Latest Version Installed') . '</a>';
552 <h2 class="mainheader"><?php /* translators: For Your Information */ _e('FYI') ?></h2>
554 <?php if ( ! empty($api->version) ) : ?>
555 <li><strong><?php _e('Version:') ?></strong> <?php echo $api->version ?></li>
556 <?php endif; if ( ! empty($api->author) ) : ?>
557 <li><strong><?php _e('Author:') ?></strong> <?php echo links_add_target($api->author, '_blank') ?></li>
558 <?php endif; if ( ! empty($api->last_updated) ) : ?>
559 <li><strong><?php _e('Last Updated:') ?></strong> <span title="<?php echo $api->last_updated ?>"><?php
560 printf( __('%s ago'), human_time_diff(strtotime($api->last_updated)) ) ?></span></li>
561 <?php endif; if ( ! empty($api->requires) ) : ?>
562 <li><strong><?php _e('Requires WordPress Version:') ?></strong> <?php printf(__('%s or higher'), $api->requires) ?></li>
563 <?php endif; if ( ! empty($api->tested) ) : ?>
564 <li><strong><?php _e('Compatible up to:') ?></strong> <?php echo $api->tested ?></li>
565 <?php endif; if ( ! empty($api->downloaded) ) : ?>
566 <li><strong><?php _e('Downloaded:') ?></strong> <?php printf(_n('%s time', '%s times', $api->downloaded), number_format_i18n($api->downloaded)) ?></li>
567 <?php endif; if ( ! empty($api->slug) && empty($api->external) ) : ?>
568 <li><a target="_blank" href="http://wordpress.org/extend/plugins/<?php echo $api->slug ?>/"><?php _e('WordPress.org Plugin Page »') ?></a></li>
569 <?php endif; if ( ! empty($api->homepage) ) : ?>
570 <li><a target="_blank" href="<?php echo $api->homepage ?>"><?php _e('Plugin Homepage »') ?></a></li>
573 <?php if ( ! empty($api->rating) ) : ?>
574 <h2><?php _e('Average Rating') ?></h2>
575 <div class="star-holder" title="<?php printf(_n('(based on %s rating)', '(based on %s ratings)', $api->num_ratings), number_format_i18n($api->num_ratings)); ?>">
576 <div class="star star-rating" style="width: <?php echo esc_attr($api->rating) ?>px"></div>
577 <div class="star star5"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('5 stars') ?>" /></div>
578 <div class="star star4"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('4 stars') ?>" /></div>
579 <div class="star star3"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('3 stars') ?>" /></div>
580 <div class="star star2"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('2 stars') ?>" /></div>
581 <div class="star star1"><img src="<?php echo admin_url('images/star.gif'); ?>" alt="<?php _e('1 star') ?>" /></div>
583 <small><?php printf(_n('(based on %s rating)', '(based on %s ratings)', $api->num_ratings), number_format_i18n($api->num_ratings)); ?></small>
586 <div id="section-holder" class="wrap">
588 if ( !empty($api->tested) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->tested)), $api->tested, '>') )
589 echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>';
591 else if ( !empty($api->requires) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->requires)), $api->requires, '<') )
592 echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been marked as compatible</strong> with your version of WordPress.') . '</p></div>';
594 foreach ( (array)$api->sections as $section_name => $content ) {
595 $title = $section_name;
596 $title[0] = strtoupper($title[0]);
597 $title = str_replace('_', ' ', $title);
599 $content = links_add_base_url($content, 'http://wordpress.org/extend/plugins/' . $api->slug . '/');
600 $content = links_add_target($content, '_blank');
602 $san_title = esc_attr(sanitize_title_with_dashes($title));
604 $display = ( $section_name == $section ) ? 'block' : 'none';
606 echo "\t<div id='section-{$san_title}' class='section' style='display: {$display};'>\n";
607 echo "\t\t<h2 class='long-header'>$title</h2>";