NF_Abstracts_Submenu

WordPress Menu Page Base Class.

Defined (1)

The class is defined in the following location(s).

/includes/Abstracts/Submenu.php  
  1. abstract class NF_Abstracts_Submenu 
  2. { 
  3.     /** 
  4.      * (required) The slug name for the parent menu (or the file name of a standard WordPress admin page) 
  5.      * 
  6.      * @var string 
  7.      */ 
  8.     public $parent_slug = ''; 
  9.  
  10.     /** 
  11.      * (required) The text to be displayed in the title tags of the page when the menu is selected 
  12.      * 
  13.      * @var string 
  14.      */ 
  15.     public $page_title = ''; 
  16.  
  17.     /** 
  18.      * (required) The on-screen name text for the menu 
  19.      * 
  20.      * @var string 
  21.      */ 
  22.     public $menu_title = ''; 
  23.  
  24.     /** 
  25.      * (required) The capability required for this menu to be displayed to the user. 
  26.      * 
  27.      * @var string 
  28.      */ 
  29.     public $capability = 'manage_options'; 
  30.  
  31.     /** 
  32.      * (required) The slug name to refer to this menu by (should be unique for this menu). 
  33.      * 
  34.      * @var string 
  35.      */ 
  36.     public $menu_slug = ''; 
  37.  
  38.     /** 
  39.      * (optional) The function that displays the page content for the menu page. 
  40.      * 
  41.      * @var string 
  42.      */ 
  43.     public $function = 'display'; 
  44.  
  45.     public $priority = 10; 
  46.  
  47.     /** 
  48.      * Constructor 
  49.      * 
  50.      * Translate text and add the 'admin_menu' action. 
  51.      */ 
  52.     public function __construct() 
  53.     { 
  54.         add_action( 'admin_menu', array( $this, 'register' ), $this->priority ); 
  55.     } 
  56.  
  57.     /** 
  58.      * Register the menu page. 
  59.      */ 
  60.     public function register() 
  61.     { 
  62.         $function = ( $this->function ) ? array( $this, $this->function ) : NULL; 
  63.  
  64.         add_submenu_page( 
  65.             $this->parent_slug,  
  66.             $this->get_page_title(),  
  67.             $this->get_menu_title(),  
  68.             apply_filters( 'ninja_forms_submenu_' . $this->get_menu_slug() . '_capability', $this->get_capability() ),  
  69.             $this->get_menu_slug(),  
  70.             $function 
  71.  ); 
  72.     } 
  73.  
  74.     public function get_page_title() 
  75.     { 
  76.         return $this->page_title; 
  77.     } 
  78.  
  79.     public function get_menu_title() 
  80.     { 
  81.         return ( $this->menu_title ) ? $this->menu_title : $this->get_page_title(); 
  82.     } 
  83.  
  84.     public function get_menu_slug() 
  85.     { 
  86.         return ( $this->menu_slug ) ? $this->menu_slug : 'nf-' . strtolower( preg_replace( '/[^A-Za-z0-9-]+/', '-', $this->get_menu_title() ) ); 
  87.     } 
  88.  
  89.     public function get_capability() 
  90.     { 
  91.         return $this->capability; 
  92.     } 
  93.  
  94.     /** 
  95.      * Display the menu page. 
  96.      */ 
  97.     public abstract function display(); 
  98.  
  99.  
  100. }