' : '' ) . $title;
if ( is_string( $confirmation ) ) {
return sprintf( '',
freemius( $module_id )->_get_admin_page_url( $page, $params ),
$method,
$action,
wp_nonce_field( $action, '_wpnonce', true, false ),
'button' . ( $is_primary ? ' button-primary' : '' ),
$confirmation,
$title
);
} else if ( 'GET' !== strtoupper( $method ) ) {
return sprintf( '',
freemius( $module_id )->_get_admin_page_url( $page, $params ),
$method,
$action,
wp_nonce_field( $action, '_wpnonce', true, false ),
'button' . ( $is_primary ? ' button-primary' : '' ),
$title
);
} else {
return sprintf( '%s',
wp_nonce_url( freemius( $module_id )->_get_admin_page_url( $page, array_merge( $params, array( 'fs_action' => $action ) ) ), $action ),
'button' . ( $is_primary ? ' button-primary' : '' ),
$title
);
}
}
function fs_ui_action_link( $module_id, $page, $action, $title, $params = array() ) {
?> $value ) {
$lower_param = strtolower( $parameter );
// Skip ignore params.
if ( in_array( $lower_param, $ignore_params ) ||
( false !== $params_prefix && fs_starts_with( $lower_param, $params_prefix ) )
) {
continue;
}
if ( is_array( $value ) ) {
// If two or more parameters share the same name, they are sorted by their value
// Ref: Spec: 9.1.1 (1)
natsort( $value );
foreach ( $value as $duplicate_value ) {
$pairs[] = $lower_param . '=' . $duplicate_value;
}
} else {
$pairs[] = $lower_param . '=' . $value;
}
}
if ( 0 === count( $pairs ) ) {
return '';
}
return implode( "&", $pairs );
}
}
if ( ! function_exists( 'fs_urlencode_rfc3986' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.1.3
*
* @param string|string[] $input
*
* @return array|mixed|string
*/
function fs_urlencode_rfc3986( $input ) {
if ( is_array( $input ) ) {
return array_map( 'fs_urlencode_rfc3986', $input );
} else if ( is_scalar( $input ) ) {
return str_replace( '+', ' ', str_replace( '%7E', '~', rawurlencode( $input ) ) );
}
return '';
}
}
#endregion Url Canonization ------------------------------------------------------------------
/**
* @author Vova Feldman (@svovaf)
*
* @since 1.2.2 Changed to usage of WP_Filesystem_Direct.
*
* @param string $from URL
* @param string $to File path.
*
* @return bool Is successfully downloaded.
*/
function fs_download_image( $from, $to ) {
$dir = dirname( $to );
if ( 'direct' !== get_filesystem_method( array(), $dir ) ) {
return false;
}
if ( ! class_exists( 'WP_Filesystem_Direct' ) ) {
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php';
}
$fs = new WP_Filesystem_Direct( '' );
$tmpfile = download_url( $from );
if ( $tmpfile instanceof WP_Error ) {
// Issue downloading the file.
return false;
}
$fs->copy( $tmpfile, $to );
$fs->delete( $tmpfile );
return true;
}
/* General Utilities
--------------------------------------------------------------------------------------------*/
/**
* Sorts an array by the value of the priority key.
*
* @author Daniel Iser (@danieliser)
* @since 1.1.7
*
* @param $a
* @param $b
*
* @return int
*/
function fs_sort_by_priority( $a, $b ) {
// If b has a priority and a does not, b wins.
if ( ! isset( $a['priority'] ) && isset( $b['priority'] ) ) {
return 1;
} // If b has a priority and a does not, b wins.
elseif ( isset( $a['priority'] ) && ! isset( $b['priority'] ) ) {
return - 1;
} // If neither has a priority or both priorities are equal its a tie.
elseif ( ( ! isset( $a['priority'] ) && ! isset( $b['priority'] ) ) || $a['priority'] === $b['priority'] ) {
return 0;
}
// If both have priority return the winner.
return ( $a['priority'] < $b['priority'] ) ? - 1 : 1;
}
#--------------------------------------------------------------------------------
#region Localization
#--------------------------------------------------------------------------------
if ( ! function_exists( 'fs_text' ) ) {
/**
* Retrieve a translated text by key.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.1.7
*
* @param string $key
* @param string $slug
*
* @return string
*
* @global $fs_text , $fs_text_overrides
*/
function fs_text( $key, $slug = 'freemius' ) {
return __fs( $key, $slug );
}
/**
* Get a translatable text override if exists, or `false`.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.1.7
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string|false
*/
function fs_text_override( $text, $key, $slug ) {
global $fs_text_overrides;
/**
* Check if string is overridden.
*/
if ( ! isset( $fs_text_overrides[ $slug ] ) ) {
return false;
}
if ( empty( $key ) ) {
$key = strtolower( str_replace( ' ', '-', $text ) );
}
if ( isset( $fs_text_overrides[ $slug ][ $key ] ) ) {
return $fs_text_overrides[ $slug ][ $key ];
}
$lower_key = strtolower( $key );
if ( isset( $fs_text_overrides[ $slug ][ $lower_key ] ) ) {
return $fs_text_overrides[ $slug ][ $lower_key ];
}
return false;
}
/**
* Get a translatable text and its text domain.
*
* When the text is overridden by the module, returns the overridden text and the text domain of the module. Otherwise, returns the original text and 'freemius' as the text domain.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.1.7
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string[]
*/
function fs_text_and_domain( $text, $key, $slug ) {
$override = fs_text_override( $text, $key, $slug );
if ( false === $override ) {
// No override, use FS text domain.
$text_domain = 'freemius';
} else {
// Found an override.
$text = $override;
// Use the module's text domain.
$text_domain = $slug;
}
return array( $text, $text_domain );
}
#region Private
/**
* Retrieve an inline translated text by key.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*
* @global $fs_text_overrides
*/
function _fs_text_inline( $text, $key = '', $slug = 'freemius' ) {
list( $text, $text_domain ) = fs_text_and_domain( $text, $key, $slug );
// Avoid misleading Theme Check warning.
$fn = 'translate';
return $fn( $text, $text_domain );
}
/**
* Retrieve an inline translated text by key with a context.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*
* @global $fs_text_overrides
*/
function _fs_text_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
list( $text, $text_domain ) = fs_text_and_domain( $text, $key, $slug );
// Avoid misleading Theme Check warning.
$fn = 'translate_with_gettext_context';
return $fn( $text, $context, $text_domain );
}
#endregion
/**
* Retrieve an inline translated text by key.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*
* @global $fs_text_overrides
*/
function fs_text_inline( $text, $key = '', $slug = 'freemius' ) {
return _fs_text_inline( $text, $key, $slug );
}
/**
* Retrieve an inline translated text by key with a context.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*
* @global $fs_text_overrides
*/
function fs_text_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
return _fs_text_x_inline( $text, $context, $key, $slug );
}
/**
* Output a translated text by key.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.1.7
*
* @param string $key
* @param string $slug
*/
function fs_echo( $key, $slug = 'freemius' ) {
echo fs_text( $key, $slug );
}
/**
* Output an inline translated text.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_echo_inline( $text, $key = '', $slug = 'freemius' ) {
echo _fs_text_inline( $text, $key, $slug );
}
/**
* Output an inline translated text with a context.
*
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_echo_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
echo _fs_text_x_inline( $text, $context, $key, $slug );
}
}
if ( ! function_exists( 'fs_esc_attr' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*
* @return string
*/
function fs_esc_attr( $key, $slug ) {
return esc_attr( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_attr_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_attr_inline( $text, $key = '', $slug = 'freemius' ) {
return esc_attr( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_attr_x_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_attr_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
return esc_attr( _fs_text_x_inline( $text, $context, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_attr_echo' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*/
function fs_esc_attr_echo( $key, $slug ) {
echo esc_attr( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_attr_echo_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_esc_attr_echo_inline( $text, $key = '', $slug = 'freemius' ) {
echo esc_attr( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*
* @return string
*/
function fs_esc_js( $key, $slug ) {
return esc_js( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_js_inline( $text, $key = '', $slug = 'freemius' ) {
return esc_js( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js_x_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_js_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
return esc_js( _fs_text_x_inline( $text, $context, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js_echo_x_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_js_echo_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
echo esc_js( _fs_text_x_inline( $text, $context, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js_echo' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*/
function fs_esc_js_echo( $key, $slug ) {
echo esc_js( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_js_echo_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_esc_js_echo_inline( $text, $key = '', $slug = 'freemius' ) {
echo esc_js( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_json_encode_echo' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*/
function fs_json_encode_echo( $key, $slug ) {
echo json_encode( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_json_encode_echo_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_json_encode_echo_inline( $text, $key = '', $slug = 'freemius' ) {
echo json_encode( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*
* @return string
*/
function fs_esc_html( $key, $slug ) {
return esc_html( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_html_inline( $text, $key = '', $slug = 'freemius' ) {
return esc_html( _fs_text_inline( $text, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html_x_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*
* @return string
*/
function fs_esc_html_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
return esc_html( _fs_text_x_inline( $text, $context, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html_echo_x_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $context Context information for the translators.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_esc_html_echo_x_inline( $text, $context, $key = '', $slug = 'freemius' ) {
echo esc_html( _fs_text_x_inline( $text, $context, $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html_echo' ) ) {
/**
* @author Vova Feldman
* @since 1.2.1.6
*
* @param string $key
* @param string $slug
*/
function fs_esc_html_echo( $key, $slug ) {
echo esc_html( fs_text( $key, $slug ) );
}
}
if ( ! function_exists( 'fs_esc_html_echo_inline' ) ) {
/**
* @author Vova Feldman (@svovaf)
* @since 1.2.3
*
* @param string $text Translatable string.
* @param string $key String key for overrides.
* @param string $slug Module slug for overrides.
*/
function fs_esc_html_echo_inline( $text, $key = '', $slug = 'freemius' ) {
echo esc_html( _fs_text_inline( $text, $key, $slug ) );
}
}
#endregion