Description: WordPress Plugin Install Administration API
1 <?php 2 /** 3 * WordPress Plugin Install Administration API 4 * 5 * @package WordPress 6 * @subpackage Administration 7 */ 8 9 /** 10 * Retrieve plugin installer pages from WordPress 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, '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 19 * object is returned. 20 * 21 * The second filter, 'plugins_api', is the result that would be returned. 22 * 23 * @since 2.7.0 24 * 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. 28 */ 29 function plugins_api($action, $args = null) { 30 31 if ( is_array($args) ) 32 $args = (object)$args; 33 34 if ( !isset($args->per_page) ) 35 $args->per_page = 24; 36 37 // Allows a plugin to override the WordPress.org API entirely. 38 // Use the filter 'plugins_api_result' to merely 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); 42 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 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="http://wordpress.org/support/">support forums</a>.' ), $request->get_error_message() ); 47 } else { 48 $res = maybe_unserialize( wp_remote_retrieve_body( $request ) ); 49 if ( ! is_object( $res ) && ! is_array( $res ) ) 50 $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="http://wordpress.org/support/">support forums</a>.' ), wp_remote_retrieve_body( $request ) ); 51 } 52 } elseif ( !is_wp_error($res) ) { 53 $res->external = true; 54 } 55 56 return apply_filters('plugins_api_result', $res, $action, $args); 57 } 58 59 /** 60 * Retrieve popular WordPress plugin tags. 61 * 62 * @since 2.7.0 63 * 64 * @param array $args 65 * @return array 66 */ 67 function install_popular_tags( $args = array() ) { 68 $key = md5(serialize($args)); 69 if ( false !== ($tags = get_site_transient('poptags_' . $key) ) ) 70 return $tags; 71 72 $tags = plugins_api('hot_tags', $args); 73 74 if ( is_wp_error($tags) ) 75 return $tags; 76 77 set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS ); 78 79 return $tags; 80 } 81 82 function install_dashboard() { 83 ?> 84 <p><?php printf( __( '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 <a href="%s">this page</a>.' ), self_admin_url( 'plugin-install.php?tab=upload' ) ); ?></p> 85 86 <h4><?php _e('Search') ?></h4> 87 <?php install_search_form( false ); ?> 88 89 <h4><?php _e('Popular tags') ?></h4> 90 <p class="install-help"><?php _e('You may also browse based on the most popular tags in the Plugin Directory:') ?></p> 91 <?php 92 93 $api_tags = install_popular_tags(); 94 95 echo '<p class="popular-tags">'; 96 if ( is_wp_error($api_tags) ) { 97 echo $api_tags->get_error_message(); 98 } else { 99 //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud() 100 $tags = array(); 101 foreach ( (array)$api_tags as $tag ) 102 $tags[ $tag['name'] ] = (object) array( 103 'link' => esc_url( self_admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ), 104 'name' => $tag['name'], 105 'id' => sanitize_title_with_dashes($tag['name']), 106 'count' => $tag['count'] ); 107 echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) ); 108 } 109 echo '</p><br class="clear" />'; 110 } 111 add_action('install_plugins_dashboard', 'install_dashboard'); 112 113 /** 114 * Display search form for searching plugins. 115 * 116 * @since 2.7.0 117 */ 118 function install_search_form( $type_selector = true ) { 119 $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : 'term'; 120 $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : ''; 121 122 ?><form id="search-plugins" method="get" action=""> 123 <input type="hidden" name="tab" value="search" /> 124 <?php if ( $type_selector ) : ?> 125 <select name="type" id="typeselector"> 126 <option value="term"<?php selected('term', $type) ?>><?php _e('Keyword'); ?></option> 127 <option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option> 128 <option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option> 129 </select> 130 <?php endif; ?> 131 <input type="search" name="s" value="<?php echo esc_attr($term) ?>" autofocus="autofocus" /> 132 <label class="screen-reader-text" for="plugin-search-input"><?php _e('Search Plugins'); ?></label> 133 <?php submit_button( __( 'Search Plugins' ), 'button', 'plugin-search-input', false ); ?> 134 </form><?php 135 } 136 137 /** 138 * Upload from zip 139 * @since 2.8.0 140 * 141 * @param string $page 142 */ 143 function install_plugins_upload( $page = 1 ) { 144 ?> 145 <h4><?php _e('Install a plugin in .zip format'); ?></h4> 146 <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.'); ?></p> 147 <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo self_admin_url('update.php?action=upload-plugin'); ?>"> 148 <?php wp_nonce_field( 'plugin-upload'); ?> 149 <label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label> 150 <input type="file" id="pluginzip" name="pluginzip" /> 151 <?php submit_button( __( 'Install Now' ), 'button', 'install-plugin-submit', false ); ?> 152 </form> 153 <?php 154 } 155 add_action('install_plugins_upload', 'install_plugins_upload', 10, 1); 156 157 /** 158 * Show a username form for the favorites page 159 * @since 3.5.0 160 * 161 */ 162 function install_plugins_favorites_form() { 163 $user = ! empty( $_GET['user'] ) ? stripslashes( $_GET['user'] ) : get_user_option( 'wporg_favorites' ); 164 ?> 165 <p class="install-help"><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p> 166 <form method="get" action=""> 167 <input type="hidden" name="tab" value="favorites" /> 168 <p> 169 <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label> 170 <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" /> 171 <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" /> 172 </p> 173 </form> 174 <?php 175 } 176 177 /** 178 * Display plugin content based on plugin list. 179 * 180 * @since 2.7.0 181 */ 182 function display_plugins_table() { 183 global $wp_list_table; 184 185 if ( current_filter() == 'install_plugins_favorites' && empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) 186 return; 187 188 $wp_list_table->display(); 189 } 190 add_action( 'install_plugins_search', 'display_plugins_table' ); 191 add_action( 'install_plugins_featured', 'display_plugins_table' ); 192 add_action( 'install_plugins_popular', 'display_plugins_table' ); 193 add_action( 'install_plugins_new', 'display_plugins_table' ); 194 add_action( 'install_plugins_favorites', 'display_plugins_table' ); 195 196 /** 197 * Determine the status we can perform on a plugin. 198 * 199 * @since 3.0.0 200 */ 201 function install_plugin_install_status($api, $loop = false) { 202 // this function is called recursively, $loop prevents further loops. 203 if ( is_array($api) ) 204 $api = (object) $api; 205 206 //Default to a "new" plugin 207 $status = 'install'; 208 $url = false; 209 210 //Check to see if this plugin is known to be installed, and has an update awaiting it. 211 $update_plugins = get_site_transient('update_plugins'); 212 if ( isset( $update_plugins->response ) ) { 213 foreach ( (array)$update_plugins->response as $file => $plugin ) { 214 if ( $plugin->slug === $api->slug ) { 215 $status = 'update_available'; 216 $update_file = $file; 217 $version = $plugin->new_version; 218 if ( current_user_can('update_plugins') ) 219 $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file); 220 break; 221 } 222 } 223 } 224 225 if ( 'install' == $status ) { 226 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) { 227 $installed_plugin = get_plugins('/' . $api->slug); 228 if ( empty($installed_plugin) ) { 229 if ( current_user_can('install_plugins') ) 230 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug); 231 } else { 232 $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 233 if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){ 234 $status = 'latest_installed'; 235 } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) { 236 $status = 'newer_installed'; 237 $version = $installed_plugin[ $key ]['Version']; 238 } else { 239 //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh 240 if ( ! $loop ) { 241 delete_site_transient('update_plugins'); 242 wp_update_plugins(); 243 return install_plugin_install_status($api, true); 244 } 245 } 246 } 247 } else { 248 // "install" & no directory with that slug 249 if ( current_user_can('install_plugins') ) 250 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug); 251 } 252 } 253 if ( isset($_GET['from']) ) 254 $url .= '&from=' . urlencode(stripslashes($_GET['from'])); 255 256 return compact('status', 'url', 'version'); 257 } 258 259 /** 260 * Display plugin information in dialog box form. 261 * 262 * @since 2.7.0 263 */ 264 function install_plugin_information() { 265 global $tab; 266 267 $api = plugins_api('plugin_information', array('slug' => stripslashes( $_REQUEST['plugin'] ) )); 268 269 if ( is_wp_error($api) ) 270 wp_die($api); 271 272 $plugins_allowedtags = array( 273 'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ), 274 'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ), 275 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(), 276 'div' => array(), 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(), 277 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(), 278 'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() ) 279 ); 280 281 $plugins_section_titles = array( 282 'description' => _x('Description', 'Plugin installer section title'), 283 'installation' => _x('Installation', 'Plugin installer section title'), 284 'faq' => _x('FAQ', 'Plugin installer section title'), 285 'screenshots' => _x('Screenshots', 'Plugin installer section title'), 286 'changelog' => _x('Changelog', 'Plugin installer section title'), 287 'other_notes' => _x('Other Notes', 'Plugin installer section title') 288 ); 289 290 //Sanitize HTML 291 foreach ( (array)$api->sections as $section_name => $content ) 292 $api->sections[$section_name] = wp_kses($content, $plugins_allowedtags); 293 foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) { 294 if ( isset( $api->$key ) ) 295 $api->$key = wp_kses( $api->$key, $plugins_allowedtags ); 296 } 297 298 $section = isset($_REQUEST['section']) ? stripslashes( $_REQUEST['section'] ) : 'description'; //Default to the Description tab, Do not translate, API returns English. 299 if ( empty($section) || ! isset($api->sections[ $section ]) ) 300 $section = array_shift( $section_titles = array_keys((array)$api->sections) ); 301 302 iframe_header( __('Plugin Install') ); 303 echo "<div id='$tab-header'>\n"; 304 echo "<ul id='sidemenu'>\n"; 305 foreach ( (array)$api->sections as $section_name => $content ) { 306 307 if ( isset( $plugins_section_titles[ $section_name ] ) ) 308 $title = $plugins_section_titles[ $section_name ]; 309 else 310 $title = ucwords( str_replace( '_', ' ', $section_name ) ); 311 312 $class = ( $section_name == $section ) ? ' class="current"' : ''; 313 $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) ); 314 $href = esc_url($href); 315 $san_section = esc_attr( $section_name ); 316 echo "\t<li><a name='$san_section' href='$href' $class>$title</a></li>\n"; 317 } 318 echo "</ul>\n"; 319 echo "</div>\n"; 320 ?> 321 <div class="alignright fyi"> 322 <?php if ( ! empty($api->download_link) && ( current_user_can('install_plugins') || current_user_can('update_plugins') ) ) : ?> 323 <p class="action-button"> 324 <?php 325 $status = install_plugin_install_status($api); 326 switch ( $status['status'] ) { 327 case 'install': 328 if ( $status['url'] ) 329 echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Now') . '</a>'; 330 break; 331 case 'update_available': 332 if ( $status['url'] ) 333 echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Update Now') .'</a>'; 334 break; 335 case 'newer_installed': 336 echo '<a>' . sprintf(__('Newer Version (%s) Installed'), $status['version']) . '</a>'; 337 break; 338 case 'latest_installed': 339 echo '<a>' . __('Latest Version Installed') . '</a>'; 340 break; 341 } 342 ?> 343 </p> 344 <?php endif; ?> 345 <h2 class="mainheader"><?php /* translators: For Your Information */ _e('FYI') ?></h2> 346 <ul> 347 <?php if ( ! empty($api->version) ) : ?> 348 <li><strong><?php _e('Version:') ?></strong> <?php echo $api->version ?></li> 349 <?php endif; if ( ! empty($api->author) ) : ?> 350 <li><strong><?php _e('Author:') ?></strong> <?php echo links_add_target($api->author, '_blank') ?></li> 351 <?php endif; if ( ! empty($api->last_updated) ) : ?> 352 <li><strong><?php _e('Last Updated:') ?></strong> <span title="<?php echo $api->last_updated ?>"><?php 353 printf( __('%s ago'), human_time_diff(strtotime($api->last_updated)) ) ?></span></li> 354 <?php endif; if ( ! empty($api->requires) ) : ?> 355 <li><strong><?php _e('Requires WordPress Version:') ?></strong> <?php printf(__('%s or higher'), $api->requires) ?></li> 356 <?php endif; if ( ! empty($api->tested) ) : ?> 357 <li><strong><?php _e('Compatible up to:') ?></strong> <?php echo $api->tested ?></li> 358 <?php endif; if ( ! empty($api->downloaded) ) : ?> 359 <li><strong><?php _e('Downloaded:') ?></strong> <?php printf(_n('%s time', '%s times', $api->downloaded), number_format_i18n($api->downloaded)) ?></li> 360 <?php endif; if ( ! empty($api->slug) && empty($api->external) ) : ?> 361 <li><a target="_blank" href="http://wordpress.org/extend/plugins/<?php echo $api->slug ?>/"><?php _e('WordPress.org Plugin Page »') ?></a></li> 362 <?php endif; if ( ! empty($api->homepage) ) : ?> 363 <li><a target="_blank" href="<?php echo $api->homepage ?>"><?php _e('Plugin Homepage »') ?></a></li> 364 <?php endif; ?> 365 </ul> 366 <?php if ( ! empty($api->rating) ) : ?> 367 <h2><?php _e('Average Rating') ?></h2> 368 <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)); ?>"> 369 <div class="star star-rating" style="width: <?php echo esc_attr( str_replace( ',', '.', $api->rating ) ); ?>px"></div> 370 </div> 371 <small><?php printf(_n('(based on %s rating)', '(based on %s ratings)', $api->num_ratings), number_format_i18n($api->num_ratings)); ?></small> 372 <?php endif; ?> 373 </div> 374 <div id="section-holder" class="wrap"> 375 <?php 376 if ( !empty($api->tested) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->tested)), $api->tested, '>') ) 377 echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>'; 378 379 else if ( !empty($api->requires) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->requires)), $api->requires, '<') ) 380 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>'; 381 382 foreach ( (array)$api->sections as $section_name => $content ) { 383 384 if ( isset( $plugins_section_titles[ $section_name ] ) ) 385 $title = $plugins_section_titles[ $section_name ]; 386 else 387 $title = ucwords( str_replace( '_', ' ', $section_name ) ); 388 389 $content = links_add_base_url($content, 'http://wordpress.org/extend/plugins/' . $api->slug . '/'); 390 $content = links_add_target($content, '_blank'); 391 392 $san_section = esc_attr( $section_name ); 393 394 $display = ( $section_name == $section ) ? 'block' : 'none'; 395 396 echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n"; 397 echo "\t\t<h2 class='long-header'>$title</h2>"; 398 echo $content; 399 echo "\t</div>\n"; 400 } 401 echo "</div>\n"; 402 403 iframe_footer(); 404 exit; 405 } 406 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
title