Skip to content

Enhancements and clean up #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shawcohn wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Enhancements and clean up #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84d0e21
added function to trigger actions for each action being executed in t…
Oct 26, 2014
d4b4a9d
added the get_data function to return all of the cheezcap options at …
Oct 26, 2014
24d0cbd
Converted the README.txt file to a README.md file and added info abou…
Oct 26, 2014
9bea9bc
removed errors detected by phpcs using WordPress.com VIP standard
Oct 26, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 42 additions & 19 deletions README.txt → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
/**
* CheezCap - Cheezburger Custom Administration Panel
* (c) 2008 - 2011 Cheezburger Network (Pet Holdings, Inc.)
* LOL: http://cheezburger.com
* Source: http://github.com/cheezburger/cheezcap/
* Authors: Kyall Barrows, Toby McKes, Stefan Rusek, Scott Porad
* UnLOLs by Mo Jangda (batmoo@gmail.com)
* License: GNU General Public License, version 2 (GPL), http://www.gnu.org/licenses/gpl-2.0.html
*/
CheezCap - Cheezburger Custom Administration Panel
================
* CheezCap - Cheezburger Custom Administration Panel
* (c) 2008 - 2011 Cheezburger Network (Pet Holdings, Inc.)
* LOL: http://cheezburger.com
* Source: http://github.com/cheezburger/cheezcap/
* Authors: Kyall Barrows, Toby McKes, Stefan Rusek, Scott Porad
* UnLOLs by Mo Jangda (batmoo@gmail.com)
* License: GNU General Public License, version 2 (GPL), http://www.gnu.org/licenses/gpl-2.0.html


This is a fork of the original CheezCap developed by the fine Cheez-loving Cats over at ICHC. In has various bits of cleanup, the biggest being that it can be shared across multiple themes.

Expand All @@ -20,24 +21,24 @@ The fork lives at https://github.com/mjangda/cheezcap

1. Copy the cheezcap folder into an appropriate location (maybe where you store your other shared plugins).
2. Add the following line to functions.php (if you don't have a functions.php, create one in your theme directory). Adjust the path as needed.

require_once( WP_PLUGINS_DIR . '/cheezcap/cheezcap.php');

<br/><br/><pre><code>
require_once( WP_PLUGINS_DIR . '/cheezcap/cheezcap.php');
</code></pre><br/>
3. Use the included config-sample.php as a starting point to set up your options. Copy the modified version into your theme and include it.

require_once( dirname( __FILE__ ) . '/cheezcap-config.php');

<br/><br/><pre><code>
require_once( dirname( __FILE__ ) . '/cheezcap-config.php');
</code></pre><br/>
4. Sprinkle theme options around your code, like this:

<br/><br/><pre><code>
global $cap;
if ($cap->my_boolean_option) {
// do stuff
}

</code></pre><br/>
4b. Or use the helper function

<br/><br/><pre><code>
cheezcap_get_option( 'my_boolean_option', true, 'esc_html' );

</code></pre><br/>
5. Enjoy!


Expand Down Expand Up @@ -149,3 +150,25 @@ CheezCap makes it easy to access the values that are set in your custom admin pa
You can use the built-in helper function:

cheezcap_get_option( $option, $echo = false, $sanitize_callback = '' )

##
## Actions
##

Below are all of the actions you can hook in to:

* cheezcap_update
* cheezcap_reset
* cheezcap_export
* cheezcap_import

##
## Methods
##

Calling the get_data method returns all of the input.

```
$data_arr = $cap->get_data();
```

Loading