| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Plugin Install Administration API 4 * 5 * @package WordPress 6 * @subpackage Administration 7 */ 8 9 /** 10 * Retrieves plugin installer pages from the WordPress.org 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, {@see 'plugins_api_args'}, is for the args and gives the action 18 * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that 19 * an object is returned. 20 * 21 * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org 22 * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information', 23 * an object MUST be passed. If `$action` is 'hot_tags', an array MUST 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 | 31 * | -------------------- | :-----------: | :----------------: | :------: | 32 * | `$slug` | No | Yes | No | 33 * | `$per_page` | Yes | No | No | 34 * | `$page` | Yes | No | No | 35 * | `$number` | No | No | Yes | 36 * | `$search` | Yes | No | No | 37 * | `$tag` | Yes | No | No | 38 * | `$author` | Yes | No | No | 39 * | `$user` | Yes | No | No | 40 * | `$browse` | Yes | No | No | 41 * | `$locale` | Yes | Yes | No | 42 * | `$installed_plugins` | Yes | No | No | 43 * | `$is_ssl` | Yes | Yes | No | 44 * | `$fields` | Yes | Yes | No | 45 * 46 * @since 2.7.0 47 * 48 * @param string $action API action to perform: 'query_plugins', 'plugin_information', 49 * or 'hot_tags'. 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 $requires_php Whether to return the required PHP version. Default true. 76 * @type bool $rating Whether to return the rating in percent and total number of ratings. 77 * Default true. 78 * @type bool $ratings Whether to return the number of rating for each star (1-5). Default true. 79 * @type bool $downloaded Whether to return the download count. Default true. 80 * @type bool $downloadlink Whether to return the download link for the package. Default true. 81 * @type bool $last_updated Whether to return the date of the last update. Default true. 82 * @type bool $added Whether to return the date when the plugin was added to the wordpress.org 83 * repository. Default true. 84 * @type bool $tags Whether to return the assigned tags. Default true. 85 * @type bool $compatibility Whether to return the WordPress compatibility list. Default true. 86 * @type bool $homepage Whether to return the plugin homepage link. Default true. 87 * @type bool $versions Whether to return the list of all available versions. Default false. 88 * @type bool $donate_link Whether to return the donation link. Default true. 89 * @type bool $reviews Whether to return the plugin reviews. Default false. 90 * @type bool $banners Whether to return the banner images links. Default false. 91 * @type bool $icons Whether to return the icon links. Default false. 92 * @type bool $active_installs Whether to return the number of active installations. 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 105 if ( 'query_plugins' === $action ) { 106 if ( ! isset( $args->per_page ) ) { 107 $args->per_page = 24; 108 } 109 } 110 111 if ( ! isset( $args->locale ) ) { 112 $args->locale = get_user_locale(); 113 } 114 115 if ( ! isset( $args->wp_version ) ) { 116 $args->wp_version = substr( wp_get_wp_version(), 0, 3 ); // x.y 117 } 118 119 /** 120 * Filters the WordPress.org Plugin Installation API arguments. 121 * 122 * Important: An object MUST be returned to this filter. 123 * 124 * @since 2.7.0 125 * 126 * @param object $args Plugin API arguments. 127 * @param string $action The type of information being requested from the Plugin Installation API. 128 */ 129 $args = apply_filters( 'plugins_api_args', $args, $action ); 130 131 /** 132 * Filters the response for the current WordPress.org Plugin Installation API request. 133 * 134 * Returning a non-false value will effectively short-circuit the WordPress.org API request. 135 * 136 * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed. 137 * If `$action` is 'hot_tags', an array should be passed. 138 * 139 * @since 2.7.0 140 * 141 * @param false|object|array $result The result object or array. Default false. 142 * @param string $action The type of information being requested from the Plugin Installation API. 143 * @param object $args Plugin API arguments. 144 */ 145 $res = apply_filters( 'plugins_api', false, $action, $args ); 146 147 if ( false === $res ) { 148 149 $url = 'http://api.wordpress.org/plugins/info/1.2/'; 150 $url = add_query_arg( 151 array( 152 'action' => $action, 153 'request' => $args, 154 ), 155 $url 156 ); 157 158 $http_url = $url; 159 $ssl = wp_http_supports( array( 'ssl' ) ); 160 if ( $ssl ) { 161 $url = set_url_scheme( $url, 'https' ); 162 } 163 164 $http_args = array( 165 'timeout' => 15, 166 'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ), 167 ); 168 $request = wp_remote_get( $url, $http_args ); 169 170 if ( $ssl && is_wp_error( $request ) ) { 171 if ( ! wp_is_json_request() ) { 172 wp_trigger_error( 173 __FUNCTION__, 174 sprintf( 175 /* translators: %s: Support forums URL. */ 176 __( '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="%s">support forums</a>.' ), 177 __( 'https://wordpress.org/support/forums/' ) 178 ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ), 179 headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE 180 ); 181 } 182 183 $request = wp_remote_get( $http_url, $http_args ); 184 } 185 186 if ( is_wp_error( $request ) ) { 187 $res = new WP_Error( 188 'plugins_api_failed', 189 sprintf( 190 /* translators: %s: Support forums URL. */ 191 __( '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="%s">support forums</a>.' ), 192 __( 'https://wordpress.org/support/forums/' ) 193 ), 194 $request->get_error_message() 195 ); 196 } else { 197 $res = json_decode( wp_remote_retrieve_body( $request ), true ); 198 if ( is_array( $res ) ) { 199 // Object casting is required in order to match the info/1.0 format. 200 $res = (object) $res; 201 } elseif ( null === $res ) { 202 $res = new WP_Error( 203 'plugins_api_failed', 204 sprintf( 205 /* translators: %s: Support forums URL. */ 206 __( '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="%s">support forums</a>.' ), 207 __( 'https://wordpress.org/support/forums/' ) 208 ), 209 wp_remote_retrieve_body( $request ) 210 ); 211 } 212 213 if ( isset( $res->error ) ) { 214 $res = new WP_Error( 'plugins_api_failed', $res->error ); 215 } 216 } 217 } elseif ( ! is_wp_error( $res ) ) { 218 $res->external = true; 219 } 220 221 /** 222 * Filters the Plugin Installation API response results. 223 * 224 * @since 2.7.0 225 * 226 * @param object|WP_Error $res Response object or WP_Error. 227 * @param string $action The type of information being requested from the Plugin Installation API. 228 * @param object $args Plugin API arguments. 229 */ 230 return apply_filters( 'plugins_api_result', $res, $action, $args ); 231 } 232 233 /** 234 * Retrieves popular WordPress plugin tags. 235 * 236 * @since 2.7.0 237 * 238 * @param array $args 239 * @return array|WP_Error 240 */ 241 function install_popular_tags( $args = array() ) { 242 $key = md5( serialize( $args ) ); 243 $tags = get_site_transient( 'poptags_' . $key ); 244 if ( false !== $tags ) { 245 return $tags; 246 } 247 248 $tags = plugins_api( 'hot_tags', $args ); 249 250 if ( is_wp_error( $tags ) ) { 251 return $tags; 252 } 253 254 set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS ); 255 256 return $tags; 257 } 258 259 /** 260 * Displays the Featured tab of Add Plugins screen. 261 * 262 * @since 2.7.0 263 */ 264 function install_dashboard() { 265 display_plugins_table(); 266 ?> 267 268 <div class="plugins-popular-tags-wrapper"> 269 <h2><?php _e( 'Popular tags' ); ?></h2> 270 <p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ); ?></p> 271 <?php 272 273 $api_tags = install_popular_tags(); 274 275 echo '<p class="popular-tags">'; 276 if ( is_wp_error( $api_tags ) ) { 277 echo $api_tags->get_error_message(); 278 } else { 279 // Set up the tags in a way which can be interpreted by wp_generate_tag_cloud(). 280 $tags = array(); 281 foreach ( (array) $api_tags as $tag ) { 282 $url = self_admin_url( 'plugin-install.php?tab=search&type=tag&s=' . urlencode( $tag['name'] ) ); 283 $data = array( 284 'link' => esc_url( $url ), 285 'name' => $tag['name'], 286 'slug' => $tag['slug'], 287 'id' => sanitize_title_with_dashes( $tag['name'] ), 288 'count' => $tag['count'], 289 ); 290 $tags[ $tag['name'] ] = (object) $data; 291 } 292 echo wp_generate_tag_cloud( 293 $tags, 294 array( 295 /* translators: %s: Number of plugins. */ 296 'single_text' => __( '%s plugin' ), 297 /* translators: %s: Number of plugins. */ 298 'multiple_text' => __( '%s plugins' ), 299 ) 300 ); 301 } 302 echo '</p><br class="clear" /></div>'; 303 } 304 305 /** 306 * Displays a search form for searching plugins. 307 * 308 * @since 2.7.0 309 * @since 4.6.0 The `$type_selector` parameter was deprecated. 310 * 311 * @param bool $deprecated Not used. 312 */ 313 function install_search_form( $deprecated = true ) { 314 $type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term'; 315 $term = isset( $_REQUEST['s'] ) ? urldecode( wp_unslash( $_REQUEST['s'] ) ) : ''; 316 ?> 317 <form class="search-form search-plugins" method="get"> 318 <input type="hidden" name="tab" value="search" /> 319 <label for="search-plugins"><?php _e( 'Search Plugins' ); ?></label> 320 <input type="search" name="s" id="search-plugins" value="<?php echo esc_attr( $term ); ?>" class="wp-filter-search" /> 321 <label class="screen-reader-text" for="typeselector"> 322 <?php 323 /* translators: Hidden accessibility text. */ 324 _e( 'Search plugins by:' ); 325 ?> 326 </label> 327 <select name="type" id="typeselector"> 328 <option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option> 329 <option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option> 330 <option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option> 331 </select> 332 <?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?> 333 </form> 334 <?php 335 } 336 337 /** 338 * Displays a form to upload plugins from zip files. 339 * 340 * @since 2.8.0 341 */ 342 function install_plugins_upload() { 343 ?> 344 <div class="upload-plugin"> 345 <p class="install-help"><?php _e( 'If you have a plugin in a .zip format, you may install or update it by uploading it here.' ); ?></p> 346 <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo esc_url( self_admin_url( 'update.php?action=upload-plugin' ) ); ?>"> 347 <?php wp_nonce_field( 'plugin-upload' ); ?> 348 <label class="screen-reader-text" for="pluginzip"> 349 <?php 350 /* translators: Hidden accessibility text. */ 351 _e( 'Plugin zip file' ); 352 ?> 353 </label> 354 <input type="file" id="pluginzip" name="pluginzip" accept=".zip" /> 355 <?php submit_button( _x( 'Install Now', 'plugin' ), '', 'install-plugin-submit', false ); ?> 356 </form> 357 </div> 358 <?php 359 } 360 361 /** 362 * Shows a username form for the favorites page. 363 * 364 * @since 3.5.0 365 */ 366 function install_plugins_favorites_form() { 367 $user = get_user_option( 'wporg_favorites' ); 368 $action = 'save_wporg_username_' . get_current_user_id(); 369 ?> 370 <p><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p> 371 <form method="get"> 372 <input type="hidden" name="tab" value="favorites" /> 373 <p> 374 <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label> 375 <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" /> 376 <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" /> 377 <input type="hidden" id="wporg-username-nonce" name="_wpnonce" value="<?php echo esc_attr( wp_create_nonce( $action ) ); ?>" /> 378 </p> 379 </form> 380 <?php 381 } 382 383 /** 384 * Displays plugin content based on plugin list. 385 * 386 * @since 2.7.0 387 * 388 * @global WP_List_Table $wp_list_table 389 */ 390 function display_plugins_table() { 391 global $wp_list_table; 392 393 switch ( current_filter() ) { 394 case 'install_plugins_beta': 395 printf( 396 /* translators: %s: URL to "Features as Plugins" page. */ 397 '<p>' . __( 'You are using a development version of WordPress. These feature plugins are also under development. <a href="%s">Learn more</a>.' ) . '</p>', 398 'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/' 399 ); 400 break; 401 case 'install_plugins_featured': 402 printf( 403 /* translators: %s: https://wordpress.org/plugins/ */ 404 '<p>' . __( 'Plugins extend and expand the functionality of WordPress. You may install plugins in the <a href="%s">WordPress Plugin Directory</a> right from here, or upload a plugin in .zip format by clicking the button at the top of this page.' ) . '</p>', 405 __( 'https://wordpress.org/plugins/' ) 406 ); 407 break; 408 case 'install_plugins_recommended': 409 echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>'; 410 break; 411 case 'install_plugins_favorites': 412 if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) { 413 return; 414 } 415 break; 416 } 417 ?> 418 <form id="plugin-filter" method="post"> 419 <?php $wp_list_table->display(); ?> 420 </form> 421 <?php 422 } 423 424 /** 425 * Determines the status we can perform on a plugin. 426 * 427 * @since 3.0.0 428 * 429 * @param array|object $api Data about the plugin retrieved from the API. 430 * @param bool $loop Optional. Disable further loops. Default false. 431 * @return array { 432 * Plugin installation status data. 433 * 434 * @type string $status Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'. 435 * @type string $url Plugin installation URL. 436 * @type string $version The most recent version of the plugin. 437 * @type string $file Plugin filename relative to the plugins directory. 438 * } 439 */ 440 function install_plugin_install_status( $api, $loop = false ) { 441 // This function is called recursively, $loop prevents further loops. 442 if ( is_array( $api ) ) { 443 $api = (object) $api; 444 } 445 446 // Default to a "new" plugin. 447 $status = 'install'; 448 $url = false; 449 $update_file = false; 450 $version = ''; 451 452 /* 453 * Check to see if this plugin is known to be installed, 454 * and has an update awaiting it. 455 */ 456 $update_plugins = get_site_transient( 'update_plugins' ); 457 if ( isset( $update_plugins->response ) ) { 458 foreach ( (array) $update_plugins->response as $file => $plugin ) { 459 if ( $plugin->slug === $api->slug ) { 460 $status = 'update_available'; 461 $update_file = $file; 462 $version = $plugin->new_version; 463 if ( current_user_can( 'update_plugins' ) ) { 464 $url = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . $update_file ), 'upgrade-plugin_' . $update_file ); 465 } 466 break; 467 } 468 } 469 } 470 471 if ( 'install' === $status ) { 472 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) { 473 $installed_plugin = get_plugins( '/' . $api->slug ); 474 if ( empty( $installed_plugin ) ) { 475 if ( current_user_can( 'install_plugins' ) ) { 476 $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug ); 477 } 478 } else { 479 $key = array_keys( $installed_plugin ); 480 /* 481 * Use the first plugin regardless of the name. 482 * Could have issues for multiple plugins in one directory if they share different version numbers. 483 */ 484 $key = reset( $key ); 485 486 $update_file = $api->slug . '/' . $key; 487 if ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '=' ) ) { 488 $status = 'latest_installed'; 489 } elseif ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '<' ) ) { 490 $status = 'newer_installed'; 491 $version = $installed_plugin[ $key ]['Version']; 492 } else { 493 // If the above update check failed, then that probably means that the update checker has out-of-date information, force a refresh. 494 if ( ! $loop ) { 495 delete_site_transient( 'update_plugins' ); 496 wp_update_plugins(); 497 return install_plugin_install_status( $api, true ); 498 } 499 } 500 } 501 } else { 502 // "install" & no directory with that slug. 503 if ( current_user_can( 'install_plugins' ) ) { 504 $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug ); 505 } 506 } 507 } 508 if ( isset( $_GET['from'] ) ) { 509 $url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) ); 510 } 511 512 $file = $update_file; 513 return compact( 'status', 'url', 'version', 'file' ); 514 } 515 516 /** 517 * Displays plugin information in dialog box form. 518 * 519 * @since 2.7.0 520 * 521 * @global string $tab 522 */ 523 function install_plugin_information() { 524 global $tab; 525 526 if ( empty( $_REQUEST['plugin'] ) ) { 527 return; 528 } 529 530 $api = plugins_api( 531 'plugin_information', 532 array( 533 'slug' => wp_unslash( $_REQUEST['plugin'] ), 534 ) 535 ); 536 537 if ( is_wp_error( $api ) ) { 538 wp_die( $api ); 539 } 540 541 $plugins_allowedtags = array( 542 'a' => array( 543 'href' => array(), 544 'title' => array(), 545 'target' => array(), 546 ), 547 'abbr' => array( 'title' => array() ), 548 'acronym' => array( 'title' => array() ), 549 'code' => array(), 550 'pre' => array(), 551 'em' => array(), 552 'strong' => array(), 553 'div' => array( 'class' => array() ), 554 'span' => array( 'class' => array() ), 555 'p' => array(), 556 'br' => array(), 557 'ul' => array(), 558 'ol' => array(), 559 'li' => array(), 560 'h1' => array(), 561 'h2' => array(), 562 'h3' => array(), 563 'h4' => array(), 564 'h5' => array(), 565 'h6' => array(), 566 'img' => array( 567 'src' => array(), 568 'class' => array(), 569 'alt' => array(), 570 ), 571 'blockquote' => array( 'cite' => true ), 572 ); 573 574 $plugins_section_titles = array( 575 'description' => _x( 'Description', 'Plugin installer section title' ), 576 'installation' => _x( 'Installation', 'Plugin installer section title' ), 577 'faq' => _x( 'FAQ', 'Plugin installer section title' ), 578 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ), 579 'changelog' => _x( 'Changelog', 'Plugin installer section title' ), 580 'reviews' => _x( 'Reviews', 'Plugin installer section title' ), 581 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' ), 582 ); 583 584 // Sanitize HTML. 585 foreach ( (array) $api->sections as $section_name => $content ) { 586 $api->sections[ $section_name ] = wp_kses( $content, $plugins_allowedtags ); 587 } 588 589 foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) { 590 if ( isset( $api->$key ) ) { 591 $api->$key = wp_kses( $api->$key, $plugins_allowedtags ); 592 } 593 } 594 595 $_tab = esc_attr( $tab ); 596 597 // Default to the Description tab, Do not translate, API returns English. 598 $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; 599 if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) { 600 $section_titles = array_keys( (array) $api->sections ); 601 $section = reset( $section_titles ); 602 } 603 604 iframe_header( __( 'Plugin Installation' ) ); 605 606 $_with_banner = ''; 607 608 if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) { 609 $_with_banner = 'with-banner'; 610 $low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low']; 611 $high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high']; 612 ?> 613 <style type="text/css"> 614 #plugin-information-title.with-banner { 615 background-image: url( <?php echo esc_url( $low ); ?> ); 616 } 617 @media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) { 618 #plugin-information-title.with-banner { 619 background-image: url( <?php echo esc_url( $high ); ?> ); 620 } 621 } 622 </style> 623 <?php 624 } 625 626 echo '<div id="plugin-information-scrollable">'; 627 echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>"; 628 echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n"; 629 630 foreach ( (array) $api->sections as $section_name => $content ) { 631 if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) { 632 continue; 633 } 634 635 if ( isset( $plugins_section_titles[ $section_name ] ) ) { 636 $title = $plugins_section_titles[ $section_name ]; 637 } else { 638 $title = ucwords( str_replace( '_', ' ', $section_name ) ); 639 } 640 641 $class = ( $section_name === $section ) ? ' class="current"' : ''; 642 $href = add_query_arg( 643 array( 644 'tab' => $tab, 645 'section' => $section_name, 646 ) 647 ); 648 $href = esc_url( $href ); 649 $san_section = esc_attr( $section_name ); 650 echo "\t<a name='$san_section' href='$href' $class>$title</a>\n"; 651 } 652 653 echo "</div>\n"; 654 655 ?> 656 <div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'> 657 <div class="fyi"> 658 <ul> 659 <?php if ( ! empty( $api->version ) ) { ?> 660 <li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li> 661 <?php } if ( ! empty( $api->author ) ) { ?> 662 <li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li> 663 <?php } if ( ! empty( $api->last_updated ) ) { ?> 664 <li><strong><?php _e( 'Last Updated:' ); ?></strong> 665 <?php 666 /* translators: %s: Human-readable time difference. */ 667 printf( __( '%s ago' ), human_time_diff( strtotime( $api->last_updated ) ) ); 668 ?> 669 </li> 670 <?php } if ( ! empty( $api->requires ) ) { ?> 671 <li> 672 <strong><?php _e( 'Requires WordPress Version:' ); ?></strong> 673 <?php 674 /* translators: %s: Version number. */ 675 printf( __( '%s or higher' ), $api->requires ); 676 ?> 677 </li> 678 <?php } if ( ! empty( $api->tested ) ) { ?> 679 <li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li> 680 <?php } if ( ! empty( $api->requires_php ) ) { ?> 681 <li> 682 <strong><?php _e( 'Requires PHP Version:' ); ?></strong> 683 <?php 684 /* translators: %s: Version number. */ 685 printf( __( '%s or higher' ), $api->requires_php ); 686 ?> 687 </li> 688 <?php } if ( isset( $api->active_installs ) ) { ?> 689 <li><strong><?php _e( 'Active Installations:' ); ?></strong> 690 <?php 691 if ( $api->active_installs >= 1000000 ) { 692 $active_installs_millions = floor( $api->active_installs / 1000000 ); 693 printf( 694 /* translators: %s: Number of millions. */ 695 _nx( '%s+ Million', '%s+ Million', $active_installs_millions, 'Active plugin installations' ), 696 number_format_i18n( $active_installs_millions ) 697 ); 698 } elseif ( $api->active_installs < 10 ) { 699 _ex( 'Less Than 10', 'Active plugin installations' ); 700 } else { 701 echo number_format_i18n( $api->active_installs ) . '+'; 702 } 703 ?> 704 </li> 705 <?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?> 706 <li><a target="_blank" href="<?php echo esc_url( __( 'https://wordpress.org/plugins/' ) . $api->slug ); ?>/"><?php _e( 'WordPress.org Plugin Page »' ); ?></a></li> 707 <?php } if ( ! empty( $api->homepage ) ) { ?> 708 <li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage »' ); ?></a></li> 709 <?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?> 710 <li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a></li> 711 <?php } ?> 712 </ul> 713 <?php if ( ! empty( $api->rating ) ) { ?> 714 <h3><?php _e( 'Average Rating' ); ?></h3> 715 <?php 716 wp_star_rating( 717 array( 718 'rating' => $api->rating, 719 'type' => 'percent', 720 'number' => $api->num_ratings, 721 ) 722 ); 723 ?> 724 <p aria-hidden="true" class="fyi-description"> 725 <?php 726 printf( 727 /* translators: %s: Number of ratings. */ 728 _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ), 729 number_format_i18n( $api->num_ratings ) 730 ); 731 ?> 732 </p> 733 <?php 734 } 735 736 if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) { 737 ?> 738 <h3><?php _e( 'Reviews' ); ?></h3> 739 <p class="fyi-description"><?php _e( 'Read all reviews on WordPress.org or write your own!' ); ?></p> 740 <?php 741 foreach ( $api->ratings as $key => $ratecount ) { 742 // Avoid div-by-zero. 743 $_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0; 744 $aria_label = esc_attr( 745 sprintf( 746 /* translators: 1: Number of stars (used to determine singular/plural), 2: Number of reviews. */ 747 _n( 748 'Reviews with %1$d star: %2$s. Opens in a new tab.', 749 'Reviews with %1$d stars: %2$s. Opens in a new tab.', 750 $key 751 ), 752 $key, 753 number_format_i18n( $ratecount ) 754 ) 755 ); 756 ?> 757 <div class="counter-container"> 758 <span class="counter-label"> 759 <?php 760 printf( 761 '<a href="%s" target="_blank" aria-label="%s">%s</a>', 762 "https://wordpress.org/support/plugin/{$api->slug}/reviews/?filter={$key}", 763 $aria_label, 764 /* translators: %s: Number of stars. */ 765 sprintf( _n( '%d star', '%d stars', $key ), $key ) 766 ); 767 ?> 768 </span> 769 <span class="counter-back"> 770 <span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span> 771 </span> 772 <span class="counter-count" aria-hidden="true"><?php echo number_format_i18n( $ratecount ); ?></span> 773 </div> 774 <?php 775 } 776 } 777 if ( ! empty( $api->contributors ) ) { 778 ?> 779 <h3><?php _e( 'Contributors' ); ?></h3> 780 <ul class="contributors"> 781 <?php 782 foreach ( (array) $api->contributors as $contrib_username => $contrib_details ) { 783 $contrib_name = $contrib_details['display_name']; 784 if ( ! $contrib_name ) { 785 $contrib_name = $contrib_username; 786 } 787 $contrib_name = esc_html( $contrib_name ); 788 789 $contrib_profile = esc_url( $contrib_details['profile'] ); 790 $contrib_avatar = esc_url( add_query_arg( 's', '36', $contrib_details['avatar'] ) ); 791 792 echo "<li><a href='{$contrib_profile}' target='_blank'><img src='{$contrib_avatar}' width='18' height='18' alt='' />{$contrib_name}</a></li>"; 793 } 794 ?> 795 </ul> 796 <?php if ( ! empty( $api->donate_link ) ) { ?> 797 <a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a> 798 <?php } ?> 799 <?php } ?> 800 </div> 801 <div id="section-holder"> 802 <?php 803 $requires_php = isset( $api->requires_php ) ? $api->requires_php : null; 804 $requires_wp = isset( $api->requires ) ? $api->requires : null; 805 806 $compatible_php = is_php_version_compatible( $requires_php ); 807 $compatible_wp = is_wp_version_compatible( $requires_wp ); 808 $tested_wp = ( empty( $api->tested ) || version_compare( get_bloginfo( 'version' ), $api->tested, '<=' ) ); 809 810 if ( ! $compatible_php ) { 811 $compatible_php_notice_message = '<p>'; 812 $compatible_php_notice_message .= __( '<strong>Error:</strong> This plugin <strong>requires a newer version of PHP</strong>.' ); 813 814 if ( current_user_can( 'update_php' ) ) { 815 $compatible_php_notice_message .= sprintf( 816 /* translators: %s: URL to Update PHP page. */ 817 ' ' . __( '<a href="%s" target="_blank">Click here to learn more about updating PHP</a>.' ), 818 esc_url( wp_get_update_php_url() ) 819 ) . wp_update_php_annotation( '</p><p><em>', '</em>', false ); 820 } else { 821 $compatible_php_notice_message .= '</p>'; 822 } 823 824 wp_admin_notice( 825 $compatible_php_notice_message, 826 array( 827 'type' => 'error', 828 'additional_classes' => array( 'notice-alt' ), 829 'paragraph_wrap' => false, 830 ) 831 ); 832 } 833 834 if ( ! $tested_wp ) { 835 wp_admin_notice( 836 __( '<strong>Warning:</strong> This plugin <strong>has not been tested</strong> with your current version of WordPress.' ), 837 array( 838 'type' => 'warning', 839 'additional_classes' => array( 'notice-alt' ), 840 ) 841 ); 842 } elseif ( ! $compatible_wp ) { 843 $compatible_wp_notice_message = __( '<strong>Error:</strong> This plugin <strong>requires a newer version of WordPress</strong>.' ); 844 if ( current_user_can( 'update_core' ) ) { 845 $compatible_wp_notice_message .= sprintf( 846 /* translators: %s: URL to WordPress Updates screen. */ 847 ' ' . __( '<a href="%s" target="_parent">Click here to update WordPress</a>.' ), 848 esc_url( self_admin_url( 'update-core.php' ) ) 849 ); 850 } 851 852 wp_admin_notice( 853 $compatible_wp_notice_message, 854 array( 855 'type' => 'error', 856 'additional_classes' => array( 'notice-alt' ), 857 ) 858 ); 859 } 860 861 foreach ( (array) $api->sections as $section_name => $content ) { 862 $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' ); 863 $content = links_add_target( $content, '_blank' ); 864 865 $san_section = esc_attr( $section_name ); 866 867 $display = ( $section_name === $section ) ? 'block' : 'none'; 868 869 echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n"; 870 echo $content; 871 echo "\t</div>\n"; 872 } 873 echo "</div>\n"; 874 echo "</div>\n"; 875 echo "</div>\n"; // #plugin-information-scrollable 876 echo "<div id='$tab-footer'>\n"; 877 if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) { 878 $button = wp_get_plugin_action_button( $api->name, $api, $compatible_php, $compatible_wp ); 879 $button = str_replace( 'class="', 'class="right ', $button ); 880 881 if ( ! str_contains( $button, _x( 'Activate', 'plugin' ) ) ) { 882 $button = str_replace( 'class="', 'id="plugin_install_from_iframe" class="', $button ); 883 } 884 885 echo wp_kses_post( $button ); 886 } 887 echo "</div>\n"; 888 889 wp_print_request_filesystem_credentials_modal(); 890 wp_print_admin_notice_templates(); 891 892 iframe_footer(); 893 exit; 894 } 895 896 /** 897 * Gets the markup for the plugin install action button. 898 * 899 * @since 6.5.0 900 * 901 * @param string $name Plugin name. 902 * @param array|object $data { 903 * An array or object of plugin data. Can be retrieved from the API. 904 * 905 * @type string $slug The plugin slug. 906 * @type string[] $requires_plugins An array of plugin dependency slugs. 907 * @type string $version The plugin's version string. Used when getting the install status. 908 * } 909 * @param bool $compatible_php The result of a PHP compatibility check. 910 * @param bool $compatible_wp The result of a WP compatibility check. 911 * @return string The markup for the dependency row button. An empty string if the user does not have capabilities. 912 */ 913 function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) { 914 $button = ''; 915 $data = (object) $data; 916 $status = install_plugin_install_status( $data ); 917 $requires_plugins = $data->requires_plugins ?? array(); 918 919 // Determine the status of plugin dependencies. 920 $installed_plugins = get_plugins(); 921 $active_plugins = get_option( 'active_plugins', array() ); 922 $plugin_dependencies_count = count( $requires_plugins ); 923 $installed_plugin_dependencies_count = 0; 924 $active_plugin_dependencies_count = 0; 925 foreach ( $requires_plugins as $dependency ) { 926 foreach ( array_keys( $installed_plugins ) as $installed_plugin_file ) { 927 if ( str_contains( $installed_plugin_file, '/' ) && explode( '/', $installed_plugin_file )[0] === $dependency ) { 928 ++$installed_plugin_dependencies_count; 929 } 930 } 931 932 foreach ( $active_plugins as $active_plugin_file ) { 933 if ( str_contains( $active_plugin_file, '/' ) && explode( '/', $active_plugin_file )[0] === $dependency ) { 934 ++$active_plugin_dependencies_count; 935 } 936 } 937 } 938 $all_plugin_dependencies_installed = $installed_plugin_dependencies_count === $plugin_dependencies_count; 939 $all_plugin_dependencies_active = $active_plugin_dependencies_count === $plugin_dependencies_count; 940 941 if ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) { 942 switch ( $status['status'] ) { 943 case 'install': 944 if ( $status['url'] ) { 945 if ( $compatible_php && $compatible_wp && $all_plugin_dependencies_installed && ! empty( $data->download_link ) ) { 946 $button = sprintf( 947 '<a class="install-now button" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>', 948 esc_attr( $data->slug ), 949 esc_url( $status['url'] ), 950 /* translators: %s: Plugin name and version. */ 951 esc_attr( sprintf( _x( 'Install %s now', 'plugin' ), $name ) ), 952 esc_attr( $name ), 953 _x( 'Install Now', 'plugin' ) 954 ); 955 } else { 956 $button = sprintf( 957 '<button type="button" class="install-now button button-disabled" disabled="disabled">%s</button>', 958 _x( 'Install Now', 'plugin' ) 959 ); 960 } 961 } 962 break; 963 964 case 'update_available': 965 if ( $status['url'] ) { 966 if ( $compatible_php && $compatible_wp ) { 967 $button = sprintf( 968 '<a class="update-now button aria-button-if-js" data-plugin="%s" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>', 969 esc_attr( $status['file'] ), 970 esc_attr( $data->slug ), 971 esc_url( $status['url'] ), 972 /* translators: %s: Plugin name and version. */ 973 esc_attr( sprintf( _x( 'Update %s now', 'plugin' ), $name ) ), 974 esc_attr( $name ), 975 _x( 'Update Now', 'plugin' ) 976 ); 977 } else { 978 $button = sprintf( 979 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>', 980 _x( 'Update Now', 'plugin' ) 981 ); 982 } 983 } 984 break; 985 986 case 'latest_installed': 987 case 'newer_installed': 988 if ( is_plugin_active( $status['file'] ) ) { 989 $button = sprintf( 990 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>', 991 _x( 'Active', 'plugin' ) 992 ); 993 } elseif ( current_user_can( 'activate_plugin', $status['file'] ) ) { 994 if ( $compatible_php && $compatible_wp && $all_plugin_dependencies_active ) { 995 $button_text = _x( 'Activate', 'plugin' ); 996 /* translators: %s: Plugin name. */ 997 $button_label = _x( 'Activate %s', 'plugin' ); 998 $activate_url = add_query_arg( 999 array( 1000 '_wpnonce' => wp_create_nonce( 'activate-plugin_' . $status['file'] ), 1001 'action' => 'activate', 1002 'plugin' => $status['file'], 1003 ), 1004 network_admin_url( 'plugins.php' ) 1005 ); 1006 1007 if ( is_network_admin() ) { 1008 $button_text = _x( 'Network Activate', 'plugin' ); 1009 /* translators: %s: Plugin name. */ 1010 $button_label = _x( 'Network Activate %s', 'plugin' ); 1011 $activate_url = add_query_arg( array( 'networkwide' => 1 ), $activate_url ); 1012 } 1013 1014 $button = sprintf( 1015 '<a href="%1$s" data-name="%2$s" data-slug="%3$s" data-plugin="%4$s" class="button button-primary activate-now" aria-label="%5$s" role="button">%6$s</a>', 1016 esc_url( $activate_url ), 1017 esc_attr( $name ), 1018 esc_attr( $data->slug ), 1019 esc_attr( $status['file'] ), 1020 esc_attr( sprintf( $button_label, $name ) ), 1021 $button_text 1022 ); 1023 } else { 1024 $button = sprintf( 1025 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>', 1026 is_network_admin() ? _x( 'Network Activate', 'plugin' ) : _x( 'Activate', 'plugin' ) 1027 ); 1028 } 1029 } else { 1030 $button = sprintf( 1031 '<button type="button" class="button button-disabled" disabled="disabled">%s</button>', 1032 _x( 'Installed', 'plugin' ) 1033 ); 1034 } 1035 break; 1036 } 1037 } 1038 1039 return $button; 1040 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Nov 21 08:20:01 2024 | Cross-referenced by PHPXref |