Latest releases
Latest stable release: 4.0.3
View changelog »
Copyright © 2005-2007 Spoonlabs d.o.o.
All rights Reserved.
| Parameter name | Value | Description |
|---|---|---|
| id | integer | Article ID |
| category_id | integer | Category ID |
| user_id | integer | User ID |
| user_domain | string | user source domain (for user integration plugin) |
| author | string | Author name |
| title | string | Article title |
| image | string | Article image |
| created | date | Publishing date |
| body | text | Body of the article |
| last_read | date | Date when the article was last time viewed |
| times_read | integer | Number of reading an article (total) |
| today_read | integer | Number of reading an article (for current day) |
| status | -1 | 0 | 1 | 2 | Status of the article (archived | pending | active | headline) |
| sefriendly | string | SE friendly name |
| link | string | Article external link |
| order_num | integer | position in article ordering |
| document | string | The file name of attached document |
| show_poll | 0 | 1 | Show poll option (yes | no) |
| show_comment | 0 | 1 | Show comment option (yes | no) |
| rss_feed | 0 | 1 | Published to feed (yes | no) |
| keywords | string | Meta keywords |
| description | string | Meta description |
| emailed | integer | How many time an article was emailed |
| image_caption | string | Article image caption |
| vote_num | integer | Number of votes for the article |
| vote_sum | integer | Sum of votes for articles |
| abstract | text | Article abstract |
| get_id | integer | Returns article ID |
| get_category_id | integer | Returns category ID |
| get_user_id | integer | Returns user ID |
| get_user_domain | string | Get user domain |
| get_author | string | Returns the name of the author (full/usernam) |
| get_title | string | Returns the title of the article |
| get_image | string | Returns the name of article's abstract image name |
| get_created | date | Returns the date when the article was published (formated) |
| get_body | text | Returns the body of the article |
| get_last_read | date | Returns the date when the article was last viewed |
| get_times_read | integer | Returns the number of views (total) |
| get_today_read | integer | Returns the number of views (current day) |
| get_status | -1 | 0 | 1 | 2 | Returns the status of the article (archived | pending | active | headline) |
| get_sefriendly | string | Returns SE friendly name |
| get_link | string | Returns external link |
| get_order_num | integer | Returns the order of article |
| get_document | string | Returns the file attached to the article |
| get_show_poll | 0 | 1 | Returns selected option for displaying the poll |
| get_show_comment | 0 | 1 | Returns selected option for displaying the comment |
| get_rss_feed | 0 | 1 | Returns selected option for displaying the feed |
| get_keywords | string | Returns meta keywords |
| get_description | string | Returns meta description |
| get_emailed | integer | Returns the number of times an article was emailed |
| get_image_caption | string | Returns the image caption |
| get_vote_num | integer | Returns the number of votes for the article |
| get_vote_sum | integer | Returns sum of votes for article |
| get_vote_average | decimal | Returns the average vote |
| is_voted | mixed | integer on true, false on failed |
| get_abstract | text | Returns article's abstract |
| get_author_name | string | Returns the name of the author |
| get_author_href | string | Returns link to the author's page |
| get_href | string | Returns link to the article's page |
| get_breadcrumb | array | Returns article breadcrumb |
| get_category_name | string | Returns category name for the article |
| get_summary | string | Returns summary for the article (abstract if present or first n characters of body) |
| get_number_of_comments | integer | Returns number of comments for the article |
| get_number_of_tags | integer | Returns number of tags |
| generate_captcha | void | Generate captcha code |