vsprintf - PHP code example

The php Function Vsprintf

The php function vsprintf is a special string formatting function that can replace a variety of different variable placeholders within a single string, while also providing many options for formatting the final result. It’s a much more powerful way to format strings than simply using the printf function, but it does come with a bit of an overhead in processing time.

The vsprintf function takes one argument as a format string, which is the first step in its process. This format string contains special symbols that are used to specify how each individual argument should be printed. For example, a % character indicates the beginning of a conversion specification, and each subsequent % symbol is followed by a letter that determines what type of value should be inserted into the string (%s for string values, %d for integer values, or %f for floating-point values).

After the format string, you can insert as many additional variables as you want. Each of these variables is inserted at the corresponding % symbol in the format string, and their corresponding values are then written to an array. The array is then appended to the string that will be printed.

vsprintf() can accept any number of variables as arguments, but the most important parameter is the format string. This is the string template that vsprintf will use to format each of the variables passed in after it. It’s important to note that if the number of variables exceeds the width of the field, vsprintf will throw a ValueError.

vsprintf example

case self::COLOR_RGB:
                if (1.0 === $this->a) {
                    return \sprintf('rgb(%d, %d, %d)', $this->r, $this->g, $this->b);
                }

                return \sprintf('rgb(%d, %d, %d, %s)', $this->r, $this->g, $this->b, \round($this->a, 4));
            case self::COLOR_RGBA:
                return \sprintf('rgba(%d, %d, %d, %s)', $this->r, $this->g, $this->b, \round($this->a, 4));
            case self::COLOR_HSL:
                $val = self::rgbToHsl($this->r, $this->g, $this->b);
                if (1.0 === $this->a) {
                    return \vsprintf('hsl(%d, %d%%, %d%%)', $val);
                }

                return \sprintf('hsl(%d, %d%%, %d%%, %s)', $val[0], $val[1], $val[2], \round($this->a, 4));
            case self::COLOR_HSLA:
                $val = self::rgbToHsl($this->r, $this->g, $this->b);

                return \sprintf('hsla(%d, %d%%, %d%%, %s)', $val[0], $val[1], $val[2], \round($this->a, 4));
            case self::COLOR_HEX_4:
                if (0 === $this->r % 0x11 && 0 === $this->g % 0x11 && 0 === $this->b % 0x11 && 0 === ((int) ($this->a * 255)) % 0x11) {
                    return \sprintf(
                        '#%1X%1X%1X%1X',

function wp_credits_section_title( $group_data = array() ) {
    if ( ! count( $group_data ) ) {
        return;
    }

    if ( $group_data['name'] ) {
        if ( 'Translators' === $group_data['name'] ) {
            // Considered a special slug in the API response. (Also, will never be returned for en_US.)             $title = _x( 'Translators', 'Translate this to be the equivalent of English Translators in your language for the credits page Translators section' );
        } elseif ( isset( $group_data['placeholders'] ) ) {
            // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText             $title = vsprintf( translate( $group_data['name'] ), $group_data['placeholders'] );
        } else {
            // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText             $title = translate( $group_data['name'] );
        }

        echo '<h2 class="wp-people-group-title">' . esc_html( $title ) . "</h2>\n";
    }
}

/** * Displays a list of contributors for a given group. * * @since 5.3.0 * * @param array $credits The credits groups returned from the API. * @param string $slug The current group to display. */

    function trigger_deprecation(string $package, string $version, string $message, mixed ...$args): void
    {
        @trigger_error(($package || $version ? "Since $package $version: " : '').($args ? vsprintf($message, $args) : $message), \E_USER_DEPRECATED);
    }
}

function get_custom_header() {
    global $_wp_default_headers;

    if ( is_random_header_image() ) {
        $data = _get_random_header_data();
    } else {
        $data = get_theme_mod( 'header_image_data' );
        if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) {
            $directory_args        = array( get_template_directory_uri(), get_stylesheet_directory_uri() );
            $data                  = array();
            $data['url']           = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args );
            $data['thumbnail_url'] = $data['url'];
            if ( ! empty( $_wp_default_headers ) ) {
                foreach ( (array) $_wp_default_headers as $default_header ) {
                    $url = vsprintf( $default_header['url'], $directory_args );
                    if ( $data['url'] == $url ) {
                        $data                  = $default_header;
                        $data['url']           = $url;
                        $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
                        break;
                    }
                }
            }

      elseif ($param->getName() === 'priority') {
        $priority_pos = $pos;
      }
      else {
        $extra_params[$param->getName()] = $pos;
      }
    }
    // Determine the ID.
    if (!isset($interface)) {
      throw new LogicException(vsprintf("Service consumer '%s' class method %s::%s() has to type-hint an interface.", [
        $consumer_id,
        $consumer->getClass(),
        $method_name,
      ]));
    }

    // Find all tagged handlers.     $handlers = [];
    $extra_arguments = [];
    foreach ($this->tagCache[$tag] ?? [] as $id => $attributes) {
      // Validate the interface.

for ($j = 0; $j < 8; $j++) {
                        $ip[$j] = intval($ip[$j], 16);
                    }

                    $sprintf = '%016b%016b%016b%016b%016b%016b%016b%016b';
                } else {
                    $ip      = explode('.', $this->ipAddress);
                    $sprintf = '%08b%08b%08b%08b';
                }

                $ip = vsprintf($sprintf, $ip);
            }

            // Split the netmask length off the network address             sscanf($proxyIP, '%[^/]/%d', $netaddr, $masklen);

            // Again, an IPv6 address is most likely in a compressed form             if ($separator === ':') {
                $netaddr = explode(':', str_replace('::', str_repeat(':', 9 - substr_count($netaddr, ':')), $netaddr));

                for ($i = 0; $i < 8; $i++) {
                    $netaddr[$i] = intval($netaddr[$i], 16);
                }

