WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Progress Bar

a simple progress bar shortcode that can be styled with CSS

Options

This page describes all the available parameters for the shortcode. These can be used in any combination. The only required parameter is progress. All parameters are case-sensitive (e.g. "progress" will work but "Progress" will not).

progress (required)

This determines how full the progress bar will be. Progress can be in 2 forms, either a number (0-100), in which case it will be interpreted as a percentage, or as a fraction (e.g. 25/100). Since 1.1, you can also use dollar signs (e.g. $63/$180), for example to create a fundraising progress bar. If using dollar signs, you only need to add a dollar sign to one or the other of the two values (e.g. 63/$180 or $63/180) -- the plugin will output either option the same ($63/$180). Your progress can go over, too (e.g. 150/100 or 123%), but your mileage may vary for the display. It's not recommended to use this with the fullwidth option, for example, because your progress will spill outside of your main body container.

Examples

[wppb progress=50]

A progress bar that is 50% complete

[wppb progress="50/100"]

A progress bar that is 50/100 complete

[wppb progress="$45/$50"]

A dollar value progress bar that is $45/$50 complete

[wppb progress=110]

A progress bar that has gone over 100%

[wppb progress=150/100]

A progress bar that has exceeded its goal

[wppb progress=$125/100]

A fundraising-style progress bar that has exceeded the goal

option

This adds one of several supported options to the progress bar. For those that know CSS, new "options" can be added simply by adding new styles to your style.css. See the Frequently Asked Questions page for more information on creating new CSS classes. Options can be combined by wrapping them in quotes in the shortcode. The progress bar will naturally have an inner shadow applied to it. The flat option was added to remove the shadow and display a "flat" color, best when used in conjunction with the color parameter.

Supported values: candystripe, animated-candystripe, red, orange, green, yellow, flat

Examples

[wppb progress=50 option=red]

Displays a red progress bar

[wppb progress=50 option="animated-candystripe green"]

Displays a green progress bar with an animated candystripe

[wppb progress=50 option="candystripe orange"]

Displays an orange progress bar with a static candystripe

[wppb progress=50 option=candystripe]

Displays a default progress bar (blue) with a static candystripe

[wppb progress=50 option=flat color=red]

Displays a red progress bar with no inner shadow or gradient

[wppb progress=50 option="flat candystripe" color=gray]

Displays a gray progress bar with no inner shadow or gradient and a static candystripe

percent

(Deprecated) This parameter is deprecated. Please use the location parameter instead.

Displays the percentage (or fraction) either inside or outside the progress bar. Note: It is not recommended to use percent=after if you are displaying a progress bar that exceeds its goal.

Supported values: inside, after

Examples

[wppb progress=50 option=red percent=after]

Displays a red progress bar with the percent displayed to the right of the progress bar

[wppb progress=50 option="red candystripe" percent=inside]

Displays a red progress bar with a static candystripe and the percent displayed inside the progress bar.

location

Displays the percentage, text or fraction either inside or outside the progress bar. Note: It is not recommended to use location=after if you are displaying a progress bar that exceeds its goal.

Supported values: inside, after

Examples

[wppb progress=50 option=red location=after]

Displays a red progress bar with the progress displayed to the right of the progress bar.

[wppb progress=50 option="red candystripe" location=inside]

Displays a red progress bar with a static candystripe and the progress displayed inside the progress bar.

[wppb progress=85 location=after text="foo"]

Displays a progress bar with the text "foo" displayed after the progress bar.

text

Displays arbitrary text instead of the progress bar. Can be used with the location parameter to define whether the text appears inside or outside the progress bar (default is inside). Must be used inside double quotes. HTML code is stripped from the final output.

Supported values: any plain text string

Examples

[wppb progress=75 text="My awesome text"]

Displays "My awesome text" inside a 75% progress bar.

[wppb progress=85 location=after text="foo"]

Displays "foo" after an 85% progress bar

[wppb progress=85 location=inside text="hello!"]

Displays "hello!" inside an 85% progress bar (note, default location for text is inside, so it isn't required to specify "inside").

fullwidth

Makes the progress bar take up 100% of the container. (Good for responsive layouts.) Not recommended for progress bars that exceed their goal. Note: fullwidth will actually take any value. If fullwidth is present at all, it will display a progress bar that is 100% wide. For example fullwidth=foo would output the same as fullwidth=true.

Supported value: true

Examples

[wppb progress=50 fullwidth=true]

Displays a full-width (responsive) progress bar

[wppb progress=50 fullwidth=foo]

Identical to the above progress bar

color

Defines a color for the progress bar. This is useful for creating new progress bar colors on the fly without having to edit CSS. Cannot be used in conjunction with any of the pre-existing color options (red, yellow, orange or green).

Supported values: any hexadecimal color value, any rgb/rgba color value, any css-supported color name

Examples

[wppb progress=50 color=rgb(123,50,87)]
[wppb progress=55 color=rgba(123,64,99,0.3)]

Note: Since the background color for the progress bar is dark gray, any opacity applied to the rgba color will make the color darker, since it's adding to the dark gray background.

[wppb progress=22 color=#ff3257]
[wppb progress=68 color=lightYellow]

endcolor

Defines an end color for a custom gradient when used with color.

Supported values: any hexadecimal color value, any rgb/rgba color value, any css-supported color name

Examples

[wppb progress=72 color=turquoise endcolor=teal]
[wppb progress=83 color=#ff2222 endcolor=#ff9984]
[wppb progress=50 color=rgb(203,96,179) endcolor=rgb(173,18,131)]

gradient

Determines an end-color on the fly for a gradient based on the color parameter. As such, gradient requires color to be present, otherwise the color and gradient will be set to the default color (blue). Cannot be used in conjunction with any of the pre-existing color options (red, yellow, orange or green). When using gradient the color value must be in hexadecimal form.

Supported values: any positive or negative decimal value from 0.0 to 1.0 or -1.0.

Examples

[wppb progress=22 color=#ff0000 gradient=0.2]

Displays a red progress bar that gets lighter at the bottom

[wppb progress=22 color=#ff0000 gradient=-0.2]

Displays a red progress bar that gets darker at the bottom

This does not work:

[wppb progress=34 color=rgb(22,18,99) gradient=0.2]

Requires: 2.8 or higher
Compatible up to: 3.8.3
Last Updated: 2014-2-3
Downloads: 15,522

Ratings

4 stars
4.9 out of 5 stars

Support

0 of 1 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1 100,1,1 100,2,2
100,2,2
100,2,2
100,1,1 50,2,1
100,2,2
100,1,1 100,1,1 100,1,1
100,1,1
100,1,1