# plugins-list/2.7/inc/generate-plugin-data.php

Plugins List, version 2.7. 582 lines.

- Page: https://pluginprobe.com/plugins/plugins-list/2.7/code/inc/generate-plugin-data.php
- Raw: https://pluginprobe.com/plugins/plugins-list/2.7/raw/inc/generate-plugin-data.php
- Modified: 2024-04-22T06:24:56+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/plugins-list/2.7/code/inc/generate-plugin-data.php#L10-L20`.

```php
<?php
/**
 * Shared Functions
 *
 * A group of functions shared across my plugins, for consistency.
 *
 * @package plugin-slug
 */

// Exit if accessed directly.

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Get Plugins List
 *
 * Get list of plugins and, optionally, format them
 *
 * @uses     pll_format_plugin_list Format the plugin list
 * @uses     pll_get_data           Get the plugin data
 *
 * @param    string $format         Requires format.
 * @param    string $show_inactive  Whether to format or not.
 * @param    string $show_active    Whether to show active or not.
 * @param    string $show_recent    Whether to show recenty active or not.
 * @param    string $cache          Cache time.
 * @param    string $nofollow       Whether to add nofollow to link.
 * @param    string $target         Link target.
 * @param    string $by_author      Which author.
 * @param    string $characters     Maximum characters for description.
 * @param    string $words          Maximum words for description.
 * @param    string $emoji          True or false, whether to strip emoji from description.
 * @param    string $end            When the description is truncated, what to place at the end of the string.
 * @return   string                 Output.
 */
function pll_get_plugins_list( $format, $show_inactive, $show_active, $show_recent, $cache, $nofollow, $target, $by_author, $characters, $words, $emoji, $end ) {

	// Set default values.

	if ( '' === $format ) {
		$format = DEFAULT_PLUGIN_LIST_FORMAT;
	}
	if ( '' === $show_inactive ) {
		$show_inactive = 'false';
	}
	if ( '' === $show_active ) {
		$show_active = 'true';
	}
	if ( '' === $show_recent ) {
		$show_recent = 'true';
	}
	if ( '' === $cache ) {
		$cache = 5;
	}
	if ( $nofollow ) {
		$nofollow = ' rel="nofollow"';
	} else {
		$nofollow = '';
	}
	if ( '' !== $target ) {
		$target = ' target="' . $target . '"';
	} else {
		$target = '';
	}
	if ( '' !== $by_author ) {
		$by_author = 'true';
	}
	if ( 'false' === $emoji ) {
		$emoji = false;
	} else {
		$emoji = true;
	}
	if ( '' === $end ) {
		$end = '&#8230;';
	}

	// Get plugin data.

	$plugins = pll_get_data( $cache );

	// Sort the plugin array if required in author sequence.

	if ( 'true' === $by_author ) {
		uasort(
			$plugins,
			function ( $a, $b ) {
				return strtoupper( $a['Author'] ) <=> strtoupper( $b['Author'] );
			}
		);
	}

	// Get array of recently activate plugins.

	if ( is_network_admin() ) {
		$recently_activated = get_site_option( 'recently_activated', array() );
	} else {
		$recently_activated = get_option( 'recently_activated', array() );
	}

	// Extract each plugin and format the output.

	$output = '';

	foreach ( $plugins as $plugin_file => $plugin_data ) {

		// Work out whether plugin is active or not.

		$plugin_active = false;
		if ( is_plugin_active( $plugin_file ) ) {
			$plugin_active = true;
		}

		// Was this recently active?

		$recently_active = false;
		if ( is_array( $recently_activated ) && array_key_exists( $plugin_file, $recently_activated ) ) {
			$recently_active = true;
		}

		// Depending on whhat was requested, format the current plugin for output.

		if ( ( $recently_active && 'true' === $show_recent ) || ( $plugin_active && 'true' === $show_active ) || ( ! $plugin_active && 'true' === $show_inactive ) ) {

			$output .= pll_format_plugin_list( $plugin_data, $format, $nofollow, $target, $characters, $words, $emoji, $end, $plugin_active );
		}
	}

	// Return the code, with HTML comments.

	return "\n" . $output . "\n";
}

/**
 * Get Plugin number
 *
 * Get number of plugins
 *
 * @since    2.2
 *
 * @uses     pll_get_data           Get the plugin data
 *
 * @param    string $show_active    Whether to include active plugins or not.
 * @param    string $show_inactive  Whether to include inactive plugins or not.
 * @param    string $cache          Cache time.
 * @return   string                 Plugin number.
 */
function pll_get_plugin_number( $show_active, $show_inactive, $cache ) {

	// Get plugin data.

	$plugins = pll_get_data( $cache );

	// Get count.

	if ( 'true' === $show_inactive && 'true' === $show_active ) {
		$output = count( $plugins );
	} else {
		$output = 0;
		foreach( $plugins as $plugin_file => $plugin_data ) { // @codingStandardsIgnoreLine -- require $plugin_data for array values but not doing anything with it
			if ( is_plugin_active( $plugin_file ) ) {
				++$output;
			}
		}
		if ( 'true' === $show_inactive ) {
			$output = count( $plugins ) - $output; }
	}

	return $output;
}

/**
 * Get Plugins data
 *
 * Get plugin data and cache it
 *
 * @uses     pll_format_plugin_list  Format the plugin list.
 *
 * @param    string $cache           Cache time.
 * @return   string                  Plugin data.
 */
function pll_get_data( $cache ) {

	// Attempt to get plugin list from cache.

	if ( ! $cache ) {
		$cache = 'no'; }

	$plugins   = false;
	$cache_key = 'plugins_list';
	if ( is_numeric( $cache ) ) {
		$plugins = get_transient( $cache_key ); }

	// If not using cache, generate a new list and cache that.

	if ( ! $plugins ) {
		$plugins = get_plugins();
		if ( ( '' !== $plugins ) && ( is_numeric( $cache ) ) ) {
			set_transient( $cache_key, $plugins, MINUTE_IN_SECONDS * $cache ); }
	}

	return $plugins;
}

/**
 * Format Plugin List
 *
 * Format the plugin list
 *
 * @uses     replace_plugin_list_tags  Replace the tags
 *
 * @param    string $plugin_data       The plugin list.
 * @param    string $format            Format to use.
 * @param    string $nofollow          Nofollow text.
 * @param    string $target            Target text.
 * @param    string $characters        Maximum characters for description.
 * @param    string $words             Maximum words for description.
 * @param    string $emoji             True or false, whether to strip emoji from description.
 * @param    string $end               When the description is truncated, what to place at the end of the string.
 * @param    string $plugin_active     True or false, whether the plugin is active or not.
 * @return   string                    Output.
 */
function pll_format_plugin_list( $plugin_data, $format, $nofollow, $target, $characters, $words, $emoji, $end, $plugin_active ) {

	// Allowed tag.

	$plugins_allowedtags = array(
		'a'       => array(
			'href'  => array(),
			'title' => array(),
		),
		'abbr'    => array( 'title' => array() ),
		'acronym' => array( 'title' => array() ),
		'code'    => array(),
		'em'      => array(),
		'strong'  => array(),
	);

	// Sanitize all displayed data.

	$plugin_data['Title']       = wp_kses( $plugin_data['Title'], $plugins_allowedtags );
	$plugin_data['PluginURI']   = wp_kses( $plugin_data['PluginURI'], $plugins_allowedtags );
	$plugin_data['AuthorURI']   = wp_kses( $plugin_data['AuthorURI'], $plugins_allowedtags );
	$plugin_data['Version']     = wp_kses( $plugin_data['Version'], $plugins_allowedtags );
	$plugin_data['Author']      = wp_kses( $plugin_data['Author'], $plugins_allowedtags );
	$plugin_data['RequiresWP']  = wp_kses( $plugin_data['RequiresWP'], $plugins_allowedtags );
	$plugin_data['RequiresPHP'] = wp_kses( $plugin_data['RequiresPHP'], $plugins_allowedtags );

	// Get plugin activity status.

	if ( $plugin_active ) {
		$plugin_data['Active'] = __( 'Active', 'plugins-list' );
	} else {
		$plugin_data['Active'] = __( 'Inactive', 'plugins-list' );
	}

	// Strip emoji, HTML and unnecessary space from the description.

	if ( false === $emoji ) {
		$plugin_data['Description'] = remove_emoji_from_plugin_desc( $plugin_data['Description'] );
	}
	$plugin_data['Description'] = strip_spaces_from_plugin_desc( wp_strip_all_tags( $plugin_data['Description'] ) );

	// Truncate the description, if required.

	if ( '' !== $characters || '' !== $words ) {

		// Use WordPress function to truncate description at a set number of words (ellipsis added automatically).

		if ( '' !== $words ) {
			$word_limited               = wp_trim_words( $plugin_data['Description'], $words, $end );
			$plugin_data['Description'] = $word_limited;
		}

		// Manually truncate description to a set number of characters. This is done cleanly, however, by doing so to
		// the previous space. Then an ellipsis is added.

		if ( '' !== $characters ) {
			$character_limited = $plugin_data['Description'];
			// Make sure the description is greater than the required length.
			if ( strlen( $character_limited ) > $characters ) {
				$space = strrpos( substr( $character_limited, 0, $characters + 1 ), ' ' );

				if ( false === $space ) {
					// If there is no space before the truncation length, just truncate.
					$character_limited = substr( $character_limited, 0, $characters );
				} else {
					// If there is a space within the truncated area, trim to that.
					$character_limited = substr( $character_limited, 0, $space );
				}
				$plugin_data['Description'] = rtrim( $character_limited ) . $end;
			}
		}

		// If both words and character limits are used, take whichever results in the shortest result.

		if ( ( '' !== $characters && '' !== $words ) && ( $word_limited < $character_limited ) ) {
			$plugin_data['Description'] = $word_limited;
		}
	}

	// Replace the tags.

	$format = replace_plugin_list_tags( $plugin_data, $format, $nofollow, $target );

	return $format;
}

/**
 * Replace tags
 *
 * Replace the tags in the provided format
 *
 * @param    string $plugin_data    The plugin list.
 * @param    string $format         Format to use.
 * @param    string $nofollow       Nofollow text.
 * @param    string $target         Target text.
 * @return   string                 Output.
 */
function replace_plugin_list_tags( $plugin_data, $format, $nofollow, $target ) {

	$format = strtr(
		$format,
		array(
			'{{Title}}'        => $plugin_data['Title'],
			'{{PluginURI}}'    => $plugin_data['PluginURI'],
			'{{AuthorURI}}'    => $plugin_data['AuthorURI'],
			'{{Version}}'      => $plugin_data['Version'],
			'{{Description}}'  => $plugin_data['Description'],
			'{{Author}}'       => $plugin_data['Author'],
			'{{RequiresWP}}'   => $plugin_data['RequiresWP'],
			'{{RequiresPHP}}'  => $plugin_data['RequiresPHP'],
			'{{Active}}'       => $plugin_data['Active'],
			'{{LinkedTitle}}'  => "<a href='" . $plugin_data['PluginURI'] . "' title='" . $plugin_data['Title'] . "'" . $nofollow . $target . '>' . $plugin_data['Title'] . '</a>',
			'{{LinkedAuthor}}' => "<a href='" . $plugin_data['AuthorURI'] . "' title='" . $plugin_data['Author'] . "'" . $nofollow . $target . '>' . $plugin_data['Author'] . '</a>',
			'#Title#'          => $plugin_data['Title'],
			'#PluginURI#'      => $plugin_data['PluginURI'],
			'#AuthorURI#'      => $plugin_data['AuthorURI'],
			'#Version#'        => $plugin_data['Version'],
			'#Description#'    => $plugin_data['Description'],
			'#Author#'         => $plugin_data['Author'],
			'#RequiresWP#'     => $plugin_data['RequiresWP'],
			'#RequiresPHP#'    => $plugin_data['RequiresPHP'],
			'#Active#'         => $plugin_data['Active'],
			'#LinkedTitle#'    => "<a href='" . $plugin_data['PluginURI'] . "' title='" . $plugin_data['Title'] . "'" . $nofollow . $target . '>' . $plugin_data['Title'] . '</a>',
			'#LinkedAuthor#'   => "<a href='" . $plugin_data['AuthorURI'] . "' title='" . $plugin_data['Author'] . "'" . $nofollow . $target . '>' . $plugin_data['Author'] . '</a>',
			'{{'               => '<',
			'}}'               => '>',
			'{'                => '<',
			'}'                => '>',
		)
	);

	// Remove all HTML tags other than those used for formatting.

	$allowed_tags = array(
		'a'          => array(
			'href'     => array(),
			'hreflang' => array(),
			'rel'      => array(),
			'target'   => array(),
			'type'     => array(),
			'class'    => array(),
			'style'    => array(),
		),
		'b'          => array(),
		'big'        => array(),
		'blockquote' => array(
			'cite'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'br'         => array(),
		'caption'    => array(),
		'center'     => array(),
		'cite'       => array(),
		'code'       => array(
			'pre'   => array(),
			'class' => array(),
			'style' => array(),
		),
		'col'        => array(
			'span'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'colgroup'   => array(
			'span'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'div'        => array(
			'class' => array(),
			'style' => array(),
		),
		'em'         => array(
			'class' => array(),
			'style' => array(),
		),
		'font'       => array(
			'class' => array(),
			'style' => array(),
		),
		'h1'         => array(
			'class' => array(),
			'style' => array(),
		),
		'h2'         => array(
			'class' => array(),
			'style' => array(),
		),
		'h3'         => array(
			'class' => array(),
			'style' => array(),
		),
		'h4'         => array(
			'class' => array(),
			'style' => array(),
		),
		'h5'         => array(
			'class' => array(),
			'style' => array(),
		),
		'h6'         => array(
			'class' => array(),
			'style' => array(),
		),
		'hr'         => array(
			'class' => array(),
			'style' => array(),
		),
		'i'          => array(
			'class' => array(),
			'style' => array(),
		),
		'img'        => array(
			'src'   => array(),
			'alt'   => array(),
			'class' => array(),
			'style' => array(),
		),
		'li'         => array(
			'class' => array(),
			'style' => array(),
		),
		'ol'         => array(
			'start' => array(),
			'type'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'p'          => array(
			'class' => array(),
			'style' => array(),
		),
		'pre'        => array(
			'code'  => array(),
			'samp'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'q'          => array(
			'cite'  => array(),
			'class' => array(),
			'style' => array(),
		),
		's'          => array(
			'class' => array(),
			'style' => array(),
		),
		'small'      => array(
			'class' => array(),
			'style' => array(),
		),
		'span'       => array(
			'class' => array(),
			'style' => array(),
		),
		'strike'     => array(
			'class' => array(),
			'style' => array(),
		),
		'strong'     => array(
			'class' => array(),
			'style' => array(),
		),
		'style'      => array(
			'type'  => array(),
			'class' => array(),
			'style' => array(),
		),
		'sub'        => array(
			'class' => array(),
			'style' => array(),
		),
		'sup'        => array(
			'class' => array(),
			'style' => array(),
		),
		'table'      => array(
			'class' => array(),
			'style' => array(),
		),
		'td'         => array(
			'colspan' => array(),
			'headers' => array(),
			'rowspan' => array(),
			'class'   => array(),
			'style'   => array(),
		),
		'th'         => array(
			'colspan' => array(),
			'headers' => array(),
			'rowspan' => array(),
			'scope'   => array(),
			'class'   => array(),
			'style'   => array(),
		),
		'tr'         => array(
			'class' => array(),
			'style' => array(),
		),
		'u'          => array(
			'class' => array(),
			'style' => array(),
		),
		'ul'         => array(
			'class' => array(),
			'style' => array(),
		),
	);

	$format = wp_kses( $format, $allowed_tags );

	return $format;
}

/**
 * Remove emoji
 *
 * Function to strip emoji from the plugin description.
 *
 * @param    string $description    The plugin description.
 * @return   string                 Stripped description.
 */
function remove_emoji_from_plugin_desc( $description ) {

	$symbols = "\x{1F100}-\x{1F1FF}" // Enclosed Alphanumeric Supplement.
		. "\x{1F300}-\x{1F5FF}"      // Miscellaneous Symbols and Pictographs.
		. "\x{1F600}-\x{1F64F}"      // Emoticons.
		. "\x{1F680}-\x{1F6FF}"      // Transport And Map Symbols.
		. "\x{1F900}-\x{1F9FF}"      // Supplemental Symbols and Pictographs.
		. "\x{2600}-\x{26FF}"        // Miscellaneous Symbols.
		. "\x{2700}-\x{27BF}";       // Dingbats.

	$description = preg_replace( '/[' . $symbols . ']+/u', '', $description );

	return $description;
}

/**
 * Strip spaces
 *
 * Function to strip extra spaces from the plugin description.
 *
 * @param    string $description    The plugin description.
 * @return   string                 Stripped description.
 */
function strip_spaces_from_plugin_desc( $description ) {

	$continue = true;
	while ( true === $continue ) {
		$replace = str_replace( '  ', ' ', $description );
		if ( $replace === $description ) {
			$continue = false;
		}
		$description = $replace;
	}
	return trim( $description );
}

```