Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation



integrationblogcta.jpg

News Module Documentation

Allows the ability to print server-wide news.

The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.

News::displaynews

API Version: 1 - Click here for documentation
Syntax: News::displaynews( )
Description: Display the cPanel news file. This function will display the news in the order of precedence:
  • /var/cpanel/news/global-news
  • /var/cpanel/news/global-resold (if the user's account is not owned by root)
  • /var/cpanel/news/$owner/news (if neither of the above two exist, will attempt to display News for the actual reseller owner of the account)

Each additional news entry will be printed after the previous one. Potentially every news item could be displayed.

Returns:  
 
The output will contain the cPanel news file.

Topic revision: r2 - 27 Mar 2012 - 19:04:16 - Main.JenniferDoubrava