Plugin Interface

Read more about the plugin and the user interface.

Views

Add a View and select target fields or import a pre-built component.

  • Add New - On the Views list, used to add a new View.

  • Search View - Search in your list of Views by Name, Description, Labels or View-id.

  • Bulk validation - Used to validate the Custom Template field of all existing items and displays items that have failed validation.

  • Pre-built Components - Install commonly used elements with Meta fields and responsive CSS rules included.

Views list Table Header Labels

  • Title - Name of your View.

  • Description - The description of your View for admin or editor role users.

  • Shortcode - The primary shortcode used to display your View.

  • Assigned Group - The fields that have been assigned in your View.

  • Assigned to Card - The Card names you've assigned the View to.

  • Last modified - The date the View was last modified.

When hovering on the Views list Rows

  • Edit - To edit your View.

  • Clone - To clone your View.

  • Delete - To delete your View.

Tabs on edit screen

Fields tab

Assign Fields to your View.

Parent group

Choose a parent group. If you require fields from various groups, keep this field blank.

Fields

  • Add Field - Used for adding field rows to your View.

Field

  • Group - Select a target group.

  • Make your selection from the following field Groups:

  • Field - Select a target field. Note: only fields with supported data vendors are listed.

    • Label - If filled will be added to the markup as a prefix label of the field above.

    • Link Label - You can set the link label here. Leave empty to use the default.

    • Image Size - Controls the size of the image, it changes the image source.

  • Gallery Layout (For Gallery field type) - Select the gallery layout type. If Masonry is chosen see Field Options for more settings.

    • Default - Shows a grid of images from the field.

    • Masonry - Shows images in a Masonry style.

    • With Lightbox (For Image field type -Pro Only) - If enabled, image(s) will include a zoom icon on hover, and when clicked, a popup with a larger image will appear.

View - (For Relationship field types) If filled then data within this field will be displayed using the selected View. When empty it will show the object title with link.

Field Options

See all field options here.

Template tab

  • Default Template - Output preview of the generated Twig template. Important! Publish or Update your view to see the latest markup.

  • Custom Template - Write your own template with full control over the HTML markup. You can copy the Template Preview field output and make your changes. Powerful Twig features, including our functions, are available for you. Note: WordPress shortcodes inside the template are only supported in the Pro version. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

Important! The Custom Template field will not be updated automatically when you add or remove fields, so you have to update this field manually to reflect the new changes (you can refer to the Default Template field for assistance).

  • BEM Unique Name - Define a unique BEM name for the element that will be used in the markup, or leave it empty to use the default ('acf-view').

  • CSS classes - Add a class name without a dot (e.g. “class-name”) or multiple classes with single space as a delimiter (e.g. “class-name1 class-name2”). These classes are added to the wrapping HTML element. Learn more about CSS Classes.

  • Add classification classes to the markup - By default, the field name is added as a prefix to all inner classes. For example, the image within the 'avatar' field will have the '__avatar-image' class. Enabling this setting adds the generic class as well, such as '__image'. This feature can be useful if you want to apply styles based on field types.

  • Do not skip unused wrappers - By default, empty wrappers in the markup are skipped to optimize the output. For example, the '__row' wrapper will be skipped if there is no field label. Enable this feature if you need all the wrappers in the output.

  • Custom Data (Pro) - Using the Custom View Data PHP snippet you can add custom variables to the template and define the ajax handler. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

CSS & JS tab

  • CSS Code - Define your CSS style rules here or within your theme. Rules defined here will be added within <style></style> tags ONLY to pages that have this view. Press Ctrl (Cmd) + Alt + L to format the code. Magic shortcuts are available (and will use the BEM Unique Name if defined) : '#view' will be replaced with '.acf-view--id--X' (or '.bem-name'). '#view__' will be replaced with '.acf-view--id--X .acf-view__' (or '.bem-name .bem-name__'). It means you can use '#view__row' and it'll be replaced with '.bem-name .bem-name__row'. '#__' will be replaced with '.acf-view__' (or '.bem-name__')

  • JS Code - Add your custom Javascript to your View. By default, the View is a web component, so this code will be executed once for every instance, and 'this', that refers to the current instance, is available. If the Web Component Type is set to none, the js code here is plain, and can be used for any goals, including WP Interactivity API. The code snippet will be added within <script type='module'></script> tags ONLY to pages that have this View. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

Options tab

  • Description - Add a short description for your Views’ purpose. Note: This description is only seen on the admin Advanced Views list.

  • Register Gutenberg Block (Pro only and requires ACF Pro) - If block vendor is chosen, a separate Gutenberg block for this View will be available. Read more

  • Web Component Type - By default, every Card is a web component, which allows you to work easily with the element in the JS code field. Set it to 'None' if you're going to use the WP Interactivity API.

  • Classes generation - Controls classes generation in the Default Template.

  • Render template when it's empty - By default, if all the selected fields are empty, the Twig template won't be rendered. Enable this option if you have specific logic inside the template and you want to render it even when all the fields are empty.

  • Use the Post ID as the View ID in the markup - Enable this option if you have external CSS selectors that rely on outdated digital IDs. Note: For backward compatibility purposes only.

