Menu Close Menu
Menu
  • 0
    • Number of items in cart: 0

      • Your cart is empty.
      • Total: $0.00
      • Checkout
  • Pricing
    • Purchase Options
    • Individual Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Blog

[kbs_articles] Shortcode

[kbs_articles] Shortcode

Display lists of Knowledge Base articles on your web page

The [kbs_articles] shortcode enables you to display a list of KB Articles in any position on your web pages. The Articles being displayed can be customised by passing optional attributes to the Articles shortcode.

The articles shortcode should be added to any page where you would want to display a list of articles.

Default Usage

[kbs_articles]

Optional Parameters

[kbs_articles] accepts a number of parameters enabling you to customise the results being displayed:

articles
A comma separated list of Article post ID’s you would like to display
Default: null

number
The number of articles you want to display. A value of -1 will display all articles that match the parameters provided
Default: 20

author
A comma separated list of author ID’s whose articles you would like to display
Default: null

orderby
The order by which the found articles should be displayed. Possible values are views, views_month or any parameters as described here
Default: views (Order by number of total all time views)

order
Display the found articles in Ascending or Descending order
Default: DESC (highest to lowest)

tags
A comma separated list of Article Tag ID’s that the displayed articles should include
Default: 0 (ignore)

categories
A comma separated list of Article Category ID’s that the displayed articles should belong to
Default: 0 (ignore)

tax_relation
Whether a post should include both or either when providing both the tags and categories parameters. Possible values are AND or OR
Default: AND (ignored if you do not provide both the tags and categories parameters)

excerpt
1 to display the article excerpt after the title or 0
Default: 1

hide_restricted
1 to hide restricted Articles or 0 to display all Articles whether set to restricted or not
Default: value of Hide Restricted KB Articles settings option

Example Usage with Parameters

Display all Articles authored by user ID 10 without excerpts:

[kbs_articles author="10" excerpt="0"]

Display all Articles that contain the Tag ID’s 100 and 104 or are within category ID 120 regardless of whether or not they are restricted:

[kbs_articles tags="100,104" categories="120" tax_relation="OR" hide_restricted="0"]

Display all Articles ordered by the total number of views during the current month

[kbs_articles orderby="views_month"]

Was this article helpful?

We're working hard to ensure we provide you with useful and relevant documentation to help you get the most out of KB Support.

Please take a moment to let us know if you found this article helpful.

[kbs_articles] Shortcode

The [kbs_articles] shortcode enables you to display a customised list of articles anywhere on your web page. You can customise the list of articles to be displayed with a variety of shortcode options
KB Article rating: 3.5 based on 6 ratings
Shortcode Last updated: 17/01/2020

Published by Cristian Raiber

Posts by Cristian Raiber

Post navigation

Previous

[kbs_submit] Shortcode

Next

[kbs_search] Shortcode

Contact Details

  • Follow us on Twitter
  • Like us on Facebook
  • Fork us on GitHub

Developer Resources

Plugin Boilerplate

Trello Board

GitHub Repository

Ratings & Satisfaction Docs

  • Configuring Ratings and Satisfaction
  • Advanced Settings

Email Support Docs

  • Plugin Requirements
  • Configuring Email Support
  • Creating New Tickets
  • Replying to Closed Tickets
  • Anonymous Replies in Email Support
  • HTML Emails Tags
  • Email Commands
  • Defining IMAP Flags

KBS REST API Docs

  • Using the REST API
  • Tickets REST API Route
  • Replies REST API Route
  • Articles REST API Route
  • Agents REST API Route
  • Customers REST API Route
  • Companies REST API Route
  • Forms REST API Route
  • Form Fields REST API Route
  • Ticket Categories REST API Route
  • Ticket Departments REST API Route
  • Ticket Source REST API Route

Article Categories

  • Configuration
    • Advanced
    • Getting Started
  • Developer Docs
    • Constants
    • Hooks
  • Extensions
  • FAQs
© 2023 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Privacy Policy
  • Discount Code