wp/wp-content/plugins/option-tree/includes/ot-functions-docs-page.php
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php if ( ! defined( 'OT_VERSION' ) ) exit( 'No direct script access allowed' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * OptionTree documentation page functions.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * @package   OptionTree
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * @author    Derek Herman <derek@valendesigns.com>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 * @copyright Copyright (c) 2013, Derek Herman
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
 * Creating Options option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
if ( ! function_exists( 'ot_type_creating_options' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
  function ot_type_creating_options() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
        echo '<h4>'. __( 'Label', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
        echo '<p>' . __( 'The Label field should be a short but descriptive block of text 100 characters or less with no HTML.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
        echo '<h4>'. __( 'ID', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
        echo '<p>' . __( 'The ID field is a unique alphanumeric key used to differentiate each theme option (underscores are acceptable). Also, the plugin will change all text you write in this field to lowercase and replace spaces and special characters with an underscore automatically.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
        echo '<h4>'. __( 'Type', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
        echo '<p>' . __( 'You are required to choose one of the supported option types when creating a new option. Here is a list of the available option types. For more information about each type click the <code>Option Types</code> tab to the left.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
        foreach( ot_option_types_array() as $key => $value )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
          echo '<li>' . $value . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
        echo '<h4>'. __( 'Description', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
        echo '<p>' . __( 'Enter a detailed description for the users to read on the Theme Options page, HTML is allowed. This is also where you enter content for both the Textblock & Textblock Titled option types.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
        echo '<h4>'. __( 'Choices', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
        echo '<p>' . __( 'Click the "Add Choice" button to add an item to the choices array. This will only affect the following option types: Checkbox, Radio, Select & Select Image.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
        echo '<h4>'. __( 'Settings', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
        echo '<p>' . __( 'Click the "Add Setting" button found inside a newly created setting to add an item to the settings array. This will only affect the List Item type.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
        echo '<h4>'. __( 'Standard', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
        echo '<p>' . __( 'Setting the standard value for your option only works for some option types. Those types are one that have a single string value saved to them and not an array of values.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
        echo '<h4>'. __( 'Rows', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
        echo '<p>' . __( 'Enter a numeric value for the number of rows in your textarea. This will only affect the following option types: CSS, Textarea, & Textarea Simple.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
        echo '<h4>'. __( 'Post Type', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
        echo '<p>' . __( 'Add a comma separated list of post type like <code>post,page</code>. This will only affect the following option types: Custom Post Type Checkbox, & Custom Post Type Select. Below are the default post types available with WordPress and that are also compatible with OptionTree. You can also add your own custom <code>post_type</code>. At this time <code>any</code> does not seem to return results properly and is something I plan on looking into.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
          echo '<li><code>post</code></li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
          echo '<li><code>page</code></li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
          echo '<li><code>attachment</code></li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
        echo '<h4>'. __( 'Taxonomy', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
        echo '<p>' . __( 'Add a comma separated list of any registered taxonomy like <code>category,post_tag</code>. This will only affect the following option types: Taxonomy Checkbox, & Taxonomy Select.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
        echo '<h4>'. __( 'Min, Max, & Step', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
        echo '<p>' . __( 'Add a comma separated list of options in the following format <code>0,100,1</code> (slide from <code>0-100</code> in intervals of <code>1</code>). The three values represent the minimum, maximum, and step options and will only affect the Numeric Slider option type.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
        echo '<h4>'. __( 'CSS Class', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
        echo '<p>' . __( 'Add and optional class to any option type.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
 * ot_get_option() option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
 * This is a callback function to display text about ot_get_option().
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
if ( ! function_exists( 'ot_type_option_types' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
  function ot_type_option_types() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
        echo '<h4>'. __( 'Background', 'option-tree' ) . ':</h4>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
        echo '<p>' . __( 'The Background option type is for adding background styles to your theme either dynamically via the CSS option type below or manually with <code>ot_get_option()</code>. Background has filters that allow you to change the defaults. For example, you can filter on <code>ot_recognized_background_repeat</code>, <code>ot_recognized_background_attachment</code>, and <code>ot_recognized_background_position</code>. These filters allow you to fine tune the select lists for your specific CSS needs.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
        echo '<h4>'. __( 'Category Select', 'option-tree' ) . ':</h4>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
        echo '<p>' . __( 'The Category Select option type displays a list of category IDs. It allows the user to select only one category ID and will return that value for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
        echo '<h4>'. __( 'Category Checkbox', 'option-tree' ) . ':</h4>';      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
        echo '<p>' . __( 'The Category Checkbox option type displays a list of category IDs. It allows the user to check multiple category IDs and will return that value as an array for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
        echo '<h4>'. __( 'Checkbox', 'option-tree' ) . ':</h4>';       
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
        echo '<p>' . __( 'The Checkbox option type is fairly self explanatory. Typically used to ask questions. For example, "Do you want to activate asynchronous Google analytics?" would be a single checkbox with a value of yes. You could have more complex usages but the idea is that you can easily grab the value of the checkbox and use it in you theme. In this situation you would test if the checkbox has a value and execute a block of code if it does and do nothing if it doesn\'t.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
        echo '<h4>'. __( 'Colorpicker', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
        echo '<p>' . __( 'The Colorpicker option type saves a hexadecimal color code for use in CSS. Use it to modify the color of something in your theme.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
        echo '<h4>'. __( 'CSS', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
        echo '<p>' . __( 'The CSS option type is a textarea that when used properly can add dynamic CSS to your theme from within OptionTree. Unfortunately, due server limitations you will need to create a file named <code>dynamic.css</code> at the root level of your theme and change permissions using chmod so the server can write to the file. I have had the most success setting this single file to 0777 but feel free to play around with permissions until everything is working. A good starting point is 0666. When the server can save to the file CSS will automatically be updated each time you save your theme options.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
        echo '<p class="aside">' . __( 'An example of the CSS option type: This assumes you have an option with the ID of <code>custom_background_css</code> which will display the saved values for that option.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
        echo '<p>'. __( 'Input', 'option-tree' ) . ':</p>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
        echo '<pre><code>body {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
  {{custom_background_css}}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
  background-color: {{custom_background_css|background-color}};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
}</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
        echo '<p>'. __( 'Output', 'option-tree' ) . ':</p>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
        echo '<pre><code>/* BEGIN custom_background_css */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
body {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
  background: color image repeat attachment position;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
  background-color: color;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
/* END custom_background_css */</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
        echo '<h4>'. __( 'Custom Post Type Select', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
        echo '<p>' . __( 'The Custom Post Type Select option type displays a list of IDs from any available WordPress post type or custom post type. It will return a single post ID for use in a custom function or loop. Requires at least one valid <code>post_type</code> when created in the settings. For some reason <code>any</code> does not work correctly and will looked into in future version.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
        echo '<h4>'. __( 'Custom Post Type Checkbox', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
        echo '<p>' . __( 'The Custom Post Type Select option type displays a list of IDs from any available WordPress post type or custom post type. It allows the user to check multiple post IDs for use in a custom function or loop. Requires at least one valid <code>post_type</code> when created in the settings. For some reason <code>any</code> does not work correctly and will looked into in future version.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
        echo '<h4>'. __( 'List Item', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
        echo '<p>' . __( 'The list Item replaced the old Slider option type. It allows for a great deal of customization. You can add settings to the List Item and those settings will be displayed to the user when they add a new List Item. Typical use is for creating sliding content or blocks of code for custom layouts.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
        echo '<h4>'. __( 'Measurement', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
        echo '<p>' . __( 'The Measurement option type is a mix of input and select fields. The text input excepts a value and the select lets you choose the unit of measurement to add to that value. Currently the default units are <code>px</code>, <code>%</code>, <code>em</code>, <code>pt</code>. However, you can change them with the <code>ot_measurement_unit_types</code> filter.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
        echo '<p>' . __( 'Example filter to add new units to the Measurement option type. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
        echo '<pre><code>function filter_measurement_unit_types( $array, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
  /* only run the filter on measurement with a field ID of my_measurement */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
  if ( $field_id == \'my_measurement\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
    $array[\'in\'] = \'inches\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
    $array[\'ft\'] = \'feet\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
  return $array;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
add_filter( \'ot_measurement_unit_types\', \'filter_measurement_unit_types\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
        echo '<p>' . __( 'Example filter to completely change the units in the Measurement option type. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
        echo '<pre><code>function filter_measurement_unit_types( $array, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
  /* only run the filter on measurement with a field ID of my_measurement */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   167
  if ( $field_id == \'my_measurement\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   168
    $array = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   169
      \'in\' => \'inches\',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   170
      \'ft\' => \'feet\'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   171
    );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   172
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   173
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   174
  return $array;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   175
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   176
add_filter( \'ot_measurement_unit_types\', \'filter_measurement_unit_types\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   177
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   178
        echo '<h4>'. __( 'Numeric Slider', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   179
        echo '<p>' . __( 'The Numeric Slider option type displays a jQuery UI slider. It will return a single numerical value for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   180
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   181
        echo '<h4>'. __( 'Page Select', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   182
        echo '<p>' . __( 'The Page Select option type displays a list of page IDs. It will return a single page ID for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   183
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   184
        echo '<h4>'. __( 'Page Checkbox', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   185
        echo '<p>' . __( 'The Page Select option type displays a list of page IDs. It allows the user to check multiple page IDs for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   186
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   187
        echo '<h4>'. __( 'Post Select', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   188
        echo '<p>' . __( 'The Post Select option type displays a list of post IDs. It will return a single post ID for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   189
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   190
        echo '<h4>'. __( 'Post Checkbox', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   191
        echo '<p>' . __( 'The Post Select option type displays a list of post IDs. It allows the user to check multiple post IDs for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   192
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   193
        echo '<h4>'. __( 'Radio', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   194
        echo '<p>' . __( 'The Radio option type could ask a question. For example, "Do you want to activate the custom navigation?" could require a yes or no answer with a radio option. In this situation you would test if the radio has a value of \'yes\' and execute a block of code, or if it\'s \'no\' execute a different block of code.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   195
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   196
        echo '<h4>'. __( 'Radio Image', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   197
        echo '<p>' . __( 'the Radio Images option type is primarily used for layouts. However, you can filter the image list using <code>ot_radio_images</code>. As well, you can add your own custom images using the choices array.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   198
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   199
        echo '<p>' . __( 'This example executes the <code>ot_radio_images</code> filter on layout images attached to the <code>my_radio_images</code> field. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   200
        echo '<pre><code>function filter_radio_images( $array, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   201
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   202
  /* only run the filter where the field ID is my_radio_images */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   203
  if ( $field_id == \'my_radio_images\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   204
    $array = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   205
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   206
        \'value\'   => \'left-sidebar\',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   207
        \'label\'   => __( \'Left Sidebar\', \'option-tree\' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   208
        \'src\'     => OT_URL . \'/assets/images/layout/left-sidebar.png\'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   209
      ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   210
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   211
        \'value\'   => \'right-sidebar\',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   212
        \'label\'   => __( \'Right Sidebar\', \'option-tree\' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   213
        \'src\'     => OT_URL . \'/assets/images/layout/right-sidebar.png\'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   214
      )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   215
    );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   216
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   217
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   218
  return $array;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   219
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   220
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   221
add_filter( \'ot_radio_images\', \'filter_radio_images\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   222
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   223
        echo '<h4>'. __( 'Select', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   224
        echo '<p>' . __( 'The Select option type is used to list anything you want that would be chosen from a select list.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   225
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   226
        echo '<h4>'. __( 'Sidebar Select', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   227
        echo '<p>' . __( 'This option type makes it possible for users to select a WordPress registered sidebar to use on a specific area. By using the two provided filters, <code>ot_recognized_sidebars</code>, and <code>ot_recognized_sidebars_{$field_id}</code> we can be selective about which sidebars are available on a specific content area.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   228
        echo '<p>' . __( 'For example, if we create a WordPress theme that provides the ability to change the Blog Sidebar and we don\'t want to have the footer sidebars available on this area, we can unset those sidebars either manually or by using a regular expression if we have a common name like <code>footer-sidebar-$i</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   229
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   230
        echo '<h4>'. __( 'Slider', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   231
        echo '<p>' . __( 'The Slider option type is technically deprecated. Use the List Item option type instead, as it\'s infinitely more customizable. Typical use is for creating sliding image content.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   232
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   233
        echo '<h4>'. __( 'Tag Checkbox', 'option-tree' ) . ':</h4>';      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   234
        echo '<p>' . __( 'The Tag Checkbox option type displays a list of tag IDs. It allows the user to check multiple tag IDs and will return that value as an array for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   235
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   236
        echo '<h4>'. __( 'Tag Select', 'option-tree' ) . ':</h4>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   237
        echo '<p>' . __( 'The Tag Select option type displays a list of tag IDs. It allows the user to select only one tag ID and will return that value for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   238
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   239
        echo '<h4>'. __( 'Taxonomy Checkbox', 'option-tree' ) . ':</h4>';      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   240
        echo '<p>' . __( 'The Taxonomy Checkbox option type displays a list of taxonomy IDs. It allows the user to check multiple taxonomy IDs and will return that value as an array for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   241
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   242
        echo '<h4>'. __( 'Taxonomy Select', 'option-tree' ) . ':</h4>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   243
        echo '<p>' . __( 'The Taxonomy Select option type displays a list of taxonomy IDs. It allows the user to select only one taxonomy ID and will return that value for use in a custom function or loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   244
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   245
        echo '<h4>'. __( 'Text (Input)', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   246
        echo '<p>' . __( 'The Text option type would be used to save a string value. For example, a link to feedburner, your Twitter username, or Google Analytics ID are all good candidates. Any optional or required text that is of reasonably short character length.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   247
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   248
        echo '<h4>'. __( 'Textarea', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   249
        echo '<p>' . __( 'The Textarea option type is a large string value used for custom code or text in the theme. The new Textarea has a WYSIWYG editor that can be filtered to change the buttons shown. For example, you can filter on <code>wpautop</code>, <code>media_buttons</code>, <code>tinymce</code>, and <code>quicktags</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   250
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   251
        echo '<p class="aside">' . __( 'Example filters to alter the Textarea option type. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   252
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   253
        echo '<p>' . __( 'This example keeps WordPress from executing the <code>wpautop</code> filter on the line breaks. The default is <code>true</code> which means it wraps line breaks with an HTML <code>p</code> tag.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   254
        echo '<pre><code>function filter_textarea_wpautop( $content, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   255
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   256
  /* only run the filter on the textarea with a field ID of my_textarea */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   257
  if ( $field_id == \'my_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   258
    return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   259
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   260
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   261
  return $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   262
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   263
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   264
add_filter( \'ot_wpautop\', \'filter_textarea_wpautop\', 10, 1 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   265
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   266
        echo '<p>' . __( 'This example keeps WordPress from executing the <code>media_buttons</code> filter on the textarea WYSIWYG. The default is <code>true</code> which means show the buttons.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   267
        echo '<pre><code>function filter_textarea_media_buttons( $content, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   268
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   269
  /* only run the filter on the textarea with a field ID of my_textarea */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   270
  if ( $field_id == \'my_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   271
    return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   272
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   273
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   274
  return $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   275
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   276
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   277
add_filter( \'ot_media_buttons\', \'filter_textarea_media_buttons\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   278
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   279
        echo '<p>' . __( 'This example keeps WordPress from executing the <code>tinymce</code> filter on the textarea WYSIWYG. The default is <code>true</code> which means show the tinymce.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   280
        echo '<pre><code>function filter_textarea_tinymce( $content, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   281
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   282
  /* only run the filter on the textarea with a field ID of my_textarea */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   283
  if ( $field_id == \'my_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   284
    return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   285
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   286
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   287
  return $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   288
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   289
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   290
add_filter( \'ot_tinymce\', \'filter_textarea_tinymce\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   291
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   292
        echo '<p>' . __( 'This example alters the <code>quicktags</code> filter on the textarea WYSIWYG. The default is <code>array( \'buttons\' => \'strong,em,link,block,del,ins,img,ul,ol,li,code,spell,close\' )</code> which means show those quicktags. It also means you can filter in your own custom quicktags.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   293
        echo '<pre><code>function filter_textarea_quicktags( $content, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   294
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   295
  /* only run the filter on the textarea with a field ID of my_textarea */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   296
  if ( $field_id == \'my_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   297
    return array( \'buttons\' => \'strong,em,link,block,del,ins,img,ul,ol,li,code,more,spell,close,fullscreen\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   298
  } else if ( $field_id == \'my_other_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   299
    return false; /* show no quicktags */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   300
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   301
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   302
  return $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   303
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   304
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   305
add_filter( \'ot_quicktags\', \'filter_textarea_quicktags\', 10, 1 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   306
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   307
        echo '<h4>'. __( 'Textarea Simple', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   308
        echo '<p>' . __( 'The Textarea Simple option type is a large string value used for custom code or text in the theme. The new Textarea Simple does not have a WYSIWYG editor. But you can still filter on <code>wpautop</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   309
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   310
        echo '<p class="aside">' . __( 'This example tells WordPress to execute the <code>wpautop</code> filter on the line breaks. The default is <code>false</code> which means it does not wraps line breaks with an HTML <code>p</code> tag. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   311
        echo '<pre><code>function filter_textarea_simple_wpautop( $content, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   312
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   313
  /* only run the filter on the textarea with a field ID of my_textarea */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   314
  if ( $field_id == \'my_textarea\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   315
    return true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   316
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   317
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   318
  return $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   319
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   320
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   321
add_filter( \'ot_wpautop\', \'filter_textarea_simple_wpautop\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   322
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   323
        echo '<h4>'. __( 'Textblock', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   324
        echo '<p>' . __( 'The Textblock option type is used only on the Theme Option page. It will allow you to create & display HTML on your Theme Options page but has no title above the text block. You can then use the Textblock to add a more detailed set of instruction on how the options are used in your theme. You would NEVER use this in your themes template files as it does not save a value.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   325
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   326
        echo '<h4>'. __( 'Textblock Titled', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   327
        echo '<p>' . __( 'The Textblock Titled option type is used only on the Theme Option page. It will allow you to create & display HTML on your Theme Options page and has a title above the text block. You can then use the Textblock Titled to add a more detailed set of instruction on how the options are used in your theme. You would NEVER use this in your themes template files as it does not save a value.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   328
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   329
        echo '<h4>'. __( 'Typography', 'option-tree' ) . ':</h4>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   330
        echo '<p>' . __( 'The Typography option type is for adding typographic styles to your theme either dynamically via the CSS option type below or manually with <code>ot_get_option()</code>. Typography has filters that allow you to change the defaults. For example, you can filter on <code>ot_recognized_font_styles</code>, <code>ot_recognized_font_weights</code>, <code>ot_recognized_font_variants</code>, and <code>ot_recognized_font_families</code>. These filters allow you to fine tune the select lists for your specific CSS needs. The most important one though is <code>ot_recognized_font_families</code> as you can add your Google Fonts to create custom font stacks.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   331
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   332
        echo '<p class="aside">' . __( 'This example would filter <code>ot_recognized_font_families</code> to build your own font stack. Added to <code>functions.php</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   333
        echo '<pre><code>function filter_ot_recognized_font_families( $array, $field_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   334
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   335
  /* only run the filter when the field ID is my_google_fonts_headings */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   336
  if ( $field_id == \'my_google_fonts_headings\' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   337
    $array = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   338
      \'sans-serif\'    => \'sans-serif\',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   339
      \'open-sans\'     => \'"Open Sans", sans-serif\',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   340
      \'droid-sans\'    => \'"Droid Sans", sans-serif\'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   341
    );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   342
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   343
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   344
  return $array;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   345
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   346
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   347
add_filter( \'ot_recognized_font_families\', \'filter_ot_recognized_font_families\', 10, 2 );</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   348
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   349
        echo '<h4>'. __( 'Upload', 'option-tree' ) . ':</h4>'; 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   350
        echo '<p>' . __( 'The Upload option type is used to upload any WordPress supported media. After uploading, users are required to press the "Send to OptionTree" button in order to populate the input with the URI of that media. There is one caveat of this feature. If you import the theme options and have uploaded media on one site the old URI will not reflect the URI of your new site. You\'ll have to re-upload or FTP any media to your new server and change the URIs if necessary.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   351
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   352
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   353
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   354
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   355
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   356
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   357
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   358
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   359
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   360
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   361
 * ot_get_option() option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   362
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   363
 * This is a callback function to display text about ot_get_option().
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   364
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   365
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   366
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   367
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   368
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   369
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   370
if ( ! function_exists( 'ot_type_ot_get_option' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   371
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   372
  function ot_type_ot_get_option() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   373
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   374
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   375
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   376
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   377
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   378
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   379
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   380
        echo '<h4>'. __( 'Description', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   381
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   382
        echo '<p>' . __( 'This function returns a value from the "option_tree" array of saved values or the default value supplied. The returned value would be mixed. Meaning it could be a string, integer, boolean, or array.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   383
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   384
        echo '<h4>' . __( 'Usage', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   385
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   386
        echo '<p><code>&lt;?php ot_get_option( $option_id, $default ); ?&gt;</code></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   387
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   388
        echo '<h4>' . __( 'Parameters', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   389
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   390
        echo '<code>$option_id</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   391
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   392
        echo '<p>(<em>' . __( 'string', 'option-tree' ) . '</em>) (<em>' . __( 'required', 'option-tree' ) . '</em>) ' . __( 'Enter the options unique identifier.', 'option-tree' ) . '<br />' . __( 'Default:', 'option-tree' ) . ' <em>' . __( 'None', 'option-tree' ) . '</em></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   393
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   394
        echo '<code>$default</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   395
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   396
        echo '<p>(<em>' . __( 'string', 'option-tree' ) . '</em>) (<em>' . __( 'optional', 'option-tree' ) . '</em>) ' . __( 'Enter a default return value. This is just incase the request returns null.', 'option-tree' ) . '<br />' . __( 'Default', 'option-tree' ) . ': <em>' . __( 'None', 'option-tree' ) . '</em></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   397
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   398
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   399
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   400
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   401
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   402
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   403
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   404
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   405
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   406
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   407
 * get_option_tree() option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   408
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   409
 * This is a callback function to display text about get_option_tree().
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   410
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   411
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   412
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   413
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   414
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   415
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   416
if ( ! function_exists( 'ot_type_get_option_tree' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   417
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   418
  function ot_type_get_option_tree() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   419
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   420
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   421
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   422
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   423
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   424
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   425
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   426
        echo '<p class="deprecated">' . __( 'This function has been deprecated. That means it has been replaced by a new function or is no longer supported, and may be removed from future versions. All code that uses this function should be converted to use its replacement.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   427
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   428
        echo '<p>' . __( 'Use', 'option-tree' ) . '<code>ot_get_option()</code>' . __( 'instead', 'option-tree' ) . '.</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   429
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   430
        echo '<h4>'. __( 'Description', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   431
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   432
        echo '<p>' . __( 'This function returns, or echos if asked, a value from the "option_tree" array of saved values.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   433
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   434
        echo '<h4>' . __( 'Usage', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   435
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   436
        echo '<p><code>&lt;?php get_option_tree( $item_id, $options, $echo, $is_array, $offset ); ?&gt;</code></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   437
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   438
        echo '<h4>' . __( 'Parameters', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   439
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   440
        echo '<code>$item_id</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   441
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   442
        echo '<p>(<em>' . __( 'string', 'option-tree' ) . '</em>) (<em>' . __( 'required', 'option-tree' ) . '</em>) ' . __( 'Enter a unique Option Key to get a returned value or array.', 'option-tree' ) . '<br />' . __( 'Default:', 'option-tree' ) . ' <em>' . __( 'None', 'option-tree' ) . '</em></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   443
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   444
        echo '<code>$options</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   445
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   446
        echo '<p>(<em>' . __( 'array', 'option-tree' ) . '</em>) (<em>' . __( 'optional', 'option-tree' ) . '</em>) ' . __( 'Used to cut down on database queries in template files.', 'option-tree' ) . '<br />' . __( 'Default', 'option-tree' ) . ': <em>' . __( 'None', 'option-tree' ) . '</em></p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   447
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   448
        echo '<code>$echo</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   449
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   450
        echo '<p>(<em>' . __( 'boolean', 'option-tree' ) . '</em>) (<em>' . __( 'optional', 'option-tree' ) . '</em>) ' . __( 'Echo the output.', 'option-tree' ) . '<br />' . __( 'Default', 'option-tree' ) . ': FALSE</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   451
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   452
        echo '<code>$is_array</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   453
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   454
        echo '<p>(<em>' . __( 'boolean', 'option-tree' ) . '</em>) (<em>' . __( 'optional', 'option-tree' ) . '</em>) ' . __( 'Used to indicate the $item_id is an array of values.', 'option-tree' ) . '<br />' . __( 'Default', 'option-tree' ) . ': FALSE</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   455
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   456
        echo '<code>$offset</code>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   457
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   458
        echo '<p>(<em>' . __( 'integer', 'option-tree' ) . '</em>) (<em>' . __( 'optional', 'option-tree' ) . '</em>) ' . __( 'Numeric offset key for the $item_id array, -1 will return all values (an array starts at 0).', 'option-tree' ) . '<br />' . __( 'Default', 'option-tree' ) . ': -1</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   459
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   460
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   461
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   462
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   463
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   464
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   465
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   466
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   467
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   468
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   469
 * Examples option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   470
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   471
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   472
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   473
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   474
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   475
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   476
if ( ! function_exists( 'ot_type_examples' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   477
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   478
  function ot_type_examples() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   479
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   480
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   481
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   482
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   483
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   484
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   485
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   486
        echo '<p class="aside">' . __( 'If you\'re using the plugin version of OptionTree it is highly recommended to include a <code>function_exists</code> check in your code, as described in the examples below. If you\'ve integrated OptionTree directly into your themes root directory, you will <strong>not</strong> need to wrap your code with <code>function_exists</code>, as you\'re guaranteed to have the <code>ot_get_option()</code> function available.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   487
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   488
        echo '<h4>' . __( 'String Examples', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   489
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   490
        echo '<p>' . __( 'Returns the value of <code>test_input</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   491
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   492
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   493
  $test_input = ot_get_option( \'test_input\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   494
}</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   495
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   496
        echo '<p>' . __( 'Returns the value of <code>test_input</code>, but also has a default value if it returns empty.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   497
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   498
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   499
  $test_input = ot_get_option( \'test_input\', \'default input value goes here.\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   500
}</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   501
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   502
        echo '<h4>' . __( 'Array Examples', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   503
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   504
        echo '<p>' . __( 'Assigns the value of <code>navigation_ids</code> to the variable <code>$ids</code>. It then echos an unordered list of links (navigation) using <code>wp_list_pages()</code>.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   505
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   506
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   507
  /* get an array of page id\'s */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   508
  $ids = ot_get_option( \'navigation_ids\', array() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   509
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   510
  /* echo custom navigation using wp_list_pages() */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   511
  if ( ! empty( $ids ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   512
    echo \'&lt;ul&gt;\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   513
    wp_list_pages(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   514
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   515
        \'include\'   => $ids,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   516
        \'title_li\'  => \'\'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   517
      )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   518
    );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   519
    echo \'&lt;/ul&gt;\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   520
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   521
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   522
}</code></pre>';   
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   523
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   524
        echo '<p>' . __( 'The next two examples demonstrate how to use the <strong>Measurement</strong> option type. The Measurement option type is an array with two key/value pairs. The first is the value of measurement and the second is the unit of measurement.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   525
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   526
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   527
  /* get the array */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   528
  $measurement = ot_get_option( \'measurement_option_type_id\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   529
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   530
  /* only echo values if they actually exist, else echo some default value */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   531
  if ( isset( measurement[0] ) && $measurement[1] ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   532
    echo $measurement[0].$measurement[1];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   533
  } else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   534
    echo \'10px\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   535
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   536
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   537
}</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   538
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   539
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   540
  /* get the array, and have a default just incase */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   541
  $measurement = ot_get_option( \'measurement_option_type_id\', array( \'10\', \'px\' ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   542
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   543
  /* implode array into a string value */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   544
  if ( ! empty( measurement ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   545
    echo implode( \'\', $measurement );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   546
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   547
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   548
}</code></pre>';    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   549
          
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   550
        echo '<p>' . __( 'This example displays a very basic slider loop.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   551
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   552
        echo '<pre><code>if ( function_exists( \'ot_get_option\' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   553
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   554
  /* get the slider array */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   555
  $slides = ot_get_option( \'my_slider\', array() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   556
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   557
  if ( ! empty( $slides ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   558
    foreach( $slides as $slide ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   559
      echo \'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   560
      &lt;li&gt;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   561
        &lt;a href="\' . $slide[\'link\'] . \'"&gt;&lt;img src="\' . $slide[\'image\'] . \'" alt="\' . $slide[\'title\'] . \'" /&gt;&lt;/a&gt;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   562
        &lt;div class="description">\' . $slide[\'description\'] . \'&lt;/div&gt;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   563
      &lt;/li&gt;\';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   564
    }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   565
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   566
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   567
}</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   568
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   569
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   570
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   571
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   572
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   573
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   574
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   575
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   576
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   577
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   578
 * Layouts Overview option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   579
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   580
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   581
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   582
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   583
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   584
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   585
if ( ! function_exists( 'ot_type_layouts_overview' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   586
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   587
  function ot_type_layouts_overview() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   588
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   589
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   590
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   591
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   592
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   593
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   594
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   595
        echo '<h4>'. __( 'It\'s Super Simple', 'option-tree' ) . '</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   596
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   597
        echo '<p>' . __( 'Layouts make your theme awesome! With theme options data that you can save/import/export you can package themes with different color variations, or make it easy to do A/B testing on text and so much more. Basically, you save a snapshot of your data as a layout.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   598
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   599
        echo '<p>' . __( 'Once you have created all your different layouts, or theme variations, you can save them to a separate text file for repackaging with your theme. Alternatively, you could just make different variations for yourself and change your theme with the click of a button, all without deleting your previous options data.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   600
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   601
        echo '<p class="aside">' . __( ' Adding a layout is ridiculously easy, follow these steps and you\'ll be on your way to having a WordPress super theme.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   602
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   603
        echo '<h4>' . __( 'For Developers', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   604
        echo '<p>' . __( '', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   605
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   606
        echo '<h5>' . __( 'Creating a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   607
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   608
          echo '<li>'. __( 'Go to the <code>OptionTre->Settings->Layouts</code> tab.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   609
          echo '<li>' . __( 'Enter a name for your layout in the text field and hit "Save Layouts", you\'ve created your first layout.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   610
          echo '<li>' . __( 'Adding a new layout is as easy as repeating the steps above.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   611
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   612
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   613
        echo '<h5>' . __( 'Activating a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   614
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   615
          echo '<li>'. __( 'Go to the <code>OptionTre->Settings->Layouts</code> tab.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   616
          echo '<li>' . __( 'Click on the activate layout button in the actions list.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   617
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   618
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   619
        echo '<h5>' . __( 'Deleting a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   620
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   621
          echo '<li>'. __( 'Go to the <code>OptionTre->Settings->Layouts</code> tab.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   622
          echo '<li>' . __( 'Click on the delete layout button in the actions list.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   623
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   624
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   625
        echo '<h5>' . __( 'Edit Layout Data', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   626
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   627
          echo '<li>'. __( 'Go to the <code>Appearance->Theme Options</code> page.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   628
          echo '<li>' . __( 'Modify and save your theme options and the layout will be updated automatically.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   629
          echo '<li>' . __( 'Saving theme options data will update the currently active layout, so before you start saving make sure you want to modify the current layout.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   630
          echo '<li>' . __( 'If you want to edit a new layout, first create it then save your theme options.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   631
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   632
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   633
        echo '<h4>' . __( 'End-Users Mode', 'option-tree' ) . ':</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   634
        echo '<p>' . __( '', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   635
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   636
        echo '<h5>' . __( 'Creating a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   637
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   638
          echo '<li>'. __( 'Go to the <code>Appearance->Theme Options</code> page.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   639
          echo '<li>' . __( 'Enter a name for your layout in the text field and hit "New Layout", you\'ve created your first layout.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   640
          echo '<li>' . __( 'Adding a new layout is as easy as repeating the steps above.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   641
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   642
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   643
        echo '<h5>' . __( 'Activating a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   644
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   645
          echo '<li>'. __( 'Go to the <code>Appearance->Theme Options</code> page.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   646
          echo '<li>' . __( 'Choose a layout from the select list and click the "Activate Layout" button.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   647
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   648
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   649
        echo '<h5>' . __( 'Deleting a Layout', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   650
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   651
          echo '<li>'. __( 'End-Users mode does not allow deleting layouts.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   652
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   653
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   654
        echo '<h5>' . __( 'Edit Layout Data', 'option-tree' ) . ':</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   655
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   656
          echo '<li>'. __( 'Go to the <code>Appearance->Theme Options</code> tab.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   657
          echo '<li>' . __( 'Modify and save your theme options and the layout will be updated automatically.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   658
          echo '<li>' . __( 'Saving theme options data will update the currently active layout, so before you start saving make sure you want to modify the current layout.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   659
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   660
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   661
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   662
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   663
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   664
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   665
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   666
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   667
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   668
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   669
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   670
 * Meta Boxes option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   671
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   672
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   673
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   674
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   675
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   676
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   677
if ( ! function_exists( 'ot_type_meta_boxes' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   678
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   679
  function ot_type_meta_boxes() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   680
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   681
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   682
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   683
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   684
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   685
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   686
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   687
        echo '<h4>'. __( 'How-to-guide', 'option-tree' ) . '</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   688
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   689
        echo '<p>' . __( 'There are a few simple steps you need to take in order to use OptionTree\'s built in Meta Box API. In the code below I\'ll show you a basic demo of how to create your very own custom meta box using any number of the option types you have at your disposal. If you would like to see some demo code, there is a directory named <code>theme-mode</code> inside the <code>assets</code> directory that contains a file named <code>demo-meta-boxes.php</code> you can reference.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   690
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   691
        echo '<p>' . __( 'It\'s important to note that Meta Boxes do not support WYSIWYG editors at this time and if you set one of your options to Textarea it will automatically revert to a Textarea Simple until a valid solution is found. WordPress released this statement regarding the wp_editor() function:', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   692
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   693
        echo '<blockquote>' . __( 'Once instantiated, the WYSIWYG editor cannot be moved around in the DOM. What this means in practical terms, is that you cannot put it in meta-boxes that can be dragged and placed elsewhere on the page.', 'option-tree' ) . '</blockquote>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   694
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   695
        echo '<h5>' . __( 'Create and include your custom meta boxes file.', 'option-tree' ) . '</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   696
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   697
          echo '<li>'. __( 'Create a file and name it anything you want, maybe <code>meta-boxes.php</code>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   698
          echo '<li>'. __( 'As well, you\'ll probably want to create a directory named <code>includes</code> to put your <code>meta-boxes.php</code> into which will help keep you file structure nice and tidy.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   699
          echo '<li>' . __( 'Add the following code to your <code>functions.php</code>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   700
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   701
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   702
        echo '<pre><code>/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   703
 * Meta Boxes
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   704
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   705
load_template( trailingslashit( get_template_directory() ) . \'includes/meta-boxes.php\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   706
</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   707
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   708
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   709
          echo '<li>' . __( 'Add a variation of the following code to your <code>meta-boxes.php</code>. You\'ll obviously need to fill it in with all your custom array values. It\'s important to note here that we use the <code>admin_init</code> filter because if you were to call the <code>ot_register_meta_box</code> function before OptionTree was loaded the sky would fall on your head.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   710
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   711
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   712
        echo "<pre><code>/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   713
 * Initialize the meta boxes. 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   714
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   715
add_action( 'admin_init', 'custom_meta_boxes' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   716
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   717
function custom_meta_boxes() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   718
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   719
  &#36;my_meta_box = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   720
    'id'        => 'my_meta_box',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   721
    'title'     => 'My Meta Box',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   722
    'desc'      => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   723
    'pages'     => array( 'post' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   724
    'context'   => 'normal',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   725
    'priority'  => 'high',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   726
    'fields'    => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   727
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   728
        'id'          => 'background',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   729
        'label'       => 'Background',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   730
        'desc'        => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   731
        'std'         => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   732
        'type'        => 'background',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   733
        'class'       => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   734
        'choices'     => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   735
      )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   736
    )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   737
  );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   738
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   739
  ot_register_meta_box( &#36;my_meta_box );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   740
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   741
}</code></pre>";  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   742
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   743
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   744
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   745
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   746
    
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   747
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   748
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   749
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   750
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   751
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   752
 * Theme Mode option type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   753
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   754
 * @return    string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   755
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   756
 * @access    public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   757
 * @since     2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   758
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   759
if ( ! function_exists( 'ot_type_theme_mode' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   760
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   761
  function ot_type_theme_mode() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   762
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   763
    /* format setting outer wrapper */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   764
    echo '<div class="format-setting type-textblock wide-desc">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   765
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   766
      /* description */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   767
      echo '<div class="description">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   768
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   769
        echo '<h4>'. __( 'How-to-guide', 'option-tree' ) . '</h4>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   770
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   771
        echo '<p>' . __( 'There are a few simple steps you need to take in order to use OptionTree as a theme included module. In the code below I\'ll show you a basic demo of how to include the entire plugin as a module, which will allow you to have the most up-to-date version of OptionTree without ever needing to hack the core of the plugin. If you would like to see some demo code, there is a directory named <code>theme-mode</code> inside the <code>assets</code> directory that contains a file named <code>demo-theme-options.php</code> you can reference.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   772
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   773
        echo '<h5>' . __( 'Step 1: Include the plugin & turn on theme mode.', 'option-tree' ) . '</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   774
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   775
          echo '<li>'. __( 'Download the latest version of <a href="http://wordpress.org/extend/plugins/option-tree/" rel="nofollow" target="_blank">OptionTree</a>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   776
          echo '<li>' . __( 'Unpack the ZIP archive.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   777
          echo '<li>' . __( 'Put the <code>option-tree</code> directory in the root of your theme. For example, the server path would be <code>/wp-content/themes/theme-name/option-tree/</code>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   778
          echo '<li>' . __( 'Add the following code to the beginning of your <code>functions.php</code>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   779
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   780
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   781
        echo '<pre><code>/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   782
 * Optional: set \'ot_show_pages\' filter to false.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   783
 * This will hide the settings & documentation pages.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   784
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   785
add_filter( \'ot_show_pages\', \'__return_false\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   786
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   787
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   788
 * Optional: set \'ot_show_new_layout\' filter to false.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   789
 * This will hide the "New Layout" section on the Theme Options page.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   790
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   791
add_filter( \'ot_show_new_layout\', \'__return_false\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   792
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   793
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   794
 * Required: set \'ot_theme_mode\' filter to true.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   795
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   796
add_filter( \'ot_theme_mode\', \'__return_true\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   797
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   798
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   799
 * Required: include OptionTree.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   800
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   801
load_template( trailingslashit( get_template_directory() ) . \'option-tree/ot-loader.php\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   802
</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   803
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   804
        echo '<p class="aside">' . __( 'It\'s that simple! You now have OptionTree built into your theme and anytime there\'s an update to the plugin you just replace the old version and you\'re good to go..', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   805
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   806
        echo '<h5>' . __( 'Step 2: Create Theme Options without using the UI Builder.', 'option-tree' ) . '</h5>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   807
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   808
          echo '<li>'. __( 'Create a file and name it anything you want, maybe <code>theme-options.php</code>, or use the built in file export to create it for you. Remember, you should always check the file for errors before including it in your theme.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   809
          echo '<li>'. __( 'As well, you\'ll probably want to create a directory named <code>includes</code> to put your <code>theme-options.php</code> into which will help keep you file structure nice and tidy.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   810
          echo '<li>' . __( 'Add the following code to your <code>functions.php</code>.', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   811
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   812
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   813
        echo '<pre><code>/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   814
 * Theme Options
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   815
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   816
load_template( trailingslashit( get_template_directory() ) . \'includes/theme-options.php\' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   817
</code></pre>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   818
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   819
        echo '<ul class="docs-ul">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   820
          echo '<li>' . __( 'Add a variation of the following code to your <code>theme-options.php</code>. You\'ll obviously need to fill it in with all your custom array values for contextual help (optional), sections (required), and settings (required).', 'option-tree' ) . '</li>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   821
        echo '</ul>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   822
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   823
        echo '<p>' . __( 'The code below is a boilerplate to get your started. For a full list of the available option types click the "Option Types" tab above. Also a quick note, you don\'t need to put OptionTree in theme mode to manually create options but you will want to hide the docs and settings as each time you load the admin area the settings be written over with the code below if they\'ve changed in any way. However, this ensures your settings do not get tampered with by the end-user.', 'option-tree' ) . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   824
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   825
        echo "<pre><code>/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   826
 * Initialize the options before anything else. 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   827
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   828
add_action( 'admin_init', 'custom_theme_options', 1 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   829
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   830
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   831
 * Build the custom settings & update OptionTree.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   832
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   833
function custom_theme_options() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   834
  /**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   835
   * Get a copy of the saved settings array. 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   836
   */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   837
  &#36;saved_settings = get_option( 'option_tree_settings', array() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   838
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   839
  /**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   840
   * Custom settings array that will eventually be 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   841
   * passes to the OptionTree Settings API Class.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   842
   */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   843
  &#36;custom_settings = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   844
    'contextual_help' => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   845
      'content'       => array( 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   846
        array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   847
          'id'        => 'general_help',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   848
          'title'     => 'General',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   849
          'content'   => '&lt;p&gt;Help content goes here!&lt;/p&gt;'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   850
        )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   851
      ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   852
      'sidebar'       => '&lt;p&gt;Sidebar content goes here!&lt;/p&gt;',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   853
    ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   854
    'sections'        => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   855
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   856
        'id'          => 'general',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   857
        'title'       => 'General'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   858
      )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   859
    ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   860
    'settings'        => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   861
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   862
        'id'          => 'my_checkbox',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   863
        'label'       => 'Checkbox',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   864
        'desc'        => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   865
        'std'         => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   866
        'type'        => 'checkbox',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   867
        'section'     => 'general',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   868
        'class'       => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   869
        'choices'     => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   870
          array( 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   871
            'value' => 'yes',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   872
            'label' => 'Yes' 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   873
          )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   874
        )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   875
      ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   876
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   877
        'id'          => 'my_layout',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   878
        'label'       => 'Layout',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   879
        'desc'        => 'Choose a layout for your theme',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   880
        'std'         => 'right-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   881
        'type'        => 'radio-image',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   882
        'section'     => 'general',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   883
        'class'       => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   884
        'choices'     => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   885
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   886
            'value'   => 'left-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   887
            'label'   => 'Left Sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   888
            'src'     => OT_URL . '/assets/images/layout/left-sidebar.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   889
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   890
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   891
            'value'   => 'right-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   892
            'label'   => 'Right Sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   893
            'src'     => OT_URL . '/assets/images/layout/right-sidebar.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   894
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   895
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   896
            'value'   => 'full-width',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   897
            'label'   => 'Full Width (no sidebar)',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   898
            'src'     => OT_URL . '/assets/images/layout/full-width.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   899
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   900
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   901
            'value'   => 'dual-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   902
            'label'   => __( 'Dual Sidebar', 'option-tree' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   903
            'src'     => OT_URL . '/assets/images/layout/dual-sidebar.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   904
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   905
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   906
            'value'   => 'left-dual-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   907
            'label'   => __( 'Left Dual Sidebar', 'option-tree' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   908
            'src'     => OT_URL . '/assets/images/layout/left-dual-sidebar.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   909
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   910
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   911
            'value'   => 'right-dual-sidebar',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   912
            'label'   => __( 'Right Dual Sidebar', 'option-tree' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   913
            'src'     => OT_URL . '/assets/images/layout/right-dual-sidebar.png'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   914
          )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   915
        )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   916
      ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   917
      array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   918
        'id'          => 'my_slider',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   919
        'label'       => 'Images',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   920
        'desc'        => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   921
        'std'         => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   922
        'type'        => 'list-item',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   923
        'section'     => 'general',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   924
        'class'       => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   925
        'choices'     => array(),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   926
        'settings'    => array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   927
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   928
            'id'      => 'slider_image',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   929
            'label'   => 'Image',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   930
            'desc'    => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   931
            'std'     => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   932
            'type'    => 'upload',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   933
            'class'   => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   934
            'choices' => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   935
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   936
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   937
            'id'      => 'slider_link',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   938
            'label'   => 'Link to Post',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   939
            'desc'    => 'Enter the posts url.',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   940
            'std'     => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   941
            'type'    => 'text',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   942
            'class'   => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   943
            'choices' => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   944
          ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   945
          array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   946
            'id'      => 'slider_description',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   947
            'label'   => 'Description',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   948
            'desc'    => 'This text is used to add fancy captions in the slider.',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   949
            'std'     => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   950
            'type'    => 'textarea',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   951
            'class'   => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   952
            'choices' => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   953
          )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   954
        )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   955
      )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   956
    )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   957
  );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   958
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   959
  /* settings are not the same update the DB */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   960
  if ( &#36;saved_settings !== &#36;custom_settings ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   961
    update_option( 'option_tree_settings', &#36;custom_settings ); 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   962
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   963
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   964
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   965
</code></pre>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   966
        
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   967
      echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   968
      
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   969
    echo '</div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   970
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   971
  }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   972
  
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   973
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   974
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   975
/* End of file ot-functions-docs-page.php */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   976
/* Location: ./includes/ot-functions-docs-page.php */