'; } // Build the row $row = '
Requires PHP Version '.$returned_object->requires_php.' — You are currently on Version '.phpversion().'
';
$install_text = 'Incompatible';
// If we're good to go, add the link
} else {
// Get the admin url for the plugin install page
if ( is_multisite() ) {
$admin_url = network_admin_url( 'plugin-install.php' );
} else {
$admin_url = admin_url( 'plugin-install.php' );
}
// Vars
$install_link = 'href="'.$admin_url.'?s='.esc_attr( $returned_object->name ).'&tab=search&type=term"';
$php_notice = '';
$install_text = 'Get Now';
}
// Short Description
$pos = strpos( $returned_object->sections[ 'description' ], '.');
$desc = substr( $returned_object->sections[ 'description' ], 0, $pos + 1 );
// Rating
$rating = helpdocs_get_five_point_rating(
$returned_object->ratings[1],
$returned_object->ratings[2],
$returned_object->ratings[3],
$returned_object->ratings[4],
$returned_object->ratings[5]
);
$active_installs = $returned_object->active_installs ? number_format( $returned_object->active_installs ) . '+' : '<10';
// Link guts
$link_guts = 'href="https://wordpress.org/plugins/'.esc_attr( $slug ).'/" target="_blank" aria-label="More information about '.$returned_object->name.' '.$returned_object->version.'" data-title="'.$returned_object->name.' '.$returned_object->version.'"';
?>
.esc_attr( $slug ); ?>.png)
Last Updated:
Active Installs
'.$stars.'
';
} // End helpdocs_convert_to_stars()
/**
* Get 5-point rating from 5 values
*
* @param int|float $r1
* @param int|float $r2
* @param int|float $r3
* @param int|float $r4
* @param int|float $r5
* @return float
*/
function helpdocs_get_five_point_rating ( $r1, $r2, $r3, $r4, $r5 ) {
// Calculate them on a 5-point rating system
$r5b = round( $r5 * 5, 0 );
$r4b = round( $r4 * 4, 0 );
$r3b = round( $r3 * 3, 0 );
$r2b = round( $r2 * 2, 0 );
$r1b = $r1;
$total = round( $r1 + $r2 + $r3 + $r4 + $r5, 0 );
if ( $total == 0 ) {
$r = 0;
} else {
$r = round( ( $r1b + $r2b + $r3b + $r4b + $r5b ) / $total, 2 );
}
return $r;
} // End helpdocs_get_five_point_rating()
/**
* Create a json file for the settings if updated
*
* @return void
*/
function helpdocs_create_json_from_settings() {
// Get all of the settings
$keys = (new HELPDOCS_GLOBAL_OPTIONS)->settings_general;
$keys = array_merge( $keys, [ 'colorize_separators', 'color_admin_menu_sep' ] );
// Store the values here
$values = [];
// Iter the keys
foreach ( $keys as $key ) {
// Get the option
if ( $key != 'copy_from' && $value = get_option( HELPDOCS_GO_PF.$key ) ) {
// Add the value
$values[ $key ] = $value;
}
}
// Add the date
$values[ 'last_updated' ] = helpdocs_convert_timezone();
// Convert to json
$json = wp_json_encode( $values );
// Initialize the filesystem
global $wp_filesystem;
if ( empty( $wp_filesystem ) ) {
require_once ABSPATH . 'wp-admin/includes/file.php';
WP_Filesystem();
}
if ( !$wp_filesystem ) {
error_log( esc_html__( 'Admin Help Docs: Error creating JSON from settings. Unable to initialize the filesystem.', 'admin-help-docs' ) );
return;
}
// Directories
$upload_dir = wp_upload_dir();
$folder = trailingslashit( $upload_dir[ 'basedir' ] . '/' . HELPDOCS_TEXTDOMAIN );
// Check if the directory exists, and if not, create it
if ( !$wp_filesystem->is_dir( $folder ) ) {
$wp_filesystem->mkdir( $folder );
}
// Write to file
$file = $folder.'settings.json';
// Write to file
if ( !$wp_filesystem->put_contents( $file, $json ) ) {
error_log( esc_html__( 'Admin Help Docs: Error creating JSON from settings. Failed to write settings to file.', 'admin-help-docs' ) );
}
} // End helpdocs_create_json_from_settings()
/**
* Import settings from a json link
*
* @return void
*/
function helpdocs_import_settings_from_json( $file ) {
// Fetch the file
$request = wp_remote_get( $file.'?time=' . time() );
// Is there an error?
if ( is_wp_error( $request ) || $request[ 'response' ][ 'code' ] == 404 ) {
return 'invalid_file';
}
// Open the file
$json = wp_remote_retrieve_body( $request );
// Check if it's in json format
if ( !helpdocs_is_json( $json ) ) {
return 'invalid_file';
}
// Decode it
$settings = json_decode( $json );
// Get our setting meta keys for validation
// Get all of the settings
$keys = (new HELPDOCS_GLOBAL_OPTIONS)->settings_general;
$keys = array_merge( $keys, [ 'colorize_separators', 'color_admin_menu_sep' ] );
// Bools
$bools = [
'admin_bar',
'hide_version',
'disable_user_prefs',
'colorize_separators'
];
// Numbers
$nums = [
'menu_position'
];
// URLs
$urls = [
'logo'
];
// Iter the items
foreach ( $settings as $setting => $value ) {
// Don't import multisite setting if it's not a multisite
if ( !is_multisite() && $setting == 'multisite_sfx' ) {
delete_option( HELPDOCS_GO_PF.$setting );
continue;
}
// validate the key
if ( in_array( $setting, $keys ) && $setting !== 'edit_roles' ) {
// Sanitize
if ( in_array( $setting, $bools ) ) {
$value = filter_var( $value, FILTER_VALIDATE_BOOLEAN );
} elseif ( in_array( $setting, $nums ) ) {
$value = absint( $value );
} elseif ( in_array( $setting, $urls ) ) {
$value = esc_url_raw( $value );
} else {
$value = sanitize_text_field( $value );
}
// Update
update_option( HELPDOCS_GO_PF.$setting, $value );
}
}
// Return true because it worked
return true;
} // End helpdocs_import_settings_from_json()
/**
* Check if a string is json format
*
* @param string $string
* @return bool
*/
function helpdocs_is_json( $string ) {
json_decode( $string );
return json_last_error() === JSON_ERROR_NONE;
} // End helpdocs_is_json()
/**
* Get the plugin title
*
* @return string
*/
function helpdocs_title() {
if ( get_option( HELPDOCS_GO_PF.'page_title' ) && get_option( HELPDOCS_GO_PF.'page_title' ) != '' ) {
return get_option( HELPDOCS_GO_PF.'page_title' );
} else {
return HELPDOCS_NAME;
}
} // End helpdocs_title()
/**
* Get the plugin menu title
*
* @return string
*/
function helpdocs_menu_title() {
if ( get_option( HELPDOCS_GO_PF.'menu_title' ) && get_option( HELPDOCS_GO_PF.'menu_title' ) != '' ) {
return get_option( HELPDOCS_GO_PF.'menu_title' );
} else {
return 'Help Docs';
}
} // End helpdocs_menu_title()
/**
* Get the logo
*
* @return string
*/
function helpdocs_logo() {
if ( get_option( HELPDOCS_GO_PF.'logo' ) && get_option( HELPDOCS_GO_PF.'logo' ) != '' ) {
return get_option( HELPDOCS_GO_PF.'logo' );
} else {
return HELPDOCS_PLUGIN_IMG_PATH.'logo.png';
}
} // End helpdocs_logo()
/**
* THE END
*/