alekhen/intoor-lib

Wordpress Theme Functionality

Интоор Library

"If a Wordpress theme was a cherry then the Интоор Library is the pit.", _(*1)

This library can and should be used as the backbone of your Wordpress theme development. It provides additional levels of functionality not currently built into the core Wordpress CMS and allows you as a theme developer to quickly extend the Wordpress Admin., _(*2)

It may be helpful to know that Интоор [ɪn.ˈtɔːr], pronounced in-tor, is the Mongolian word for 'Cherry' and is commonly Romanized as Intoor., _(*3)

NOTE: This project is still in its infancy so changes and updates will come fast and often so stay tuned., _(*4)

Key Features

• Create admin menus, custom post types, custom meta boxes, database tables, and much more simply with arrays
• Email mailing list creation and management
• Popularity tracking including page views, likes, and shares
• Google Analytics integration
• Secure data encryption

Requirements

• PHP v5.5 or later
• Mcrypt
• Wordpress 4.0 or later

Installation

1. Navigate to your Wordpress theme directory and create a new sub-directory called 'lib'. Note: You can call the new sub-directory anything you want just be sure to complete installation step 5., _(*5)

   $ cd yoursite.com/wp-content/themes/yourtheme/
   $ mkdir lib
   $ cd lib
   

2. Initialize git and clone this repo into the lib/ directory you created in step 1., _(*6)

   $ git init
   $ git remote add origin git@github.com:Alekhen/intoor-lib.git
   $ git fetch
   $ git checkout -t origin/master
   

3. Create a configuration file unique to your project called config.php by copying config-sample.php. Note: Do not change files directly in the Интоор Library other than config.php or else you run the risk of major conflicts if you ever want to update the library in the future., _(*7)

   $ cp config-sample.php config.php
   

4. Update the configuration file you created in step 3 with unique phrases to keep your data secure. Feel free to use keys generated by Wordpress.org's secret-key service if you'd like: https://api.wordpress.org/secret-key/1.1/salt/, _(*8)

   define( 'INTOOR_API_KEY', 'put your unique phrase here' );
   define( 'INTOOR_MAIL_KEY', 'put your unique phrase here' );
   

5. [Optional] If you called the Интоор Library directory something other than 'lib', make sure to update the INTOOR_DIR_NAME definition in the config.php file you created in step 3., _(*9)

   define( 'INTOOR_DIR_NAME', 'lib' );
   

6. Connect the Интоор Library to your Wordpress theme by including lib/config.php at the beginning of your theme's functions.php file., _(*10)

   require_once dirname( __FILE__ ) . "/lib/config.php";
   

7. [Optional] Add the lib/ directory to your theme's .gitignore file. This prevents a copy of the Интоор Library from being stored in your theme's git repo., _(*11)

Updating Instructions

1. Navigate to the lib/ directory inside your Wordpress theme and run a git pull to retrieve the updated and modified project files., _(*12)

   $ cd yoursite.com/wp-content/themes/yourtheme/lib/
   $ git pull
   

2. Update your lib/config.php file with the current version., _(*13)

   define( 'INTOOR_LIB_VERSION', '1.2' );
   

Change Log

v1.2 - Current Version

• Setup and configuration refactor

v1.1

• PHP v5.5 progressive refactor (dropped support for PHP v5.3)
• Mailing List, Popular, & Social API refactor

v1.0

• Initial file structure (config, paths, etc)
• Database, encryption, and general function classes that manage interaction with $wpdb
• Admin Menu class to create WP admin menu pages
• Post Type class to create custom post types
• Mailing List - WP admin menu, mailing list API, HTML subscribe & unsubscribe emails, CSV generation
• Popular Tracking - Views and likes API
• Social Network Integration

License

Copyright © 2014, Hazard Media Group LLC, _(*14)

• MIT License

Development

• Source hosted at GitHub.

Author

Colton James Wiscombe, _(*15)