Preview

  • Preview Object - Select a data object (from which field values will be used) and update the View. After that, reload the page to see the markup in the Preview.

  • Preview - Here you can see the preview of the view and play with CSS rules. Read more Important! Update the View after changes and reload the page to see the latest markup here. Your changes to the preview won't be applied to the view automatically, if you want to keep them copy amended CSS to the 'CSS Code' field and press the 'Update' button. Note: styles from your front page are included in the preview (some differences may appear)

Mount Points (Pro)

  • Mount Points - 'Mount' this View/Card to a location that doesn't support shortcodes. Mounting uses 'the_content' theme hook.

  • Add Mount Point - Used for adding a Mount Point.

Cards

Add a Card and select a set of posts or import a pre-built component. Attach the Card to the target place, for example using the shortcode, to display queried items with their fields. (The assigned View determines which fields are displayed)

  • Add New - On the Cards list, used to add a new Card.

  • Search Card - Search in your list of Cards by Name, Description, Labels or View-id.

  • Bulk validation - Used to validate the Custom Template field of all existing items and displays items that have failed validation.

  • Pre-built Components - Install commonly used elements with Meta fields and responsive CSS rules included.

Cards list Table Header Labels

  • Title - Name of your View

  • Description - The description of your View for admin or editor role users.

  • Shortcode - The primary shortcode used to display your View.

  • Related View - The View that has been assigned to your Card.

  • Last modified - The date the Card was last modified.

When hovering on Cards list Rows

  • Edit - To edit your Card.

  • Clone - To clone your Card.

  • Delete - To delete your Card.

Tabs on edit screen

Basic tab

  • View - Assigned View is used to display every post from the query results.

  • Post Type - Filter by post type. You can select multiple items.

  • Post Status - Filter by post status. You can select multiple items.

  • Maximum number of posts - Use '-1' to set 'unlimited'.

  • Sort by - Select which field results should be sorted by. ‘Default’ keeps the default order (latest first, sticky options may affect it).

  • Sort order - Defines the sorting order of posts.

Advanced tab

  • Description - Add a short description for your views’ purpose. Only seen on the admin Cards list.

  • No Posts Found Message - This message will be displayed in case there are no posts found. Leave empty to not show a message.

  • Pool of posts - Here you can manually assign specific posts. If set then the query will be limited to posts ONLY from this pool. It means the result will consist ONLY from posts from this pool, which also fit all other filters. If you want to have the same order of results like here, please choose the 'Pool of posts' option in the Sort tab.

  • Exclude posts - Here you can manually exclude specific posts from the query. It means the query will ignore posts from this list, even if they fit the filters. Warning : this field can't be used together with 'Pool of posts'.

  • Ignore Sticky Posts - If unchecked then sticky posts will be at the top of results. Learn more about Sticky Posts.

  • Web Component Type - By default, every Card is a web component, which allows you to work easily with the element in the JS code field. Set it to 'None' if you're going to use the WP Interactivity API.

  • Classes generation - Controls classes generation in the Default Template.

  • Use the Post ID as the Card ID in the markup - Note: For backward compatibility purposes only. Enable this option if you have external CSS selectors that rely on outdated digital IDs.

  • Query Preview - For debug purposes. Here you can see the query that will be executed to get posts for this card. Important! Publish or Update your card and reload the page to see the latest query.

  • Custom Data (Pro) - Using the Custom Card Data PHP snippet you can add extra variables to the template, extra arguments to the WP_Query instance, and define the ajax handler. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

Template tab

  • Default Template - Output preview of the generated Twig template. Important! Publish or Update your view to see the latest markup.

  • Custom Template - Write your own template with full control over the HTML markup. You can copy the Template Preview field output and make your changes, such as adding an extra heading. Powerful Twig features, including our functions, are available for you. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

Important! Make sure you retain all the default classes; otherwise, pagination won't work.

  • BEM Unique Name - Define a unique BEM name for the element that will be used in the markup, or leave it empty to use the default ('acf-card').

  • CSS classes - Add a class name without a dot (e.g. 'class-name') or multiple classes with single space as a delimiter (e.g. 'class-name1 class-name2'). These classes are added to the wrapping HTML element. Learn more about CSS Classes

