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;
34
if ( !isset($args->per_page) )
38
* Override the Plugin Install API arguments.
40
* Please ensure that an object is returned.
44
* @param object $args Plugin API arguments.
45
* @param string $action The type of information being requested from the Plugin Install API.
47
$args = apply_filters( 'plugins_api_args', $args, $action );
50
* Allows a plugin to override the WordPress.org Plugin Install API entirely.
52
* Please ensure that an object is returned.
56
* @param bool|object $result The result object. Default false.
57
* @param string $action The type of information being requested from the Plugin Install API.
58
* @param object $args Plugin API arguments.
60
$res = apply_filters( 'plugins_api', false, $action, $args );
62
if ( false === $res ) {
63
$url = $http_url = 'http://api.wordpress.org/plugins/info/1.0/';
64
if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
65
$url = set_url_scheme( $url, 'https' );
71
'request' => serialize( $args )
74
$request = wp_remote_post( $url, $args );
76
if ( $ssl && is_wp_error( $request ) ) {
77
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 );
78
$request = wp_remote_post( $http_url, $args );
81
if ( is_wp_error($request) ) {
82
$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() );
84
$res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
85
if ( ! is_object( $res ) && ! is_array( $res ) )
86
$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 ) );
88
} elseif ( !is_wp_error($res) ) {
89
$res->external = true;
93
* Filter the Plugin Install API response results.
97
* @param object|WP_Error $res Response object or WP_Error.
98
* @param string $action The type of information being requested from the Plugin Install API.
99
* @param object $args Plugin API arguments.
101
return apply_filters( 'plugins_api_result', $res, $action, $args );
105
* Retrieve popular WordPress plugin tags.
112
function install_popular_tags( $args = array() ) {
113
$key = md5(serialize($args));
114
if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
117
$tags = plugins_api('hot_tags', $args);
119
if ( is_wp_error($tags) )
122
set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
127
function install_dashboard() {
129
<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>
131
<?php display_plugins_table(); ?>
133
<h3><?php _e( 'Popular tags' ) ?></h3>
134
<p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ) ?></p>
137
$api_tags = install_popular_tags();
139
echo '<p class="popular-tags">';
140
if ( is_wp_error($api_tags) ) {
141
echo $api_tags->get_error_message();
143
//Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
145
foreach ( (array)$api_tags as $tag )
146
$tags[ $tag['name'] ] = (object) array(
147
'link' => esc_url( self_admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
148
'name' => $tag['name'],
149
'id' => sanitize_title_with_dashes($tag['name']),
150
'count' => $tag['count'] );
151
echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) );
153
echo '</p><br class="clear" />';
155
add_action( 'install_plugins_featured', 'install_dashboard' );
158
* Display search form for searching plugins.
162
function install_search_form( $type_selector = true ) {
163
$type = isset($_REQUEST['type']) ? wp_unslash( $_REQUEST['type'] ) : 'term';
164
$term = isset($_REQUEST['s']) ? wp_unslash( $_REQUEST['s'] ) : '';
166
$button_type = 'button screen-reader-text';
168
// assume no $type_selector means it's a simplified search form
169
if ( ! $type_selector ) {
170
$input_attrs = 'class="wp-filter-search" placeholder="' . esc_attr__( 'Search Plugins' ) . '" ';
173
?><form class="search-form search-plugins" method="get" action="">
174
<input type="hidden" name="tab" value="search" />
175
<?php if ( $type_selector ) : ?>
176
<select name="type" id="typeselector">
177
<option value="term"<?php selected('term', $type) ?>><?php _e('Keyword'); ?></option>
178
<option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option>
179
<option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option>
182
<label><span class="screen-reader-text"><?php _e('Search Plugins'); ?></span>
183
<input type="search" name="s" value="<?php echo esc_attr($term) ?>" <?php echo $input_attrs; ?>/>
185
<?php submit_button( __( 'Search Plugins' ), $button_type, false, false, array( 'id' => 'search-submit' ) ); ?>
193
* @param string $page
195
function install_plugins_upload( $page = 1 ) {
197
<div class="upload-plugin">
198
<p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.'); ?></p>
199
<form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo self_admin_url('update.php?action=upload-plugin'); ?>">
200
<?php wp_nonce_field( 'plugin-upload'); ?>
201
<label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label>
202
<input type="file" id="pluginzip" name="pluginzip" />
203
<?php submit_button( __( 'Install Now' ), 'button', 'install-plugin-submit', false ); ?>
208
add_action('install_plugins_upload', 'install_plugins_upload', 10, 1);
211
* Show a username form for the favorites page
215
function install_plugins_favorites_form() {
216
$user = ! empty( $_GET['user'] ) ? wp_unslash( $_GET['user'] ) : get_user_option( 'wporg_favorites' );
218
<p class="install-help"><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>
219
<form method="get" action="">
220
<input type="hidden" name="tab" value="favorites" />
222
<label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>
223
<input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />
224
<input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />
231
* Display plugin content based on plugin list.
235
function display_plugins_table() {
236
global $wp_list_table;
238
if ( current_filter() == 'install_plugins_favorites' && empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {
243
<form id="plugin-filter" action="" method="post">
244
<?php $wp_list_table->display(); ?>
248
add_action( 'install_plugins_search', 'display_plugins_table' );
249
add_action( 'install_plugins_popular', 'display_plugins_table' );
250
add_action( 'install_plugins_new', 'display_plugins_table' );
251
add_action( 'install_plugins_beta', 'display_plugins_table' );
252
add_action( 'install_plugins_favorites', 'display_plugins_table' );
255
* Determine the status we can perform on a plugin.
259
function install_plugin_install_status($api, $loop = false) {
260
// This function is called recursively, $loop prevents further loops.
261
if ( is_array($api) )
262
$api = (object) $api;
264
// Default to a "new" plugin
269
* Check to see if this plugin is known to be installed,
270
* and has an update awaiting it.
272
$update_plugins = get_site_transient('update_plugins');
273
if ( isset( $update_plugins->response ) ) {
274
foreach ( (array)$update_plugins->response as $file => $plugin ) {
275
if ( $plugin->slug === $api->slug ) {
276
$status = 'update_available';
277
$update_file = $file;
278
$version = $plugin->new_version;
279
if ( current_user_can('update_plugins') )
280
$url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
286
if ( 'install' == $status ) {
287
if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
288
$installed_plugin = get_plugins('/' . $api->slug);
289
if ( empty($installed_plugin) ) {
290
if ( current_user_can('install_plugins') )
291
$url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
293
$key = array_keys( $installed_plugin );
294
$key = array_shift( $key ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
295
if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
296
$status = 'latest_installed';
297
} elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
298
$status = 'newer_installed';
299
$version = $installed_plugin[ $key ]['Version'];
301
//If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
303
delete_site_transient('update_plugins');
305
return install_plugin_install_status($api, true);
310
// "install" & no directory with that slug
311
if ( current_user_can('install_plugins') )
312
$url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
315
if ( isset($_GET['from']) )
316
$url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) );
318
return compact('status', 'url', 'version');
322
* Display plugin information in dialog box form.
326
function install_plugin_information() {
329
$api = plugins_api( 'plugin_information', array(
330
'slug' => wp_unslash( $_REQUEST['plugin'] ),
331
'is_ssl' => is_ssl(),
332
'fields' => array( 'banners' => true, 'reviews' => true )
335
if ( is_wp_error( $api ) ) {
339
$plugins_allowedtags = array(
340
'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ),
341
'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ),
342
'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
343
'div' => array( 'class' => array() ), 'span' => array( 'class' => array() ),
344
'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
345
'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
346
'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() )
349
$plugins_section_titles = array(
350
'description' => _x( 'Description', 'Plugin installer section title' ),
351
'installation' => _x( 'Installation', 'Plugin installer section title' ),
352
'faq' => _x( 'FAQ', 'Plugin installer section title' ),
353
'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ),
354
'changelog' => _x( 'Changelog', 'Plugin installer section title' ),
355
'reviews' => _x( 'Reviews', 'Plugin installer section title' ),
356
'other_notes' => _x( 'Other Notes', 'Plugin installer section title' )
360
foreach ( (array) $api->sections as $section_name => $content ) {
361
$api->sections[$section_name] = wp_kses( $content, $plugins_allowedtags );
364
foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
365
if ( isset( $api->$key ) ) {
366
$api->$key = wp_kses( $api->$key, $plugins_allowedtags );
370
$_tab = esc_attr( $tab );
372
$section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; // Default to the Description tab, Do not translate, API returns English.
373
if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
374
$section_titles = array_keys( (array) $api->sections );
375
$section = array_shift( $section_titles );
378
iframe_header( __( 'Plugin Install' ) );
382
if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) {
383
$_with_banner = 'with-banner';
384
$low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low'];
385
$high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high'];
387
<style type="text/css">
388
#plugin-information-title.with-banner {
389
background-image: url( <?php echo esc_url( $low ); ?> );
391
@media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) {
392
#plugin-information-title.with-banner {
393
background-image: url( <?php echo esc_url( $high ); ?> );
400
echo '<div id="plugin-information-scrollable">';
401
echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>";
402
echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n";
404
foreach ( (array) $api->sections as $section_name => $content ) {
405
if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) {
409
if ( isset( $plugins_section_titles[ $section_name ] ) ) {
410
$title = $plugins_section_titles[ $section_name ];
412
$title = ucwords( str_replace( '_', ' ', $section_name ) );
415
$class = ( $section_name === $section ) ? ' class="current"' : '';
416
$href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
417
$href = esc_url( $href );
418
$san_section = esc_attr( $section_name );
419
echo "\t<a name='$san_section' href='$href' $class>$title</a>\n";
425
<div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'>
428
<?php if ( ! empty( $api->version ) ) { ?>
429
<li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li>
430
<?php } if ( ! empty( $api->author ) ) { ?>
431
<li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li>
432
<?php } if ( ! empty( $api->last_updated ) ) { ?>
433
<li><strong><?php _e( 'Last Updated:' ); ?></strong> <span title="<?php echo $api->last_updated; ?>">
434
<?php printf( __( '%s ago' ), human_time_diff( strtotime( $api->last_updated ) ) ); ?>
436
<?php } if ( ! empty( $api->requires ) ) { ?>
437
<li><strong><?php _e( 'Requires WordPress Version:' ); ?></strong> <?php printf( __( '%s or higher' ), $api->requires ); ?></li>
438
<?php } if ( ! empty( $api->tested ) ) { ?>
439
<li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li>
440
<?php } if ( ! empty( $api->downloaded ) ) { ?>
441
<li><strong><?php _e( 'Downloaded:' ); ?></strong> <?php printf( _n( '%s time', '%s times', $api->downloaded ), number_format_i18n( $api->downloaded ) ); ?></li>
442
<?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?>
443
<li><a target="_blank" href="https://wordpress.org/plugins/<?php echo $api->slug; ?>/"><?php _e( 'WordPress.org Plugin Page »' ); ?></a></li>
444
<?php } if ( ! empty( $api->homepage ) ) { ?>
445
<li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage »' ); ?></a></li>
446
<?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?>
447
<li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a></li>
450
<?php if ( ! empty( $api->rating ) ) { ?>
451
<h3><?php _e( 'Average Rating' ); ?></h3>
452
<?php wp_star_rating( array( 'rating' => $api->rating, 'type' => 'percent', 'number' => $api->num_ratings ) ); ?>
453
<small><?php printf( _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ), number_format_i18n( $api->num_ratings ) ); ?></small>
456
if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) {
457
foreach( $api->ratings as $key => $ratecount ) {
458
// Avoid div-by-zero.
459
$_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0;
461
<div class="counter-container">
462
<a href="<?php echo esc_url( self_admin_url( 'plugin-install.php?tab=plugin-information&plugin=' . $api->slug . '&section=reviews' ) ); ?>"
463
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 ) ); ?>">
464
<span class="counter-label"><?php printf( _n( '%d star', '%d stars', $key ), $key ); ?></span>
465
<span class="counter-back">
466
<span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span>
469
<span class="counter-count"><?php echo number_format_i18n( $ratecount ); ?></span>
474
if ( ! empty( $api->contributors ) ) { ?>
475
<h3><?php _e( 'Contributors' ); ?></h3>
476
<ul class="contributors">
478
foreach ( (array) $api->contributors as $contrib_username => $contrib_profile ) {
479
if ( empty( $contrib_username ) && empty( $contrib_profile ) ) {
482
if ( empty( $contrib_username ) ) {
483
$contrib_username = preg_replace( '/^.+\/(.+)\/?$/', '\1', $contrib_profile );
485
$contrib_username = sanitize_user( $contrib_username );
486
if ( empty( $contrib_profile ) ) {
487
echo "<li><img src='https://wordpress.org/grav-redirect.php?user={$contrib_username}&s=36' width='18' height='18' />{$contrib_username}</li>";
489
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>";
494
<?php if ( ! empty( $api->donate_link ) ) { ?>
495
<a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a>
499
<div id="section-holder" class="wrap">
501
if ( ! empty( $api->tested ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->tested ) ), $api->tested, '>' ) ) {
502
echo '<div class="error"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>';
503
} else if ( ! empty( $api->requires ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->requires ) ), $api->requires, '<' ) ) {
504
echo '<div class="error"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been marked as compatible</strong> with your version of WordPress.') . '</p></div>';
507
foreach ( (array) $api->sections as $section_name => $content ) {
508
$content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' );
509
$content = links_add_target( $content, '_blank' );
511
$san_section = esc_attr( $section_name );
513
$display = ( $section_name === $section ) ? 'block' : 'none';
515
echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n";
521
echo "</div>\n"; // #plugin-information-scrollable
522
echo "<div id='$tab-footer'>\n";
523
if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) {
524
$status = install_plugin_install_status( $api );
525
switch ( $status['status'] ) {
527
if ( $status['url'] ) {
528
echo '<a class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Now' ) . '</a>';
531
case 'update_available':
532
if ( $status['url'] ) {
533
echo '<a class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Update Now' ) .'</a>';
536
case 'newer_installed':
537
echo '<a class="button button-primary right disabled">' . sprintf( __( 'Newer Version (%s) Installed'), $status['version'] ) . '</a>';
539
case 'latest_installed':
540
echo '<a class="button button-primary right disabled">' . __( 'Latest Version Installed' ) . '</a>';
549
add_action('install_plugins_pre_plugin-information', 'install_plugin_information');
added
removed
wp-admin/includes/plugin-install.php
