diff options
Diffstat (limited to 'wp-admin/includes/plugin-install.php')
-rw-r--r-- | wp-admin/includes/plugin-install.php | 926 |
1 files changed, 926 insertions, 0 deletions
diff --git a/wp-admin/includes/plugin-install.php b/wp-admin/includes/plugin-install.php new file mode 100644 index 0000000..7662076 --- /dev/null +++ b/wp-admin/includes/plugin-install.php @@ -0,0 +1,926 @@ +<?php +/** + * WordPress Plugin Install Administration API + * + * @package WordPress + * @subpackage Administration + */ + +/** + * Retrieves plugin installer pages from the WordPress.org Plugins API. + * + * It is possible for a plugin to override the Plugin API result with three + * filters. Assume this is for plugins, which can extend on the Plugin Info to + * offer more choices. This is very powerful and must be used with care when + * overriding the filters. + * + * The first filter, {@see 'plugins_api_args'}, is for the args and gives the action + * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that + * an object is returned. + * + * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org + * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information', + * an object MUST be passed. If `$action` is 'hot_tags' or 'hot_categories', an array MUST + * be passed. + * + * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the + * response object or array, depending on the `$action` type. + * + * Supported arguments per action: + * + * | Argument Name | query_plugins | plugin_information | hot_tags | hot_categories | + * | -------------------- | :-----------: | :----------------: | :------: | :------------: | + * | `$slug` | No | Yes | No | No | + * | `$per_page` | Yes | No | No | No | + * | `$page` | Yes | No | No | No | + * | `$number` | No | No | Yes | Yes | + * | `$search` | Yes | No | No | No | + * | `$tag` | Yes | No | No | No | + * | `$author` | Yes | No | No | No | + * | `$user` | Yes | No | No | No | + * | `$browse` | Yes | No | No | No | + * | `$locale` | Yes | Yes | No | No | + * | `$installed_plugins` | Yes | No | No | No | + * | `$is_ssl` | Yes | Yes | No | No | + * | `$fields` | Yes | Yes | No | No | + * + * @since 2.7.0 + * + * @param string $action API action to perform: 'query_plugins', 'plugin_information', + * 'hot_tags' or 'hot_categories'. + * @param array|object $args { + * Optional. Array or object of arguments to serialize for the Plugin Info API. + * + * @type string $slug The plugin slug. Default empty. + * @type int $per_page Number of plugins per page. Default 24. + * @type int $page Number of current page. Default 1. + * @type int $number Number of tags or categories to be queried. + * @type string $search A search term. Default empty. + * @type string $tag Tag to filter plugins. Default empty. + * @type string $author Username of an plugin author to filter plugins. Default empty. + * @type string $user Username to query for their favorites. Default empty. + * @type string $browse Browse view: 'popular', 'new', 'beta', 'recommended'. + * @type string $locale Locale to provide context-sensitive results. Default is the value + * of get_locale(). + * @type string $installed_plugins Installed plugins to provide context-sensitive results. + * @type bool $is_ssl Whether links should be returned with https or not. Default false. + * @type array $fields { + * Array of fields which should or should not be returned. + * + * @type bool $short_description Whether to return the plugin short description. Default true. + * @type bool $description Whether to return the plugin full description. Default false. + * @type bool $sections Whether to return the plugin readme sections: description, installation, + * FAQ, screenshots, other notes, and changelog. Default false. + * @type bool $tested Whether to return the 'Compatible up to' value. Default true. + * @type bool $requires Whether to return the required WordPress version. Default true. + * @type bool $requires_php Whether to return the required PHP version. Default true. + * @type bool $rating Whether to return the rating in percent and total number of ratings. + * Default true. + * @type bool $ratings Whether to return the number of rating for each star (1-5). Default true. + * @type bool $downloaded Whether to return the download count. Default true. + * @type bool $downloadlink Whether to return the download link for the package. Default true. + * @type bool $last_updated Whether to return the date of the last update. Default true. + * @type bool $added Whether to return the date when the plugin was added to the wordpress.org + * repository. Default true. + * @type bool $tags Whether to return the assigned tags. Default true. + * @type bool $compatibility Whether to return the WordPress compatibility list. Default true. + * @type bool $homepage Whether to return the plugin homepage link. Default true. + * @type bool $versions Whether to return the list of all available versions. Default false. + * @type bool $donate_link Whether to return the donation link. Default true. + * @type bool $reviews Whether to return the plugin reviews. Default false. + * @type bool $banners Whether to return the banner images links. Default false. + * @type bool $icons Whether to return the icon links. Default false. + * @type bool $active_installs Whether to return the number of active installations. Default false. + * @type bool $group Whether to return the assigned group. Default false. + * @type bool $contributors Whether to return the list of contributors. Default false. + * } + * } + * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the + * {@link https://developer.wordpress.org/reference/functions/plugins_api/ function reference article} + * for more information on the make-up of possible return values depending on the value of `$action`. + */ +function plugins_api( $action, $args = array() ) { + // Include an unmodified $wp_version. + require ABSPATH . WPINC . '/version.php'; + + if ( is_array( $args ) ) { + $args = (object) $args; + } + + if ( 'query_plugins' === $action ) { + if ( ! isset( $args->per_page ) ) { + $args->per_page = 24; + } + } + + if ( ! isset( $args->locale ) ) { + $args->locale = get_user_locale(); + } + + if ( ! isset( $args->wp_version ) ) { + $args->wp_version = substr( $wp_version, 0, 3 ); // x.y + } + + /** + * Filters the WordPress.org Plugin Installation API arguments. + * + * Important: An object MUST be returned to this filter. + * + * @since 2.7.0 + * + * @param object $args Plugin API arguments. + * @param string $action The type of information being requested from the Plugin Installation API. + */ + $args = apply_filters( 'plugins_api_args', $args, $action ); + + /** + * Filters the response for the current WordPress.org Plugin Installation API request. + * + * Returning a non-false value will effectively short-circuit the WordPress.org API request. + * + * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed. + * If `$action` is 'hot_tags' or 'hot_categories', an array should be passed. + * + * @since 2.7.0 + * + * @param false|object|array $result The result object or array. Default false. + * @param string $action The type of information being requested from the Plugin Installation API. + * @param object $args Plugin API arguments. + */ + $res = apply_filters( 'plugins_api', false, $action, $args ); + + if ( false === $res ) { + + $url = 'http://api.wordpress.org/plugins/info/1.2/'; + $url = add_query_arg( + array( + 'action' => $action, + 'request' => $args, + ), + $url + ); + + $http_url = $url; + $ssl = wp_http_supports( array( 'ssl' ) ); + if ( $ssl ) { + $url = set_url_scheme( $url, 'https' ); + } + + $http_args = array( + 'timeout' => 15, + 'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ), + ); + $request = wp_remote_get( $url, $http_args ); + + if ( $ssl && is_wp_error( $request ) ) { + if ( ! wp_is_json_request() ) { + trigger_error( + sprintf( + /* translators: %s: Support forums URL. */ + __( '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>.' ), + __( 'https://wordpress.org/support/forums/' ) + ) . ' ' . __( '(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 + ); + } + + $request = wp_remote_get( $http_url, $http_args ); + } + + if ( is_wp_error( $request ) ) { + $res = new WP_Error( + 'plugins_api_failed', + sprintf( + /* translators: %s: Support forums URL. */ + __( '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>.' ), + __( 'https://wordpress.org/support/forums/' ) + ), + $request->get_error_message() + ); + } else { + $res = json_decode( wp_remote_retrieve_body( $request ), true ); + if ( is_array( $res ) ) { + // Object casting is required in order to match the info/1.0 format. + $res = (object) $res; + } elseif ( null === $res ) { + $res = new WP_Error( + 'plugins_api_failed', + sprintf( + /* translators: %s: Support forums URL. */ + __( '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>.' ), + __( 'https://wordpress.org/support/forums/' ) + ), + wp_remote_retrieve_body( $request ) + ); + } + + if ( isset( $res->error ) ) { + $res = new WP_Error( 'plugins_api_failed', $res->error ); + } + } + } elseif ( ! is_wp_error( $res ) ) { + $res->external = true; + } + + /** + * Filters the Plugin Installation API response results. + * + * @since 2.7.0 + * + * @param object|WP_Error $res Response object or WP_Error. + * @param string $action The type of information being requested from the Plugin Installation API. + * @param object $args Plugin API arguments. + */ + return apply_filters( 'plugins_api_result', $res, $action, $args ); +} + +/** + * Retrieves popular WordPress plugin tags. + * + * @since 2.7.0 + * + * @param array $args + * @return array|WP_Error + */ +function install_popular_tags( $args = array() ) { + $key = md5( serialize( $args ) ); + $tags = get_site_transient( 'poptags_' . $key ); + if ( false !== $tags ) { + return $tags; + } + + $tags = plugins_api( 'hot_tags', $args ); + + if ( is_wp_error( $tags ) ) { + return $tags; + } + + set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS ); + + return $tags; +} + +/** + * Displays the Featured tab of Add Plugins screen. + * + * @since 2.7.0 + */ +function install_dashboard() { + display_plugins_table(); + ?> + + <div class="plugins-popular-tags-wrapper"> + <h2><?php _e( 'Popular tags' ); ?></h2> + <p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ); ?></p> + <?php + + $api_tags = install_popular_tags(); + + echo '<p class="popular-tags">'; + if ( is_wp_error( $api_tags ) ) { + echo $api_tags->get_error_message(); + } else { + // Set up the tags in a way which can be interpreted by wp_generate_tag_cloud(). + $tags = array(); + foreach ( (array) $api_tags as $tag ) { + $url = self_admin_url( 'plugin-install.php?tab=search&type=tag&s=' . urlencode( $tag['name'] ) ); + $data = array( + 'link' => esc_url( $url ), + 'name' => $tag['name'], + 'slug' => $tag['slug'], + 'id' => sanitize_title_with_dashes( $tag['name'] ), + 'count' => $tag['count'], + ); + $tags[ $tag['name'] ] = (object) $data; + } + echo wp_generate_tag_cloud( + $tags, + array( + /* translators: %s: Number of plugins. */ + 'single_text' => __( '%s plugin' ), + /* translators: %s: Number of plugins. */ + 'multiple_text' => __( '%s plugins' ), + ) + ); + } + echo '</p><br class="clear" /></div>'; +} + +/** + * Displays a search form for searching plugins. + * + * @since 2.7.0 + * @since 4.6.0 The `$type_selector` parameter was deprecated. + * + * @param bool $deprecated Not used. + */ +function install_search_form( $deprecated = true ) { + $type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term'; + $term = isset( $_REQUEST['s'] ) ? urldecode( wp_unslash( $_REQUEST['s'] ) ) : ''; + ?> + <form class="search-form search-plugins" method="get"> + <input type="hidden" name="tab" value="search" /> + <label class="screen-reader-text" for="typeselector"> + <?php + /* translators: Hidden accessibility text. */ + _e( 'Search plugins by:' ); + ?> + </label> + <select name="type" id="typeselector"> + <option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option> + <option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option> + <option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option> + </select> + <label class="screen-reader-text" for="search-plugins"> + <?php + /* translators: Hidden accessibility text. */ + _e( 'Search Plugins' ); + ?> + </label> + <input type="search" name="s" id="search-plugins" value="<?php echo esc_attr( $term ); ?>" class="wp-filter-search" placeholder="<?php esc_attr_e( 'Search plugins...' ); ?>" /> + <?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?> + </form> + <?php +} + +/** + * Displays a form to upload plugins from zip files. + * + * @since 2.8.0 + */ +function install_plugins_upload() { + ?> +<div class="upload-plugin"> + <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> + <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo esc_url( self_admin_url( 'update.php?action=upload-plugin' ) ); ?>"> + <?php wp_nonce_field( 'plugin-upload' ); ?> + <label class="screen-reader-text" for="pluginzip"> + <?php + /* translators: Hidden accessibility text. */ + _e( 'Plugin zip file' ); + ?> + </label> + <input type="file" id="pluginzip" name="pluginzip" accept=".zip" /> + <?php submit_button( __( 'Install Now' ), '', 'install-plugin-submit', false ); ?> + </form> +</div> + <?php +} + +/** + * Shows a username form for the favorites page. + * + * @since 3.5.0 + */ +function install_plugins_favorites_form() { + $user = get_user_option( 'wporg_favorites' ); + $action = 'save_wporg_username_' . get_current_user_id(); + ?> + <p><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p> + <form method="get"> + <input type="hidden" name="tab" value="favorites" /> + <p> + <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label> + <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" /> + <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" /> + <input type="hidden" id="wporg-username-nonce" name="_wpnonce" value="<?php echo esc_attr( wp_create_nonce( $action ) ); ?>" /> + </p> + </form> + <?php +} + +/** + * Displays plugin content based on plugin list. + * + * @since 2.7.0 + * + * @global WP_List_Table $wp_list_table + */ +function display_plugins_table() { + global $wp_list_table; + + switch ( current_filter() ) { + case 'install_plugins_beta': + printf( + /* translators: %s: URL to "Features as Plugins" page. */ + '<p>' . __( 'You are using a development version of WordPress. These feature plugins are also under development. <a href="%s">Learn more</a>.' ) . '</p>', + 'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/' + ); + break; + case 'install_plugins_featured': + printf( + /* translators: %s: https://wordpress.org/plugins/ */ + '<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>', + __( 'https://wordpress.org/plugins/' ) + ); + break; + case 'install_plugins_recommended': + echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>'; + break; + case 'install_plugins_favorites': + if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) { + return; + } + break; + } + ?> + <form id="plugin-filter" method="post"> + <?php $wp_list_table->display(); ?> + </form> + <?php +} + +/** + * Determines the status we can perform on a plugin. + * + * @since 3.0.0 + * + * @param array|object $api Data about the plugin retrieved from the API. + * @param bool $loop Optional. Disable further loops. Default false. + * @return array { + * Plugin installation status data. + * + * @type string $status Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'. + * @type string $url Plugin installation URL. + * @type string $version The most recent version of the plugin. + * @type string $file Plugin filename relative to the plugins directory. + * } + */ +function install_plugin_install_status( $api, $loop = false ) { + // This function is called recursively, $loop prevents further loops. + if ( is_array( $api ) ) { + $api = (object) $api; + } + + // Default to a "new" plugin. + $status = 'install'; + $url = false; + $update_file = false; + $version = ''; + + /* + * Check to see if this plugin is known to be installed, + * and has an update awaiting it. + */ + $update_plugins = get_site_transient( 'update_plugins' ); + if ( isset( $update_plugins->response ) ) { + foreach ( (array) $update_plugins->response as $file => $plugin ) { + if ( $plugin->slug === $api->slug ) { + $status = 'update_available'; + $update_file = $file; + $version = $plugin->new_version; + if ( current_user_can( 'update_plugins' ) ) { + $url = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . $update_file ), 'upgrade-plugin_' . $update_file ); + } + break; + } + } + } + + if ( 'install' === $status ) { + if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) { + $installed_plugin = get_plugins( '/' . $api->slug ); + if ( empty( $installed_plugin ) ) { + if ( current_user_can( 'install_plugins' ) ) { + $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug ); + } + } else { + $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. + */ + $key = reset( $key ); + + $update_file = $api->slug . '/' . $key; + if ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '=' ) ) { + $status = 'latest_installed'; + } elseif ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '<' ) ) { + $status = 'newer_installed'; + $version = $installed_plugin[ $key ]['Version']; + } else { + // If the above update check failed, then that probably means that the update checker has out-of-date information, force a refresh. + if ( ! $loop ) { + delete_site_transient( 'update_plugins' ); + wp_update_plugins(); + return install_plugin_install_status( $api, true ); + } + } + } + } else { + // "install" & no directory with that slug. + if ( current_user_can( 'install_plugins' ) ) { + $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug ); + } + } + } + if ( isset( $_GET['from'] ) ) { + $url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) ); + } + + $file = $update_file; + return compact( 'status', 'url', 'version', 'file' ); +} + +/** + * Displays plugin information in dialog box form. + * + * @since 2.7.0 + * + * @global string $tab + */ +function install_plugin_information() { + global $tab; + + if ( empty( $_REQUEST['plugin'] ) ) { + return; + } + + $api = plugins_api( + 'plugin_information', + array( + 'slug' => wp_unslash( $_REQUEST['plugin'] ), + ) + ); + + if ( is_wp_error( $api ) ) { + wp_die( $api ); + } + + $plugins_allowedtags = array( + 'a' => array( + 'href' => array(), + 'title' => array(), + 'target' => array(), + ), + 'abbr' => array( 'title' => array() ), + 'acronym' => array( 'title' => array() ), + 'code' => array(), + 'pre' => array(), + 'em' => array(), + 'strong' => array(), + 'div' => array( 'class' => array() ), + 'span' => array( 'class' => array() ), + 'p' => array(), + 'br' => array(), + 'ul' => array(), + 'ol' => array(), + 'li' => array(), + 'h1' => array(), + 'h2' => array(), + 'h3' => array(), + 'h4' => array(), + 'h5' => array(), + 'h6' => array(), + 'img' => array( + 'src' => array(), + 'class' => array(), + 'alt' => array(), + ), + 'blockquote' => array( 'cite' => true ), + ); + + $plugins_section_titles = array( + 'description' => _x( 'Description', 'Plugin installer section title' ), + 'installation' => _x( 'Installation', 'Plugin installer section title' ), + 'faq' => _x( 'FAQ', 'Plugin installer section title' ), + 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ), + 'changelog' => _x( 'Changelog', 'Plugin installer section title' ), + 'reviews' => _x( 'Reviews', 'Plugin installer section title' ), + 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' ), + ); + + // Sanitize HTML. + foreach ( (array) $api->sections as $section_name => $content ) { + $api->sections[ $section_name ] = wp_kses( $content, $plugins_allowedtags ); + } + + foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) { + if ( isset( $api->$key ) ) { + $api->$key = wp_kses( $api->$key, $plugins_allowedtags ); + } + } + + $_tab = esc_attr( $tab ); + + // Default to the Description tab, Do not translate, API returns English. + $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; + if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) { + $section_titles = array_keys( (array) $api->sections ); + $section = reset( $section_titles ); + } + + iframe_header( __( 'Plugin Installation' ) ); + + $_with_banner = ''; + + if ( ! empty( $api->banners ) && ( ! empty( $api->banners['low'] ) || ! empty( $api->banners['high'] ) ) ) { + $_with_banner = 'with-banner'; + $low = empty( $api->banners['low'] ) ? $api->banners['high'] : $api->banners['low']; + $high = empty( $api->banners['high'] ) ? $api->banners['low'] : $api->banners['high']; + ?> + <style type="text/css"> + #plugin-information-title.with-banner { + background-image: url( <?php echo esc_url( $low ); ?> ); + } + @media only screen and ( -webkit-min-device-pixel-ratio: 1.5 ) { + #plugin-information-title.with-banner { + background-image: url( <?php echo esc_url( $high ); ?> ); + } + } + </style> + <?php + } + + echo '<div id="plugin-information-scrollable">'; + echo "<div id='{$_tab}-title' class='{$_with_banner}'><div class='vignette'></div><h2>{$api->name}</h2></div>"; + echo "<div id='{$_tab}-tabs' class='{$_with_banner}'>\n"; + + foreach ( (array) $api->sections as $section_name => $content ) { + if ( 'reviews' === $section_name && ( empty( $api->ratings ) || 0 === array_sum( (array) $api->ratings ) ) ) { + continue; + } + + if ( isset( $plugins_section_titles[ $section_name ] ) ) { + $title = $plugins_section_titles[ $section_name ]; + } else { + $title = ucwords( str_replace( '_', ' ', $section_name ) ); + } + + $class = ( $section_name === $section ) ? ' class="current"' : ''; + $href = add_query_arg( + array( + 'tab' => $tab, + 'section' => $section_name, + ) + ); + $href = esc_url( $href ); + $san_section = esc_attr( $section_name ); + echo "\t<a name='$san_section' href='$href' $class>$title</a>\n"; + } + + echo "</div>\n"; + + ?> +<div id="<?php echo $_tab; ?>-content" class='<?php echo $_with_banner; ?>'> + <div class="fyi"> + <ul> + <?php if ( ! empty( $api->version ) ) { ?> + <li><strong><?php _e( 'Version:' ); ?></strong> <?php echo $api->version; ?></li> + <?php } if ( ! empty( $api->author ) ) { ?> + <li><strong><?php _e( 'Author:' ); ?></strong> <?php echo links_add_target( $api->author, '_blank' ); ?></li> + <?php } if ( ! empty( $api->last_updated ) ) { ?> + <li><strong><?php _e( 'Last Updated:' ); ?></strong> + <?php + /* translators: %s: Human-readable time difference. */ + printf( __( '%s ago' ), human_time_diff( strtotime( $api->last_updated ) ) ); + ?> + </li> + <?php } if ( ! empty( $api->requires ) ) { ?> + <li> + <strong><?php _e( 'Requires WordPress Version:' ); ?></strong> + <?php + /* translators: %s: Version number. */ + printf( __( '%s or higher' ), $api->requires ); + ?> + </li> + <?php } if ( ! empty( $api->tested ) ) { ?> + <li><strong><?php _e( 'Compatible up to:' ); ?></strong> <?php echo $api->tested; ?></li> + <?php } if ( ! empty( $api->requires_php ) ) { ?> + <li> + <strong><?php _e( 'Requires PHP Version:' ); ?></strong> + <?php + /* translators: %s: Version number. */ + printf( __( '%s or higher' ), $api->requires_php ); + ?> + </li> + <?php } if ( isset( $api->active_installs ) ) { ?> + <li><strong><?php _e( 'Active Installations:' ); ?></strong> + <?php + if ( $api->active_installs >= 1000000 ) { + $active_installs_millions = floor( $api->active_installs / 1000000 ); + printf( + /* translators: %s: Number of millions. */ + _nx( '%s+ Million', '%s+ Million', $active_installs_millions, 'Active plugin installations' ), + number_format_i18n( $active_installs_millions ) + ); + } elseif ( $api->active_installs < 10 ) { + _ex( 'Less Than 10', 'Active plugin installations' ); + } else { + echo number_format_i18n( $api->active_installs ) . '+'; + } + ?> + </li> + <?php } if ( ! empty( $api->slug ) && empty( $api->external ) ) { ?> + <li><a target="_blank" href="<?php echo esc_url( __( 'https://wordpress.org/plugins/' ) . $api->slug ); ?>/"><?php _e( 'WordPress.org Plugin Page »' ); ?></a></li> + <?php } if ( ! empty( $api->homepage ) ) { ?> + <li><a target="_blank" href="<?php echo esc_url( $api->homepage ); ?>"><?php _e( 'Plugin Homepage »' ); ?></a></li> + <?php } if ( ! empty( $api->donate_link ) && empty( $api->contributors ) ) { ?> + <li><a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a></li> + <?php } ?> + </ul> + <?php if ( ! empty( $api->rating ) ) { ?> + <h3><?php _e( 'Average Rating' ); ?></h3> + <?php + wp_star_rating( + array( + 'rating' => $api->rating, + 'type' => 'percent', + 'number' => $api->num_ratings, + ) + ); + ?> + <p aria-hidden="true" class="fyi-description"> + <?php + printf( + /* translators: %s: Number of ratings. */ + _n( '(based on %s rating)', '(based on %s ratings)', $api->num_ratings ), + number_format_i18n( $api->num_ratings ) + ); + ?> + </p> + <?php + } + + if ( ! empty( $api->ratings ) && array_sum( (array) $api->ratings ) > 0 ) { + ?> + <h3><?php _e( 'Reviews' ); ?></h3> + <p class="fyi-description"><?php _e( 'Read all reviews on WordPress.org or write your own!' ); ?></p> + <?php + foreach ( $api->ratings as $key => $ratecount ) { + // Avoid div-by-zero. + $_rating = $api->num_ratings ? ( $ratecount / $api->num_ratings ) : 0; + $aria_label = esc_attr( + sprintf( + /* translators: 1: Number of stars (used to determine singular/plural), 2: Number of reviews. */ + _n( + 'Reviews with %1$d star: %2$s. Opens in a new tab.', + 'Reviews with %1$d stars: %2$s. Opens in a new tab.', + $key + ), + $key, + number_format_i18n( $ratecount ) + ) + ); + ?> + <div class="counter-container"> + <span class="counter-label"> + <?php + printf( + '<a href="%s" target="_blank" aria-label="%s">%s</a>', + "https://wordpress.org/support/plugin/{$api->slug}/reviews/?filter={$key}", + $aria_label, + /* translators: %s: Number of stars. */ + sprintf( _n( '%d star', '%d stars', $key ), $key ) + ); + ?> + </span> + <span class="counter-back"> + <span class="counter-bar" style="width: <?php echo 92 * $_rating; ?>px;"></span> + </span> + <span class="counter-count" aria-hidden="true"><?php echo number_format_i18n( $ratecount ); ?></span> + </div> + <?php + } + } + if ( ! empty( $api->contributors ) ) { + ?> + <h3><?php _e( 'Contributors' ); ?></h3> + <ul class="contributors"> + <?php + foreach ( (array) $api->contributors as $contrib_username => $contrib_details ) { + $contrib_name = $contrib_details['display_name']; + if ( ! $contrib_name ) { + $contrib_name = $contrib_username; + } + $contrib_name = esc_html( $contrib_name ); + + $contrib_profile = esc_url( $contrib_details['profile'] ); + $contrib_avatar = esc_url( add_query_arg( 's', '36', $contrib_details['avatar'] ) ); + + echo "<li><a href='{$contrib_profile}' target='_blank'><img src='{$contrib_avatar}' width='18' height='18' alt='' />{$contrib_name}</a></li>"; + } + ?> + </ul> + <?php if ( ! empty( $api->donate_link ) ) { ?> + <a target="_blank" href="<?php echo esc_url( $api->donate_link ); ?>"><?php _e( 'Donate to this plugin »' ); ?></a> + <?php } ?> + <?php } ?> + </div> + <div id="section-holder"> + <?php + $requires_php = isset( $api->requires_php ) ? $api->requires_php : null; + $requires_wp = isset( $api->requires ) ? $api->requires : null; + + $compatible_php = is_php_version_compatible( $requires_php ); + $compatible_wp = is_wp_version_compatible( $requires_wp ); + $tested_wp = ( empty( $api->tested ) || version_compare( get_bloginfo( 'version' ), $api->tested, '<=' ) ); + + if ( ! $compatible_php ) { + $compatible_php_notice_message = '<p>'; + $compatible_php_notice_message .= __( '<strong>Error:</strong> This plugin <strong>requires a newer version of PHP</strong>.' ); + + if ( current_user_can( 'update_php' ) ) { + $compatible_php_notice_message .= sprintf( + /* translators: %s: URL to Update PHP page. */ + ' ' . __( '<a href="%s" target="_blank">Click here to learn more about updating PHP</a>.' ), + esc_url( wp_get_update_php_url() ) + ) . wp_update_php_annotation( '</p><p><em>', '</em>', false ); + } else { + $compatible_php_notice_message .= '</p>'; + } + + wp_admin_notice( + $compatible_php_notice_message, + array( + 'type' => 'error', + 'additional_classes' => array( 'notice-alt' ), + 'paragraph_wrap' => false, + ) + ); + } + + if ( ! $tested_wp ) { + wp_admin_notice( + __( '<strong>Warning:</strong> This plugin <strong>has not been tested</strong> with your current version of WordPress.' ), + array( + 'type' => 'warning', + 'additional_classes' => array( 'notice-alt' ), + ) + ); + } elseif ( ! $compatible_wp ) { + $compatible_wp_notice_message = __( '<strong>Error:</strong> This plugin <strong>requires a newer version of WordPress</strong>.' ); + if ( current_user_can( 'update_core' ) ) { + $compatible_wp_notice_message .= sprintf( + /* translators: %s: URL to WordPress Updates screen. */ + ' ' . __( '<a href="%s" target="_parent">Click here to update WordPress</a>.' ), + esc_url( self_admin_url( 'update-core.php' ) ) + ); + } + + wp_admin_notice( + $compatible_wp_notice_message, + array( + 'type' => 'error', + 'additional_classes' => array( 'notice-alt' ), + ) + ); + } + + foreach ( (array) $api->sections as $section_name => $content ) { + $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' ); + $content = links_add_target( $content, '_blank' ); + + $san_section = esc_attr( $section_name ); + + $display = ( $section_name === $section ) ? 'block' : 'none'; + + echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n"; + echo $content; + echo "\t</div>\n"; + } + echo "</div>\n"; + echo "</div>\n"; + echo "</div>\n"; // #plugin-information-scrollable + echo "<div id='$tab-footer'>\n"; + if ( ! empty( $api->download_link ) && ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) ) { + $status = install_plugin_install_status( $api ); + switch ( $status['status'] ) { + case 'install': + if ( $status['url'] ) { + if ( $compatible_php && $compatible_wp ) { + echo '<a data-slug="' . esc_attr( $api->slug ) . '" id="plugin_install_from_iframe" class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Now' ) . '</a>'; + } else { + printf( + '<button type="button" class="button button-primary button-disabled right" disabled="disabled">%s</button>', + _x( 'Cannot Install', 'plugin' ) + ); + } + } + break; + case 'update_available': + if ( $status['url'] ) { + if ( $compatible_php ) { + echo '<a data-slug="' . esc_attr( $api->slug ) . '" data-plugin="' . esc_attr( $status['file'] ) . '" id="plugin_update_from_iframe" class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __( 'Install Update Now' ) . '</a>'; + } else { + printf( + '<button type="button" class="button button-primary button-disabled right" disabled="disabled">%s</button>', + _x( 'Cannot Update', 'plugin' ) + ); + } + } + break; + case 'newer_installed': + /* translators: %s: Plugin version. */ + echo '<a class="button button-primary right disabled">' . sprintf( __( 'Newer Version (%s) Installed' ), esc_html( $status['version'] ) ) . '</a>'; + break; + case 'latest_installed': + echo '<a class="button button-primary right disabled">' . __( 'Latest Version Installed' ) . '</a>'; + break; + } + } + echo "</div>\n"; + + iframe_footer(); + exit; +} |