CSS & JS

  • CSS Code - Define your CSS style rules. This will be added within tags ONLY to pages that have this card.

    Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

    Don't style view fields here, View has its own CSS field for this goal.

    Magic shortcuts are available (and will use the BEM Unique Name if defined) :

    '#card' will be replaced with '.acf-card--id--X' (or '.bem-name').

    '#card__' will be replaced with '.acf-card--id--X .acf-card__' (or '.bem-name .bem-name__').

    '#' will be replaced with '.acf-card' (or '.bem-name__').

    To match items wrapper you should use '#card__items' selector, to match single item you should use '#card .acf-view' selector.

  • JS Code - Add your custom Javascript to your Card. By default, the Card is a web component, so this code will be executed once for every instance, and 'this', that refers to the current instance, is available. If the Web Component Type is set to none, the js code here is plain, and can be used for any goals, including WP Interactivity API. The code snippet will be added within <script type='module'></script> tags ONLY to pages that have this Card. Press Ctrl (Cmd) + Alt + L to format the code. Press Ctrl + F to search (or replace).

Layout tab

  • Enable Slider (Pro) - Select the slider library to enable. Customize the slider after saving, by editing the JS Code in the CSS & JS tab.

  • Enable Layout rules - When enabled CSS layout styles are added to CSS Code in the Advanced tab. These styles are automatically updated each time. Tip: If you’d like to edit the Layout CSS manually, simply disable this here. Disabling this does not remove the previously added CSS Code.

  • Layout Rules - The rules control layout of card items. Note: These rules are inherited from small to large. For example: If you’ve set up 'Mobile' and 'Desktop' screen rules, then 'Tablet' will have the same rules as 'Mobile' and 'Large Desktop' will have the same rules as 'Desktop'.

    • Screen Size - Controls to which screen size the rule applies.

    • Layout - Change the type of layout.

    • Horizontal gap - Horizontal gap between items. Format: '10px'. Possible units are 'px', '%', 'em/rem'.

    • Amount of Columns (For Grid Layout) - Define how many columns each row should have. By default, columns have equal width.

    • Vertical gap - Vertical gap between items. Format: '10px'. Possible units are 'px', '%', 'em/rem'.

Meta Filters (Pro) tab

  • Rules - Rules for the meta query. Multiple rules are supported. Read more If you want to see the query that was created by your input, update the Card and reload the page. After that, have a look at the Query Preview field in the Advanced tab.

  • Add Rule - For adding Rule rows.

Adding multiple Rules will add a Relation to join the rules within the meta query.

  • Add Field - For adding meta fields to filter by.

Fields - Fields for the meta rule. Multiple fields are supported.

  • Group - Select a target group.

  • Field - Select a target field. Note : only fields with supported field types are listed here.

  • Comparison - Controls how field value will be compared.

  • Value - Value that will be compared. Can be empty, in case you want to compare with empty string. Use $post$ to pick up the actual ID or $post$.field-name to pick up field value dynamically. Use $now$ to pick up the current datetime dynamically. Use $query$.my-field to pick up the query value (from $_GET) dynamically

  • Relation - Controls how meta rules will be joined within the meta query.

Taxonomy Filters (Pro) tab

  • Rules - Rules for the taxonomy query. Multiple rules are supported. Read more. If you want to see the query that was created by your input, update the Card and reload the page. After have a look at the Query Preview field in the Advanced tab.

  • Add Rule - For adding Rule rows.

  • Taxonomies - Taxonomies for the taxonomy rule. Multiple taxonomies are supported.

  • Add Taxonomy - For adding Taxonomies to filter by.

  • Taxonomy - Select a target taxonomy.

  • Comparison - Controls how taxonomy will be compared.

  • Term - Term that will be compared.

Pagination (Pro) tab

  • With Pagination - If enabled then instead of displaying all posts from query results, only the limited number of posts will be shown and user will be able to load more.

  • Pagination Type - Defines a way in which user can load more. For Load More Button and Page Numbers cases a special markup will be added to the card automatically, you can style it using the CSS Code field in the CSS & JS tab.

  • Label for the 'Load More' button - The name says it all ;)

  • Posts Per Page - Controls how many posts will be displayed initially and how many posts will be appended every time when user triggers 'Load More'. Total amount of post is limited by the Maximum amount of posts field in the Filter tab.

Preview tab

See an output preview of your Card, where you can test some CSS styles. Styles from your front page are included in the preview (some differences may appear). Note: Press 'Update' if you have changed Custom Markup (in the Template tab) to see the latest preview.

Important! Don't style your View here, instead use the CSS Code field in your View.

After testing: Remember to Copy and paste the Card styles to the CSS Code field.

Mount Points (Pro) tab

'Mount' this View/Card to a location that doesn't support shortcodes. Mounting uses 'the_content' theme hook.

  • Specific posts - Limit the mount point to only specific posts. Leave empty and use the 'Post Types' field to limit to specific post types.

  • Post Types - Specific post types, to all items of which the shortcode should be mounted. Leave empty if you want to add to specific items only and use the 'Specific posts' field.

  • Mount Point - To which unique Word, String or HTML piece to Mount to. Together with the 'Mount Position' controls the placement. If left empty all the content will be used as a mount point.

  • Mount Position - Where the shortcode should be mounted.

  • Shortcode Arguments - Add arguments to the shortcode, e.g. 'user-with-roles'. Only the view/card 'id' argument is filled by default.

Last updated