'download'
);
// Default URL
$admin_url = admin_url( 'edit.php' );
// Get the base admin URL
$url = add_query_arg( $args, $admin_url );
// Filter & return
return apply_filters( 'edd_get_admin_base_url', $url, $args, $admin_url );
}
/**
* Get the admin URL, maybe with arguments added
*
* @since 3.0
*
* @param array $args
* @return string
*/
function edd_get_admin_url( $args = array() ) {
return add_query_arg( $args, edd_get_admin_base_url() );
}
/**
* Is Test Mode
*
* @since 1.0
* @return bool $ret True if test mode is enabled, false otherwise
*/
function edd_is_test_mode() {
$ret = edd_get_option( 'test_mode', false );
// Override any setting with the constant.
if ( edd_is_test_mode_forced() ) {
$ret = true;
}
// At the end of the day, the filter still has the final say.
return (bool) apply_filters( 'edd_is_test_mode', $ret );
}
/**
* Is Debug Mode
*
* @since 2.8.7
* @return bool $ret True if debug mode is enabled, false otherwise
*/
function edd_is_debug_mode() {
$ret = edd_get_option( 'debug_mode', false );
if( defined( 'EDD_DEBUG_MODE' ) && EDD_DEBUG_MODE ) {
$ret = true;
}
return (bool) apply_filters( 'edd_is_debug_mode', $ret );
}
/**
* Check the network site URL for signs of being a development environment.
*
* @since 3.0
*
* @return bool $is_dev_environment True if development environment; otherwise false.
*/
function edd_is_dev_environment() {
// wp_get_environment_type was added in WordPress 5.5.
if ( function_exists( 'wp_get_environment_type' ) ) {
$environment = wp_get_environment_type();
return apply_filters( 'edd_is_dev_environment', in_array( $environment, array( 'local', 'development' ), true ) );
}
// Assume not a development environment
$is_dev_environment = false;
// Get this one time and use it below
$network_url = network_site_url( '/' );
// Possible strings
$strings = array(
// Popular port suffixes
':8888', // This is common with MAMP on OS X
// Popular development TLDs
'.dev', // VVV
'.local', // Local
'.test', // IETF
'.example', // IETF
'.invalid', // IETF
'.localhost', // IETF
// Popular development subdomains
'dev.',
// Popular development domains
'localhost',
'example.com',
);
// Loop through all strings
foreach ( $strings as $string ) {
if ( stristr( $network_url, $string ) ) {
$is_dev_environment = true;
break;
}
}
// Filter & return
return apply_filters( 'edd_is_dev_environment', $is_dev_environment );
}
/**
* Checks if Guest checkout is enabled
*
* @since 1.0
* @return bool $ret True if guest checkout is enabled, false otherwise
*/
function edd_no_guest_checkout() {
$ret = edd_get_option( 'logged_in_only', false );
return (bool) apply_filters( 'edd_no_guest_checkout', $ret );
}
/**
* Checks if users can only purchase downloads when logged in
*
* @since 1.0
* @return bool $ret Whether or not the logged_in_only setting is set
*/
function edd_logged_in_only() {
$ret = edd_get_option( 'logged_in_only', false );
return (bool) apply_filters( 'edd_logged_in_only', $ret );
}
/**
* Redirect to checkout immediately after adding items to the cart?
*
* @since 1.4.2
* @return bool $ret True is redirect is enabled, false otherwise
*/
function edd_straight_to_checkout() {
$ret = edd_get_option( 'redirect_on_add', false );
return (bool) apply_filters( 'edd_straight_to_checkout', $ret );
}
/**
* Disable Redownload
*
* @since 1.0.8.2
* @return bool True if redownloading of files is disabled, false otherwise
*/
function edd_no_redownload() {
$ret = edd_get_option( 'disable_redownload', false );
return (bool) apply_filters( 'edd_no_redownload', $ret );
}
/**
* Verify credit card numbers live?
*
* @since 1.4
* @return bool $ret True is verify credit cards is live
*/
function edd_is_cc_verify_enabled() {
$ret = true;
/*
* Enable if use a single gateway other than PayPal or Manual. We have to assume it accepts credit cards
* Enable if using more than one gateway if they aren't both PayPal and manual, again assuming credit card usage
*/
$gateways = edd_get_enabled_payment_gateways();
if ( count( $gateways ) == 1 && ! isset( $gateways['paypal'] ) && ! isset( $gateways['manual'] ) ) {
$ret = true;
} else if ( count( $gateways ) == 1 ) {
$ret = false;
} else if ( count( $gateways ) == 2 && isset( $gateways['paypal'] ) && isset( $gateways['manual'] ) ) {
$ret = false;
}
return (bool) apply_filters( 'edd_verify_credit_cards', $ret );
}
/**
* Is Odd
*
* Checks whether an integer is odd.
*
* @since 1.0
* @param int $int The integer to check
* @return bool Is the integer odd?
*/
function edd_is_odd( $int ) {
return (bool) ( $int & 1 );
}
/**
* Get File Extension
*
* Returns the file extension of a filename.
*
* @since 1.0
*
* @param unknown $str File name
*
* @return mixed File extension
*/
function edd_get_file_extension( $str ) {
$parts = explode( '.', $str );
$file_extension = end( $parts );
if ( false !== strpos( $file_extension, '?' ) ) {
$file_extension = substr( $file_extension, 0, strpos( $file_extension, '?' ) );
}
return $file_extension;
}
/**
* Checks if the string (filename) provided is an image URL
*
* @since 1.0
* @param string $filename Filename
* @return bool Whether or not the filename is an image
*/
function edd_string_is_image_url( $filename ) {
$ext = edd_get_file_extension( $filename );
$images = array( 'jpg', 'jpeg', 'png', 'gif', 'webp' );
return (bool) apply_filters( 'edd_string_is_image', in_array( $ext, $images, true ), $filename );
}
/**
* Get User IP
*
* Returns the IP address of the current visitor
*
* @since 1.0.8.2
* @return string $ip User's IP address
*/
function edd_get_ip() {
$ip = false;
if ( ! empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
// Check ip from share internet.
$ip = filter_var( wp_unslash( $_SERVER['HTTP_CLIENT_IP'] ), FILTER_VALIDATE_IP );
} elseif ( ! empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
// To check ip is pass from proxy.
// Can include more than 1 ip, first is the public one.
// WPCS: sanitization ok.
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$ips = explode( ',', wp_unslash( $_SERVER['HTTP_X_FORWARDED_FOR'] ) );
if ( is_array( $ips ) ) {
$ip = filter_var( $ips[0], FILTER_VALIDATE_IP );
}
} elseif ( ! empty( $_SERVER['REMOTE_ADDR'] ) ) {
$ip = filter_var( wp_unslash( $_SERVER['REMOTE_ADDR'] ), FILTER_VALIDATE_IP );
}
$ip = false !== $ip ? $ip : '127.0.0.1';
// Fix potential CSV returned from $_SERVER variables.
$ip_array = explode( ',', $ip );
$ip_array = array_map( 'trim', $ip_array );
return apply_filters( 'edd_get_ip', $ip_array[0] );
}
/**
* Get user host
*
* Returns the webhost this site is using if possible
*
* @since 2.0
* @return mixed string $host if detected, false otherwise
*/
function edd_get_host() {
$host = false;
if( defined( 'WPE_APIKEY' ) ) {
$host = 'WP Engine';
} elseif( defined( 'PAGELYBIN' ) ) {
$host = 'Pagely';
} elseif( DB_HOST == 'localhost:/tmp/mysql5.sock' ) {
$host = 'ICDSoft';
} elseif( DB_HOST == 'mysqlv5' ) {
$host = 'NetworkSolutions';
} elseif( strpos( DB_HOST, 'ipagemysql.com' ) !== false ) {
$host = 'iPage';
} elseif( strpos( DB_HOST, 'ipowermysql.com' ) !== false ) {
$host = 'IPower';
} elseif( strpos( DB_HOST, '.gridserver.com' ) !== false ) {
$host = 'MediaTemple Grid';
} elseif( strpos( DB_HOST, '.pair.com' ) !== false ) {
$host = 'pair Networks';
} elseif( strpos( DB_HOST, '.stabletransit.com' ) !== false ) {
$host = 'Rackspace Cloud';
} elseif( strpos( DB_HOST, '.sysfix.eu' ) !== false ) {
$host = 'SysFix.eu Power Hosting';
} elseif( isset( $_SERVER['SERVER_NAME'] ) && strpos( sanitize_text_field( wp_unslash( $_SERVER['SERVER_NAME'] ) ), 'Flywheel' ) !== false ) {
$host = 'Flywheel';
} else {
// Adding a general fallback for data gathering.
if ( isset( $_SERVER['SERVER_NAME'] ) ) {
$server_name = sanitize_text_field( wp_unslash( $_SERVER['SERVER_NAME'] ) );
}
$host = 'DBH: ' . DB_HOST . ', SRV: ' . $server_name;
}
return $host;
}
/**
* Check site host
*
* @since 2.0
* @param $host The host to check
* @return bool true if host matches, false if not
*/
function edd_is_host( $host = false ) {
$return = false;
if( $host ) {
$host = str_replace( ' ', '', strtolower( $host ) );
switch( $host ) {
case 'wpengine':
if( defined( 'WPE_APIKEY' ) )
$return = true;
break;
case 'pagely':
if( defined( 'PAGELYBIN' ) )
$return = true;
break;
case 'icdsoft':
if( DB_HOST == 'localhost:/tmp/mysql5.sock' )
$return = true;
break;
case 'networksolutions':
if( DB_HOST == 'mysqlv5' )
$return = true;
break;
case 'ipage':
if( strpos( DB_HOST, 'ipagemysql.com' ) !== false )
$return = true;
break;
case 'ipower':
if( strpos( DB_HOST, 'ipowermysql.com' ) !== false )
$return = true;
break;
case 'mediatemplegrid':
if( strpos( DB_HOST, '.gridserver.com' ) !== false )
$return = true;
break;
case 'pairnetworks':
if( strpos( DB_HOST, '.pair.com' ) !== false )
$return = true;
break;
case 'rackspacecloud':
if( strpos( DB_HOST, '.stabletransit.com' ) !== false )
$return = true;
break;
case 'sysfix.eu':
case 'sysfix.eupowerhosting':
if( strpos( DB_HOST, '.sysfix.eu' ) !== false )
$return = true;
break;
case 'flywheel':
if ( isset( $_SERVER['SERVER_NAME'] ) && strpos( sanitize_text_field( wp_unslash( $_SERVER['SERVER_NAME'] ) ), 'Flywheel' ) !== false )
$return = true;
break;
default:
$return = false;
}
}
return $return;
}
/**
* Month Num To Name
*
* Takes a month number and returns the name three letter name of it.
*
* @since 1.0
*
* @param integer $n The number of the month.
* @param bool $return_long_name Optional. Return full name of month if true. Default false.
* @return string Short month name
*/
function edd_month_num_to_name( $n, $return_long_name = false ) {
$timestamp = mktime( 0, 0, 0, $n, 1, 2005 );
$date_format = $return_long_name ? 'F' : 'M';
return date_i18n( $date_format, $timestamp );
}
/**
* Get PHP Arg Separator Output
*
* @since 1.0.8.3
* @return string Arg separator output
*/
function edd_get_php_arg_separator_output() {
return ini_get( 'arg_separator.output' );
}
/**
* Get the current page URL
*
* @since 1.3
* @param bool $nocache If we should bust cache on the returned URL
* @return string $page_url Current page URL
*/
function edd_get_current_page_url( $nocache = false ) {
global $wp;
if( get_option( 'permalink_structure' ) ) {
$base = trailingslashit( home_url( $wp->request ) );
} else {
$base = add_query_arg( $wp->query_string, '', trailingslashit( home_url( $wp->request ) ) );
$base = remove_query_arg( array( 'post_type', 'name' ), $base );
}
$scheme = is_ssl() ? 'https' : 'http';
$uri = set_url_scheme( $base, $scheme );
if ( is_front_page() ) {
$uri = home_url( '/' );
} elseif ( edd_is_checkout() ) {
$uri = edd_get_checkout_uri();
}
$uri = apply_filters( 'edd_get_current_page_url', $uri );
if ( $nocache ) {
$uri = edd_add_cache_busting( $uri );
}
return $uri;
}
/**
* Adds the 'nocache' parameter to the provided URL
*
* @since 2.4.4
* @param string $url The URL being requested
* @return string The URL with cache busting added or not
*/
function edd_add_cache_busting( $url = '' ) {
$no_cache_checkout = edd_get_option( 'no_cache_checkout', false );
if ( edd_is_caching_plugin_active() || ( edd_is_checkout() && $no_cache_checkout ) ) {
$url = add_query_arg( 'nocache', 'true', $url );
}
return $url;
}
/**
* Marks a function as deprecated and informs when it has been used.
*
* There is a hook edd_deprecated_function_run that will be called that can be used
* to get the backtrace up to what file and function called the deprecated
* function.
*
* The current behavior is to trigger a user error if WP_DEBUG is true.
*
* This function is to be used in every function that is deprecated.
*
* @uses do_action() Calls 'edd_deprecated_function_run' and passes the function name, what to use instead,
* and the version the function was deprecated in.
* @uses apply_filters() Calls 'edd_deprecated_function_trigger_error' and expects boolean value of true to do
* trigger or false to not trigger error.
*
* @param string $function The function that was called
* @param string $version The version of Easy Digital Downloads that deprecated the function
* @param string $replacement Optional. The function that should have been called
* @param array $backtrace Optional. Contains stack backtrace of deprecated function
*/
function _edd_deprecated_function( $function, $version, $replacement = null, $backtrace = null ) {
do_action( 'edd_deprecated_function_run', $function, $replacement, $version );
$show_errors = current_user_can( 'manage_options' );
// Allow plugin to filter the output error trigger
if ( WP_DEBUG && apply_filters( 'edd_deprecated_function_trigger_error', $show_errors ) ) {
if ( ! is_null( $replacement ) ) {
trigger_error( sprintf( __( '%1$s is deprecated since Easy Digital Downloads version %2$s! Use %3$s instead.', 'easy-digital-downloads' ), $function, $version, $replacement ) );
if ( ! empty( $backtrace ) ) {
trigger_error( print_r( $backtrace, 1 ) ); // Limited to previous 1028 characters, but since we only need to move back 1 in stack that should be fine.
}
// Alternatively we could dump this to a file.
} else {
trigger_error( sprintf( __( '%1$s is deprecated since Easy Digital Downloads version %2$s with no alternative available.', 'easy-digital-downloads' ), $function, $version ) );
if ( ! empty( $backtrace ) ) {
trigger_error( print_r( $backtrace, 1 ) );// Limited to previous 1028 characters, but since we only need to move back 1 in stack that should be fine.
}
// Alternatively we could dump this to a file.
}
}
}
/**
* Marks an argument in a function deprecated and informs when it's been used
*
* There is a hook edd_deprecated_argument_run that will be called that can be used
* to get the backtrace up to what file and function called the deprecated
* function.
*
* The current behavior is to trigger a user error if WP_DEBUG is true.
*
* This function is to be used in every function that has an argument being deprecated.
*
* @uses do_action() Calls 'edd_deprecated_argument_run' and passes the argument, function name, what to use instead,
* and the version the function was deprecated in.
* @uses apply_filters() Calls 'edd_deprecated_argument_trigger_error' and expects boolean value of true to do
* trigger or false to not trigger error.
*
* @param string $argument The arguemnt that is being deprecated
* @param string $function The function that was called
* @param string $version The version of WordPress that deprecated the function
* @param string $replacement Optional. The function that should have been called
* @param array $backtrace Optional. Contains stack backtrace of deprecated function
*/
function _edd_deprected_argument( $argument, $function, $version, $replacement = null, $backtrace = null ) {
do_action( 'edd_deprecated_argument_run', $argument, $function, $replacement, $version );
$show_errors = current_user_can( 'manage_options' );
// Allow plugin to filter the output error trigger
if ( WP_DEBUG && apply_filters( 'edd_deprecated_argument_trigger_error', $show_errors ) ) {
if ( ! is_null( $replacement ) ) {
trigger_error( sprintf( __( 'The %1$s argument of %2$s is deprecated since Easy Digital Downloads version %3$s! Please use %4$s instead.', 'easy-digital-downloads' ), $argument, $function, $version, $replacement ) );
if ( ! empty( $backtrace ) ) {
trigger_error( print_r( $backtrace, 1 ) ); // Limited to previous 1028 characters, but since we only need to move back 1 in stack that should be fine.
}
// Alternatively we could dump this to a file.
} else {
trigger_error( sprintf( __( 'The %1$s argument of %2$s is deprecated since Easy Digital Downloads version %3$s with no alternative available.', 'easy-digital-downloads' ), $argument, $function, $version ) );
if ( ! empty( $backtrace ) ) {
trigger_error( print_r( $backtrace, 1 ) );// Limited to previous 1028 characters, but since we only need to move back 1 in stack that should be fine.
}
// Alternatively we could dump this to a file.
}
}
}
/**
* Marks an argument in a function deprecated and informs when it's been used
*
* There is a hook edd_deprecated_argument_run that will be called that can be used
* to get the backtrace up to what file and function called the deprecated
* function.
*
* The current behavior is to trigger a user error if WP_DEBUG is true.
*
* This function is to be used in every function that has an argument being deprecated.
*
* @uses do_action() Calls 'edd_deprecated_argument_run' and passes the argument, function name, what to use instead,
* and the version the function was deprecated in.
* @uses apply_filters() Calls 'edd_deprecated_argument_trigger_error' and expects boolean value of true to do
* trigger or false to not trigger error.
*
* @param string $file The file that was included.
* @param string $version The version of EDD that deprecated the file.
* @param string $replacement Optional. The file that should have been included based on EDD_PLUGIN_DIR.
* Default null.
* @param string $message Optional. A message regarding the change. Default empty.
*/
function _edd_deprecated_file( $file, $version, $replacement = null, $message = '' ) {
/**
* Fires immediately before a deprecated file notice is output.
*
* @since 3.0
*
* @param string $file The file that was included.
* @param string $replacement The file that should have been included based on EDD_PLUGIN_DIR.
* @param string $version The version of EDD that deprecated the file.
*/
do_action( 'edd_deprecated_file_run', $file, $replacement, $version );
$show_errors = current_user_can( 'manage_options' );
/**
* Filters whether to trigger the error output for deprecated EDD files.
*
* @since 3.0
*
* @param bool $show_errors Whether to trigger errors for deprecated files.
*/
if ( WP_DEBUG && apply_filters( 'edd_deprecated_file_trigger_error', $show_errors ) ) {
$message = empty( $message ) ? '' : ' ' . $message;
if ( ! is_null( $replacement ) ) {
/* translators: 1: PHP file name, 2: EDD version number, 3: alternative file name */
trigger_error( sprintf( __( '%1$s is deprecated since Easy Digital Downloads version %2$s! Use %3$s instead.', 'easy-digital-downloads' ), $file, $version, $replacement ) . $message );
} else {
/* translators: 1: PHP file name, 2: EDD version number */
trigger_error( sprintf( __( '%1$s is deprecated since Easy Digital Downloads version %2$s with no alternative available.', 'easy-digital-downloads' ), $file, $version ) . $message );
}
}
}
function _edd_generic_deprecated( $function, $version, $message ) {
/**
* Fires immediately before a generic deprecated notice is output.
*
* @since 3.0
*
* @param string function The function that the deprecation is happening in.
* @param string $version The version of EDD that deprecated the code..
* @param string $message The message to supply for the deprecation.
*/
do_action( 'edd_generic_deprecated', $function, $version, $message );
$show_errors = current_user_can( 'manage_options' );
/**
* Filters whether to trigger the error output for the deprecation.
*
* @since 3.0
*
* @param bool $show_errors Whether to trigger errors for deprecated calls..
*/
if ( WP_DEBUG && apply_filters( 'edd_generic_deprecated_trigger_error', $show_errors ) ) {
$message = empty( $message ) ? '' : ' ' . $message;
/* translators: 1: PHP file name, 2: EDD version number */
trigger_error( sprintf( __( 'Code within %1$s is deprecated since Easy Digital Downloads version %2$s. See message for further details.', 'easy-digital-downloads' ), $function, $version ) . $message );
}
}
/**
* Fires functions attached to a deprecated EDD filter hook.
*
* When a filter hook is deprecated, the apply_filters() call is replaced with
* edd_apply_filters_deprecated(), which triggers a deprecation notice and then fires
* the original filter hook.
*
* @param string $tag The name of the filter hook.
* @param array $args Array of additional function arguments to be passed to apply_filters().
* @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used. Default false.
* @param string $message Optional. A message regarding the change. Default null.
* @return
*/
function edd_apply_filters_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
if ( ! has_filter( $tag ) ) {
return $args[0];
}
_edd_deprecated_hook( $tag, $version, $replacement, $message );
return apply_filters_ref_array( $tag, $args );
}
/**
* Fires functions attached to a deprecated EDD action hook.
*
* When an action hook is deprecated, the do_action() call is replaced with
* edd_do_action_deprecated(), which triggers a deprecation notice and then fires
* the original hook.
*
* @param string $tag The name of the action hook.
* @param array $args Array of additional function arguments to be passed to do_action().
* @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used.
* @param string $message Optional. A message regarding the change.
*/
function edd_do_action_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
if ( ! has_action( $tag ) ) {
return;
}
_edd_deprecated_hook( $tag, $version, $replacement, $message );
do_action_ref_array( $tag, $args );
}
/**
* Marks a deprecated EDD action or filter hook as deprecated and throws a notice.
*
* Use the {@see 'edd_deprecated_hook_run'} action to get the backtrace describing where
* the deprecated hook was called.
*
* Default behavior is to trigger a user error if `WP_DEBUG` is true.
*
* This function is called by the edd_do_action_deprecated() and edd_apply_filters_deprecated()
* functions, and so generally does not need to be called directly.
*
* @since 3.0
*
* @param string $hook The hook that was used.
* @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used.
* @param string $message Optional. A message regarding the change.
*/
function _edd_deprecated_hook( $hook, $version, $replacement = null, $message = null ) {
/**
* Fires when a deprecated EDD hook is called.
*
* @since 3.0
*
* @param string $hook The hook that was called.
* @param string $replacement The hook that should be used as a replacement.
* @param string $version The version of WordPress that deprecated the argument used.
* @param string $message A message regarding the change.
*/
do_action( 'edd_deprecated_hook_run', $hook, $replacement, $version, $message );
$show_errors = current_user_can( 'manage_options' );
/**
* Filters whether to trigger deprecated EDD hook errors.
*
* @since 3.0
*
* @param bool $trigger Whether to trigger deprecated hook errors. Requires
* `WP_DEBUG` to be defined true.
*/
if ( WP_DEBUG && apply_filters( 'edd_deprecated_hook_trigger_error', $show_errors ) ) {
$message = empty( $message ) ? '' : ' ' . $message;
if ( ! is_null( $replacement ) ) {
/* translators: 1: PHP file name, 2: EDD version number, 3: alternative hook name */
trigger_error( sprintf( __( 'The %1$s hook is deprecated since Easy Digital Downloads version %2$s! Use the %3$s hook instead.', 'easy-digital-downloads' ), $hook, $version, $replacement ) . $message );
} else {
/* translators: 1: PHP file name, 2: EDD version number */
trigger_error( sprintf( __( 'The %1$s hook is deprecated since Easy Digital Downloads version %2$s with no alternative available.', 'easy-digital-downloads' ), $hook, $version ) . $message );
}
}
}
/**
* EDD Let To Num
*
* Does Size Conversions
*
* @since 1.4
* @usedby edd_settings()
* @author Chris Christoff
*
* @param unknown $v
* @return int
*/
function edd_let_to_num( $v ) {
$l = substr( $v, -1 );
$ret = substr( $v, 0, -1 );
switch ( strtoupper( $l ) ) {
case 'P': // fall-through
case 'T': // fall-through
case 'G': // fall-through
case 'M': // fall-through
case 'K': // fall-through
$ret *= 1024;
break;
default:
break;
}
return (int) $ret;
}
/**
* Return the name of base uploads directory.
*
* @since 3.0
*
* @return string
*/
function edd_get_uploads_base_dir() {
return 'edd'; // No filter, for now
}
/**
* Retrieve the URL of the symlink directory
*
* @since 1.5
* @return string $url URL of the symlink directory
*/
function edd_get_symlink_url() {
// Make sure the symlink directory exists
edd_get_symlink_dir();
// Get the URL
$wp_upload_dir = wp_upload_dir();
$edd_dir = edd_get_uploads_base_dir();
$path = '/' . $edd_dir . '/symlinks';
$url = $wp_upload_dir['baseurl'] . $path;
// Filter & return
return apply_filters( 'edd_get_symlink_url', $url );
}
/**
* Retrieve the absolute path to the symlink directory
*
* @since 1.5
* @return string $path Absolute path to the symlink directory
*/
function edd_get_symlink_dir() {
$wp_upload_dir = wp_upload_dir();
$edd_dir = edd_get_uploads_base_dir();
$path = $wp_upload_dir['basedir'] . '/' . $edd_dir . '/symlinks';
$retval = apply_filters( 'edd_get_symlink_dir', $path );
// Make sure the directory exists
wp_mkdir_p( $retval );
// Return, possibly filtered
return $retval;
}
/**
* Retrieve the absolute path to the file upload directory without the trailing slash
*
* @since 1.8
* @return string $path Absolute path to the EDD upload directory
*/
function edd_get_upload_dir() {
$wp_upload_dir = wp_upload_dir();
$edd_dir = edd_get_uploads_base_dir();
$path = $wp_upload_dir['basedir'] . '/' . $edd_dir;
$retval = apply_filters( 'edd_get_upload_dir', $path );
// Make sure the directory exists
wp_mkdir_p( $retval );
// Return, possibly filtered
return $retval;
}
/**
* Retrieve the URL to the file upload directory without the trailing slash
*
* @since 3.0
* @return string $purl URL to the EDD upload directory
*/
function edd_get_upload_url() {
// Make sure the symlink directory exists
edd_get_upload_dir();
// Get the URL
$wp_upload_dir = wp_upload_dir();
$edd_dir = edd_get_uploads_base_dir();
$url = $wp_upload_dir['baseurl'] . '/' . $edd_dir;
return apply_filters( 'edd_get_upload_url', $url );
}
/**
* Determine if the uploads directory is protected, and not publicly accessible.
*
* @since 3.0
*
* @return bool True if URL returns 200, False if anything else
*/
function edd_is_uploads_url_protected() {
$transient_key = 'edd_is_uploads_url_protected';
$protected = get_transient( $transient_key );
// No transient
if ( false === $protected ) {
// Get the upload path
$upload_path = edd_get_upload_dir();
// The upload path is writeable
if ( wp_is_writable( $upload_path ) ) {
// Get the file path
$file_name = wp_unique_filename( $upload_path, 'edd-temp.zip' );
$file_path = trailingslashit( $upload_path ) . $file_name;
// Save a temporary file - we will try to access it
if ( ! file_exists( $file_path ) ) {
@file_put_contents( $file_path, 'Just testing!' );
}
// Setup vars for request
$upload_url = edd_get_upload_url() . '/' . $file_name;
$url = esc_url_raw( $upload_url );
$args = array(
'sslverify' => false,
'timeout' => 2,
'redirection' => 0
);
// Send the request
$response = wp_remote_get( $url, $args );
$code = wp_remote_retrieve_response_code( $response );
$protected = (int) ( 200 !== (int) $code );
// Delete the temporary file
if ( file_exists( $file_path ) ) {
@unlink( $file_path );
}
}
// Set the transient
set_transient( $transient_key, $protected, 12 * HOUR_IN_SECONDS );
}
/**
* Filter whether the uploads directory is public or not.
*
* @since 3.0
*
* @param string $protected Response code from remote get request
*/
return (bool) apply_filters( 'edd_is_uploads_url_protected', $protected );
}
/**
* Delete symbolic links after they have been used
*
* This function is only intended to be used by WordPress cron.
*
* @since 1.5
* @return void
*/
function edd_cleanup_file_symlinks() {
// Bail if not in WordPress cron
if ( ! edd_doing_cron() ) {
return;
}
$path = edd_get_symlink_dir();
$dir = opendir( $path );
while ( ( $file = readdir( $dir ) ) !== false ) {
if ( $file == '.' || $file == '..' ) {
continue;
}
$transient = get_transient( md5( $file ) );
if ( $transient === false ) {
@unlink( $path . '/' . $file );
}
}
}
add_action( 'edd_cleanup_file_symlinks', 'edd_cleanup_file_symlinks' );
/**
* Checks if SKUs are enabled
*
* @since 1.6
* @author Daniel J Griffiths
* @return bool $ret True if SKUs are enabled, false otherwise
*/
function edd_use_skus() {
$ret = edd_get_option( 'enable_skus', false );
return (bool) apply_filters( 'edd_use_skus', $ret );
}
/**
* Given an object or array of objects, convert them to arrays
*
* @since 1.7
* @internal Updated in 2.6
* @param object|array $object An object or an array of objects
* @return array An array or array of arrays, converted from the provided object(s)
*/
function edd_object_to_array( $object = array() ) {
if ( empty( $object ) || ( ! is_object( $object ) && ! is_array( $object ) ) ) {
return $object;
}
if ( is_array( $object ) ) {
$return = array();
foreach ( $object as $item ) {
if ( $object instanceof EDD_Payment ) {
$return[] = $object->array_convert();
} else {
$return[] = edd_object_to_array( $item );
}
}
} else {
if ( $object instanceof EDD_Payment ) {
$return = $object->array_convert();
} else {
$return = get_object_vars( $object );
// Now look at the items that came back and convert any nested objects to arrays
foreach ( $return as $key => $value ) {
$value = ( is_array( $value ) || is_object( $value ) ) ? edd_object_to_array( $value ) : $value;
$return[ $key ] = $value;
}
}
}
return $return;
}
/**
* Set Upload Directory
*
* Sets the upload dir to edd. This function is called from
* edd_change_downloads_upload_dir()
*
* @since 1.0
* @return array Upload directory information
*/
function edd_set_upload_dir( $upload ) {
// Override the year / month being based on the post publication date, if year/month organization is enabled
if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
// Generate the yearly and monthly dirs
$time = current_time( 'mysql' );
$y = substr( $time, 0, 4 );
$m = substr( $time, 5, 2 );
$upload['subdir'] = "/$y/$m";
}
$edd_dir = edd_get_uploads_base_dir();
$upload['subdir'] = '/' . $edd_dir . $upload['subdir'];
$upload['path'] = $upload['basedir'] . $upload['subdir'];
$upload['url'] = $upload['baseurl'] . $upload['subdir'];
return $upload;
}
/**
* Determines the receipt visibility status
*
* @param string $payment_key The payment key.
* @return bool Whether the receipt is visible or not.
*/
function edd_can_view_receipt( $payment_key = '' ) {
$user_can_view = false;
if ( empty( $payment_key ) ) {
return $user_can_view;
}
global $edd_receipt_args;
$order = edd_get_order_by( 'payment_key', $payment_key );
if ( empty( $order->id ) ) {
return $user_can_view;
}
$edd_receipt_args['id'] = $order->id;
// Some capabilities can always view the receipt, skip the filter.
if ( current_user_can( 'edit_shop_payments' ) ) {
return true;
}
if ( is_user_logged_in() ) {
if ( (int) get_current_user_id() === (int) $order->user_id ) {
$user_can_view = true;
} elseif ( wp_get_current_user()->user_email === $order->email ) {
$user_can_view = true;
} elseif ( current_user_can( 'view_shop_sensitive_data' ) ) {
$user_can_view = true;
}
} else {
$session = edd_get_purchase_session();
if ( ! empty( $session ) ) {
if ( $session['purchase_key'] === $order->payment_key ) {
$user_can_view = true;
}
}
}
return (bool) apply_filters( 'edd_can_view_receipt', $user_can_view, $payment_key );
}
/**
* Given an order ID, generate a link to IP address provider (ipinfo.io)
*
* @since 2.8.15
* @since 3.0 Updated to use EDD\Orders\Order.
*
* @param int $order_id Order ID.
* @return string A link to the IP details provider
*/
function edd_payment_get_ip_address_url( $order_id ) {
$order = edd_get_order( $order_id );
$base_url = 'https://ipinfo.io/';
$provider_url = '' . esc_attr( $order->ip ) . '';
return apply_filters( 'edd_payment_get_ip_address_url', $provider_url, $order->ip, $order->id );
}
/**
* Abstraction for WordPress cron checking, to avoid code duplication.
*
* In future versions of EDD, this function will be changed to only refer to
* EDD specific cron related jobs. You probably won't want to use it until then.
*
* @since 2.8.16
*
* @return boolean
*/
function edd_doing_cron() {
// Bail if doing WordPress cron.
if ( wp_doing_cron() ) {
return true;
}
// Default to false
return false;
}
/**
* Abstraction for WordPress AJAX checking, to avoid code duplication.
*
* In future versions of EDD, this function will be changed to only refer to
* EDD specific AJAX related requests. You probably won't want to use it until then.
*
* @since 3.0
*
* @return boolean
*/
function edd_doing_ajax() {
// Bail if doing WordPress AJAX.
if ( wp_doing_ajax() ) {
return true;
}
// Default to false
return false;
}
/**
* Abstraction for WordPress autosave checking, to avoid code duplication.
*
* In future versions of EDD, this function will be changed to only refer to
* EDD specific autosave related requests. You probably won't want to use it until then.
*
* @since 3.0
*
* @return boolean
*/
function edd_doing_autosave() {
// Bail if doing WordPress autosave.
if ( defined( 'DOING_AUTOSAVE' ) && ( true === DOING_AUTOSAVE ) ) {
return true;
}
// Default to false
return false;
}
/**
* Abstraction for WordPress Script-Debug checking to avoid code duplication.
*
* @since 3.0
*
* @return boolean
*/
function edd_doing_script_debug() {
return defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
}
/**
* Get the bot name. Usually "Store Bot" unless filtered.
*
* @since 3.0
*
* @return string
*/
function edd_get_bot_name() {
$retval = esc_html__( 'Store Bot', 'easy-digital-downloads' );
return (string) apply_filters( 'edd_get_bot_name', $retval );
}
/**
* Perform a safe, local redirect somewhere inside the current site.
*
* On some setups, passing the value of wp_get_referer() may result in an empty
* value for $location, which results in an error on redirection. If $location
* is empty, we can safely redirect back to the root. This might change
* in a future version, possibly to the site root.
*
* @since 3.0
*
* @param string $location The URL to redirect the user to.
* @param int $status Optional. The numeric code to give in the redirect
* headers. Default: 302.
*/
function edd_redirect( $location = '', $status = 302 ) {
// Prevent redirects in unit tests.
if ( (bool) ( defined( 'WP_TESTS_DIR' ) && WP_TESTS_DIR ) || function_exists( '_manually_load_plugin' ) ) {
return;
}
// Prevent errors from empty $location.
if ( empty( $location ) ) {
$location = is_admin()
? admin_url()
: home_url();
}
// Setup the safe redirect.
wp_safe_redirect( esc_url_raw( $location ), $status );
// Exit so the redirect takes place immediately.
edd_die();
}
/**
* Checks whether function is disabled.
*
* @since 1.3.5
* @since 3.0.0 String type-checking the `in_array()` call
*
* @param string $function Name of the function.
* @return bool Whether or not function is disabled.
*/
function edd_is_func_disabled( $function ) {
$disabled = explode( ',', @ini_get( 'disable_functions' ) );
return in_array( $function, $disabled, true );
}
/**
* Ignore the time limit set by the server (likely from php.ini.)
*
* This is usually only necessary during upgrades and exports. If you need to
* use this function directly, please be careful in doing so.
*
* The $time_limit parameter is filterable, but infinite values are not allowed
* so any erroneous processes are able to terminate normally.
*
* @since 3.0.0
*
* @param boolean $ignore_user_abort Whether to call ignore_user_about( true )
* @param int $time_limit How long to set the time limit to. Cannot be 0. Default 6 hours.
*/
function edd_set_time_limit( $ignore_user_abort = true, $time_limit = 21600 ) {
// Default time limit is 6 hours
$default = HOUR_IN_SECONDS * 6;
// Only abort if true and if function is enabled
if ( ( true === $ignore_user_abort ) && ! edd_is_func_disabled( 'ignore_user_abort' ) ) {
@ignore_user_abort( true );
}
/**
* Filter the time limit to set for this request.
*
* Infinite (0) values are not allowed so any erroneous processes are able
* to terminate normally.
*
* @since 3.0
*
* @param int $time_limit The time limit in nano-seconds. Default 6 hours.
*
* @returns int $time_limit The filtered time limit value. Default 6 hours.
*/
$time_limit = (int) apply_filters( 'edd_set_time_limit', $time_limit );
// Disallow infinite values
if ( empty( $time_limit ) ) {
$time_limit = $default;
}
// Set time limit to non-infinite value if function is enabled
if ( ! edd_is_func_disabled( 'set_time_limit' ) ) {
@set_time_limit( $time_limit );
}
// Attempt to raise the memory limit. See: edd_set_batch_memory_limit()
wp_raise_memory_limit( 'edd_batch' );
}
/**
* Set the memory limit for batch processing to 256M
*
* @since 3.0
*
* @param string $memory_limit 128M by default
*
* @return string 256M
*/
function edd_set_batch_memory_limit( $memory_limit = '128M' ) {
$memory_limit = '256M';
return $memory_limit;
}
add_filter( 'edd_batch_memory_limit', 'edd_set_batch_memory_limit' );
/**
* Output the admin area filter bar
*
* @since 3.0
*
* @param string $context
*/
function edd_admin_filter_bar( $context = '', $item = null ) {
?>
__( 'Active', 'easy-digital-downloads' ),
'inactive' => __( 'Inactive', 'easy-digital-downloads' ),
'expired' => __( 'Expired', 'easy-digital-downloads' ),
// Common
'pending' => __( 'Pending', 'easy-digital-downloads' ),
'verified' => __( 'Verified', 'easy-digital-downloads' ),
'spam' => __( 'Spam', 'easy-digital-downloads' ),
'deleted' => __( 'Deleted', 'easy-digital-downloads' ),
'cancelled' => __( 'Cancelled', 'easy-digital-downloads' ),
);
// Return the label if set, or uppercase the first letter if not
if ( isset( $labels[ $status ] ) ) {
$status_label = $labels[ $status ];
}
}
/**
* Filters the label for the provided status.
*
* @since 3.0
*
* @param string $status_label Status label.
* @param string $status Provided status key.
*/
return apply_filters( 'edd_get_status_label', $status_label, $status );
}
/**
* Format an array of count objects, using the $groupby key.
*
* @since 3.0
*
* @param EDD\Database\Query $counts
* @param string $groupby
* @return array
*/
function edd_format_counts( $counts = array(), $groupby = '' ) {
// Default array
$c = array(
'total' => 0
);
// Loop through counts and shape return value
if ( ! empty( $counts->items ) ) {
// Loop through statuses
foreach ( $counts->items as $count ) {
$c[ $count[ $groupby ] ] = absint( $count['count'] );
// We don't want to include trashed orders in the counts.
if ( ! isset( $count['status'] ) || 'trash' !== $count['status'] ) {
$c['total'] += $count['count'];
}
}
}
// Return array of counts
return $c;
}
/**
* Get all payment icon dimensions.
*
* This is used because as of EDD 3.0, payment icons are SVGs with specific
* (and sometimes different) widths and heights.
*
* @since 3.0
*
* @return array $sizes Sizes array (width and height) of the icon requested.
*/
function edd_get_payment_icon_dimensions( $icon = '' ) {
// Bail if icon is empty
if ( empty( $icon ) ) {
return false;
}
// Filter the SVG dimensions
$sizes = apply_filters( 'edd_get_payment_icon_dimensions', array(
'mastercard' => array(
'width' => 50,
'height' => 32
),
'americanexpress' => array(
'width' => 32,
'height' => 32
),
'visa' => array(
'width' => 50,
'height' => 32
),
'discover' => array(
'width' => 50,
'height' => 32
),
'paypal' => array(
'width' => 50,
'height' => 32
),
'amazon' => array(
'width' => 50,
'height' => 32
),
) );
return isset( $sizes[ $icon ] )
? $sizes[ $icon ]
: false;
}
/**
* Return a payment icon
*
* @since 3.0
*
* @return string SVG markup.
*/
function edd_get_payment_icon( $args = array() ) {
// Bail if no arguments
if ( empty( $args ) ) {
return __( 'Please define default parameters in the form of an array.', 'easy-digital-downloads' );
}
// Bail if no icon
if ( false === array_key_exists( 'icon', $args ) ) {
return __( 'Please define an SVG icon filename.', 'easy-digital-downloads' );
}
// Parse args.
$args = wp_parse_args( $args, array(
'icon' => '',
'title' => '',
'desc' => '',
'fallback' => false,
'width' => '',
'height' => '',
'classes' => array()
) );
$args['classes'][] = 'icon-' . esc_attr( $args['icon'] );
// Set aria hidden.
$aria_hidden = ' aria-hidden="true"';
// Set ARIA.
$aria_labelledby = '';
// Setup the unique ID
$unique_id = uniqid();
if ( $args['title'] ) {
$aria_hidden = '';
$aria_labelledby = ' aria-labelledby="title-' . $unique_id . '"';
if ( $args['desc'] ) {
$aria_labelledby = ' aria-labelledby="title-' . $unique_id . ' desc-' . $unique_id . '"';
}
}
// Set width and height.
$width = ! empty( $args['width'] ) ? ' width="' . esc_attr( $args['width'] ) . '"' : '';
$height = ! empty( $args['height'] ) ? ' height="' . esc_attr( $args['height'] ) . '"' : '';
// Begin SVG markup.
$svg = '';
// Display the title.
if ( $args['title'] ) {
$svg .= '' . esc_html( $args['title'] ) . '';
// Display the desc only if the title is already set.
if ( $args['desc'] ) {
$svg .= '' . esc_html( $args['desc'] ) . '';
}
}
/*
* Display the icon.
*
* The whitespace around `