Ajax Content Blog Tags

This article covers the methods provided for Content Tags by the Aurora Ajax Library.

Ajax Method Group: Ajax_Frontend_Content_Blog_Tags

find

Permission Required: None

Method Call: /ajax/Ajax_Frontend_Content_Blog_Tags/find

📘
This method returns a recordset containing all Content Tags, taking into consideration any paging settings.

Parameter	Values	Default	Description	Required
page	Non-negative Integer	1	The number of the page of results you would like to have returned. The number of items returned per page defaults to the value specified in the "Posts per page" setting located under Store > Settings > Blog, but can be overridden using the "items_per_page" parameter if desired.	No
items_per_page	Positive Integer	"Posts per page" setting located under Store > Settings > Blog	The number of content items to return per page. This should be used to retrieve a particular number of items instead of any 'limit' variable. So if you require a list of 50 Content Items, then simply set this to 50 and do not provide a 'page' value (or do provide a 'page' value but set it to 1).	No
order_by_ascending	Boolean	true	If set to 'false', then the tags are returned in Descending order, otherwise they are return in Ascending order. This method will return tags in alphabetical order, delivering A-Z by default.	No

The data returned by this method is delivered as a Json encoded array of values, as described below.

Variable	Values	Description
items	Array( content_tag )	This is an indexed array of content_tag records.
content_tag	Container	A container holding all of the tag details.
tag.name	String	The free-test name for the Content Tag.
tag.url	String	The URL safe name for the tag, for use when including the tag in URLs for filtering.

Variable	Values	Description
more_available	Boolean	If there are more Content Items to be returned after the current record set that were not return due to paging or some other limit, then this will be true. Otherwise it is false. This is commonly used for deciding whether or not to show the "Next Page" link when listing Content Items.
total_items	Non-negative Integer	The total number of Content Items that matched the request made, regardless of any paging or limits in force. This is commonly used for showing how many results there are matching a particular query/search when paging, e.g. "1-20 of 650" where 650 is the value returned within the total_items variable.
number_of_pages	Non-negative Integer	The total number of pages of results based on the current settings used for the original request. This is most useful when simply using the default value for items_per_page, so that your calling script(s) can generate their paging as needed, without the need to know the specifics about the limits in play.

Updated over 2 years ago