Provided by Lee Peterson
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
/** * Return a variable (if exists) * * @param mixed $var The variable name, can also be a modifier for specific types * @param string|array|object $type (optional) Super globals, url/url-relative, constants, globals, options, transients, cache, user data, Pod field values, dates * * 'get' // $output = pods_unslash( $_GET[ $var ] ) * 'post' // $output = pods_unslash( $_POST[ $var ] ) * 'request' // $output = pods_unslash( $_REQUEST[ $var ] ) * 'url' // // 'first' // 'last' // is_numeric( $var ) * 'uri' ^^^ * 'url-relative' ^^^ * 'template-url' // get_template_directory_uri() * 'stylesheet-url' // get_stylesheet_directory_uri() * 'site-url' // get_site_url( $blog_id, $path, $scheme ) * 'home-url' // get_home_url( $blog_id, $path, $scheme ) * 'admin-url' // get_admin_url( $blog_id, $path, $scheme ) * 'includes-url' // includes_url( $var ) * 'content-url' // content_url( $var ) * 'plugins-url' // plugins_url( $path, $plugin ) * 'network-site-url' // network_site_url( $path, $scheme ) * 'network-home-url' // network_home_url( $path, $scheme ) * 'network-admin-url' // network_admin_url( $path, $scheme ) * 'user-admin-url' // user_admin_url( $path, $scheme ) * 'prefix' // $wpdb->prefix * 'server' // $_SERVER[ $var ] * 'session' // $_SESSION[ $var ] * 'global' // $GLOBALS[ $var ] * 'globals' ^^^ * 'cookie' // $_COOKIE[ $var ] * 'constant' // $output = constant( $var ) * 'user' // get_userdata( get_current_user_id() ) // $value = get_user_meta( $user->ID, $var ) * 'option' // get_option( $var, $default ) * 'site-option' // get_site_option( $var, $default ) * 'transient' // get_transient( $var ) * 'site-transient' // get_site_transient( $var ) * 'cache' // $GLOBALS[ 'wp_object_cache' ] // $output = wp_cache_get( $var, $group, $force ) * 'pods-transient' // $output = pods_transient_get( $var, $callback ) * 'pods-site-transient' // $output = pods_site_transient_get( $var, $callback ) * 'pods-cache' // $GLOBALS[ 'wp_object_cache' ] // $output = pods_cache_get( $var, $group, $callback ) * 'pods-option-cache' // $output = pods_option_cache_get( $var, $group, $callback ) * 'date' // $output = date_i18n( $var[ 0 ], ( isset( $var[ 1 ] ) ? strtotime( $var[ 1 ] ) : false ) ); * 'pods' // global $pods; if ( 'pods' === $type ) // $options = array( // 'field' => $var, // 'fields' => $pods->fields // $output = pods_serial_comma( $output, $options ); elseif ( 'pods_display' === $type ) // $output = $pods->display( $var ); * 'pods_display' ^^^ * 'post_id' // $post_id = get_the_ID(); * * @param mixed $default (optional) The default value to set if variable doesn't exist * @param bool $strict (optional) Only allow values (must not be empty) * @param array $params (optional) Set 'casting'=>true to cast value from $default, 'allowed'=>$allowed to restrict a value to what's allowed * * @return mixed The variable (if exists), or default value * @since 2.3.10 */ $var = pods_v( $var = null, $type = 'get', $default = null, $strict = false, $params = array() ); |