Background

Edit this page on Github

Overview

The background field allows you to set background properties for a post. You can set background color, select an image and set other background settings.

Screenshot

background

Settings

This field doesn’t have any specific settings. It only uses common settings.

Sample code

array(
    'id'   => 'background',
    'name' => 'Background',
    'type' => 'background',
),

Data

This field stores background properties in a serialized array in the post meta.

Template usage

To get the background properties, use the helper function rwmb_meta():

$background = rwmb_meta( 'background' );
echo $background['color'];
echo $background['image'];

This helper function returns an array of background properties:

array(
    'color'      => '#111222',
    'image'      => 'https://domain.com/wp-uploads/2017/12/bg.png',
    'position'   => 'top left',
    'attachment' => 'fixed',
    'size'       => 'cover',
    'repeat'     => 'no-repeat',
);

If you want to get the CSS for the background, use the rwmb_the_value():

$css = rwmb_the_value( $field_id, '', '', false );
echo '<div style="', $css, '"></div>';

Read more about rwmb_meta() and rwmb_the_value().

Edit this page on Github