return;
        } else {
            $string = $feedback;
        }

        if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
            $string = $this->upgrader->strings[ $string ];
        }

        if ( str_contains( $string, '%' ) ) {
            if ( ! empty( $args ) ) {
                $string = vsprintf( $string, $args );
            }
        }

        $string = trim( $string );

        // Only allow basic HTML in the messages, as it'll be used in emails/logs rather than direct browser output.         $string = wp_kses(
            $string,
            array(
                'a'      => array(
                    'href' => true,
                ),

    public function error( $errors, ...$args ) {
        if ( is_string( $errors ) ) {
            $string = $errors;
            if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
                $string = $this->upgrader->strings[ $string ];
            }

            if ( str_contains( $string, '%' ) ) {
                if ( ! empty( $args ) ) {
                    $string = vsprintf( $string, $args );
                }
            }

            // Count existing errors to generate a unique error code.             $errors_count = count( $this->errors->get_error_codes() );
            $this->errors->add( 'unknown_upgrade_error_' . ( $errors_count + 1 ), $string );
        } elseif ( is_wp_error( $errors ) ) {
            foreach ( $errors->get_error_codes() as $error_code ) {
                $this->errors->add( $error_code, $errors->get_error_message( $error_code ), $errors->get_error_data( $error_code ) );
            }
        }

    public function feedback( $feedback, ...$args ) {
        if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
            $feedback = $this->upgrader->strings[ $feedback ];
        }

        if ( str_contains( $feedback, '%' ) ) {
            if ( $args ) {
                $args     = array_map( 'strip_tags', $args );
                $args     = array_map( 'esc_html', $args );
                $feedback = vsprintf( $feedback, $args );
            }
        }
        if ( empty( $feedback ) ) {
            return;
        }
        if ( $this->in_loop ) {
            echo "$feedback<br />\n";
        } else {
            echo "<p>$feedback</p>\n";
        }
    }

    public function feedback( $feedback, ...$args ) {
        if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
            $feedback = $this->upgrader->strings[ $feedback ];
        }

        if ( str_contains( $feedback, '%' ) ) {
            if ( $args ) {
                $args     = array_map( 'strip_tags', $args );
                $args     = array_map( 'esc_html', $args );
                $feedback = vsprintf( $feedback, $args );
            }
        }
        if ( empty( $feedback ) ) {
            return;
        }
        show_message( $feedback );
    }

    /** * Performs an action before an update. * * @since 2.8.0 */

private function generateCompiledRoutes(): string
    {
        [$matchHost, $staticRoutes, $regexpCode, $dynamicRoutes, $checkConditionCode] = $this->getCompiledRoutes(true);

        $code = self::export($matchHost).', // $matchHost'."\n";

        $code .= '[ // $staticRoutes'."\n";
        foreach ($staticRoutes as $path => $routes) {
            $code .= sprintf(" %s => [\n", self::export($path));
            foreach ($routes as $route) {
                $code .= vsprintf(" [%s, %s, %s, %s, %s, %s, %s],\n", array_map([__CLASS__, 'export'], $route));
            }
            $code .= " ],\n";
        }
        $code .= "],\n";

        $code .= sprintf("[ // \$regexpList%s\n],\n", $regexpCode);

        $code .= '[ // $dynamicRoutes'."\n";
        foreach ($dynamicRoutes as $path => $routes) {
            $code .= sprintf(" %s => [\n", self::export($path));
            foreach ($routes as $route) {

'4.8.2'
                    );

                    // Preserving old behavior, where values are escaped as strings.                     $value = '';
                }

                $args_escaped[] = $this->_real_escape( $value );
            }
        }

        $query = vsprintf( $query, $args_escaped );

        return $this->add_placeholder_escape( $query );
    }

    /** * First half of escaping for `LIKE` special characters `%` and `_` before preparing for SQL. * * Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security. * * Example Prepared Statement: * * $wild = '%'; * $find = 'only 43% of planets'; * $like = $wild . $wpdb->esc_like( $find ) . $wild; * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like ); * * Example Escape Chain: * * $sql = esc_sql( $wpdb->esc_like( $input ) ); * * @since 4.0.0 * * @param string $text The raw text to be escaped. The input typed by the user * should have no extra or deleted slashes. * @return string Text in the form of a LIKE phrase. The output is not SQL safe. * Call wpdb::prepare() or wpdb::_real_escape() next. */

    protected function parseError($msg)
    {
        $args = func_get_args();

        if (count($args) > 1) {
            array_shift($args);
            $msg = vsprintf($msg, $args);
        }

        $line = $this->scanner->currentLine();
        $col = $this->scanner->columnOffset();
        $this->events->parseError($msg, $line, $col);

        return false;
    }

    /** * Decode a character reference and return the string. * * If $inAttribute is set to true, a bare & will be returned as-is. * * @param bool $inAttribute Set to true if the text is inside of an attribute value. * false otherwise. * * @return string */