Pagelines welcome features

[edit] Please Note

These docs are now deprecated, we have a new Support area located here

(Difference between revisions)
(Usage)
(Usage)
Line 24: Line 24:
 
* <tt>desc</tt> - The description of the feature.
 
* <tt>desc</tt> - The description of the feature.
 
* <tt>class</tt> - The specific CSS class being used as an element container displayed on the theme Welcome page.
 
* <tt>class</tt> - The specific CSS class being used as an element container displayed on the theme Welcome page.
* <tt>icon</tt> - ...
+
* <tt>icon</tt> - not used ... ?
  
 
NB: <tt>my_pagelines_welcome_features</tt> is an example name, please use a more appropriately named function in your code. Also to note, ''my-textdomain'' should be the same textdomain you are using for your theme.
 
NB: <tt>my_pagelines_welcome_features</tt> is an example name, please use a more appropriately named function in your code. Also to note, ''my-textdomain'' should be the same textdomain you are using for your theme.

Revision as of 18:43, 8 April 2012

Filter

pagelines_welcome_features is used by get_welcome_features to return an array of the theme features on the theme Welcome page.

Usage

 array(
          'name'  => __( 'My First Feature', 'my-textdomain' ),
          'desc'  => __( 'This the description for My First Feature', 'my-textdomain' ),
          'class' => __( 'feature_dynamic' ), /* CSS class - borrowed for example purposes */
          'icon'  => '',
      ),
  );
  return $my_features;
}
?>

The array of arrays consists of an array of features; and each feature consists of an array of the following items:

  • name - The display name of the feature.
  • desc - The description of the feature.
  • class - The specific CSS class being used as an element container displayed on the theme Welcome page.
  • icon - not used ... ?

NB: my_pagelines_welcome_features is an example name, please use a more appropriately named function in your code. Also to note, my-textdomain should be the same textdomain you are using for your theme.