Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
code formatting
  • Loading branch information
adeojonathan committed May 24, 2015
1 parent 178cbe9 commit b9d973a
Showing 1 changed file with 27 additions and 53 deletions.
80 changes: 27 additions & 53 deletions multiloquent-base.php
Expand Up @@ -26,7 +26,7 @@ function __construct() {

/**
* Returns the current multiloquent version number
*
*
* @internal internal
* @return string
*/
Expand All @@ -37,9 +37,8 @@ function multiloquent_version() {

/**
* various register actions
*
*
* @internal internal
*
*/
function multiloquent_register() {
// theme support
Expand Down Expand Up @@ -109,7 +108,7 @@ function multiloquent_register() {

/**
* adds the featured image to the rss feed
*
*
* @internal internal
* @param string $content
* @return string
Expand All @@ -129,13 +128,11 @@ function multiloquent_featured_image_in_feed($content) {

/**
* includes the name of the php file passed.
*
* - includes the name of the php file passed. Uses require_once().
* - limitations: cant pass the file extension, only includes php files.
* - eg: multiloquent_get_template_part('somefile'); to include somefile.php
*
* @api
*
*
* @param string $file
* name of file to include, excluding .php extension
* @global object $post the wordpress post object
Expand All @@ -148,9 +145,8 @@ function multiloquent_get_template_part($file) {

/**
* adds the multiloquent custom controls for wp customise api
*
* @api
*
*
* @param object $wp_customize
*/
function multiloquent_customize_register($wp_customize) {
Expand All @@ -171,9 +167,8 @@ function multiloquent_customize_register($wp_customize) {

/**
* registers and generates the custom controls for wp customise api
*
*
* @internal internal
*
* @see multiloquent_customize_register();
* @param string $setting_type
* @param string $setting_name
Expand Down Expand Up @@ -244,7 +239,7 @@ function multiloquent_register_and_generate_custom_control($setting_type, $setti
* ie, if bootswatch is set to 'darkly' and the multiloquent_navbar is set to the default value, show it
* or if the bootswatch is set to the default value and the multiloquent_navbar is not the default value, show it
* or if the bootswatch is set to the default value and the multiloquent_navbar is the default value, dont show it
*
*
* @param string $item
* @param string $default_value
* @param array $mods
Expand All @@ -260,9 +255,8 @@ function multiloquent_check_theme_mod_colour($item, $default_value, $mods) {

/**
* outputs the custom css for the wp customise API
*
*
* @internal internal
*
* @todo make this return, rather than echo
*/
function multiloquent_customize_css() {
Expand Down Expand Up @@ -321,12 +315,10 @@ function multiloquent_customize_css() {

/**
* enqueue the required javascript libraries.
*
* - menu.js - custom built menu javascript for pop out menu
* - bootstrap javascript library
*
*
* @internal internal
*
*/
function multiloquent_scripts_method() {
wp_enqueue_script('menu', get_template_directory_uri() . '/menu.js', array(
Expand All @@ -339,14 +331,12 @@ function multiloquent_scripts_method() {

/**
* enqueue the stylesheets
*
* - bootstrap css
* - font awesome css
* - style css [WordPress required with custom overrides for bootstrap]
* - print css [custom overrides for printing]
*
*
* @internal internal
*
*/
function multiloquent_stylesheet_method() {
// todo - make is use the default one if none are set
Expand All @@ -366,9 +356,8 @@ function multiloquent_stylesheet_method() {

/**
* registers the WordPress menu location
*
*
* @internal internal
*
*/
function multiloquent_menu() {
register_nav_menu('primary-menu', 'Primary Menu');
Expand Down Expand Up @@ -406,9 +395,8 @@ function multiloquent_generate_sidebars() {

/**
* removes css classes from the passed string
*
* @api
*
*
* @param array $classes
* @return array
*/
Expand All @@ -421,9 +409,8 @@ function multiloquent_remove_hentry_function($classes) {

/**
* adds a css class to the tag
*
* @api
*
*
* @param string $html
* @return string
*/
Expand All @@ -434,7 +421,7 @@ function multiloquent_add_class_the_tags($html) {

/**
* generates a tag cloud
*
*
* @param array $args
* @return array
* @internal internal
Expand All @@ -450,9 +437,8 @@ function multiloquent_widget_tag_cloud_args($args) {

/**
* wrapper for the post title, if it has no title, supply one
*
* @api
*
*
* @param int $post_id
* @return string
* @example multiloquent_post_title(12);
Expand All @@ -471,9 +457,8 @@ function multiloquent_post_title($post_id = 0) {

/**
* wraps the tag cloud in a div
*
* @api
*
*
* @param string $tag_cloud
* @return string
*/
Expand All @@ -483,9 +468,8 @@ function multiloquent_tag_cloud_filter($tag_cloud) {

/**
* outputs the breadcrumb
*
* @api
*
*
* @return string
*/
function multiloquent_breadcrumbs() {
Expand Down Expand Up @@ -527,9 +511,8 @@ function multiloquent_breadcrumbs() {

/**
* renders the pagination on the page
*
* @api
*
*
* @todo make this return rather than echo
*/
function multiloquent_render_pagingation() {
Expand Down Expand Up @@ -566,9 +549,8 @@ function multiloquent_render_pagingation() {

/**
* returns a random class from the list
*
* @api
*
*
* @param string $class
* @return string <string>
*/
Expand Down Expand Up @@ -630,9 +612,8 @@ function multiloquent_get_random_solid_class($class = '') {

/**
* returns a random value from the list
*
* @api
*
*
* @return string
*/
function multiloquent_get_random_blue_class() {
Expand Down Expand Up @@ -691,9 +672,8 @@ function multiloquent_get_random_blue_class() {

/**
* returns a random string from the list
*
* @api
*
*
* @param string $class
* @return string Ambigous
*/
Expand Down Expand Up @@ -755,9 +735,8 @@ function multiloquent_get_random_colour_class($class = '') {

/**
* outputs the category list as a hierarchy
*
* @api
*
*
* @param string $cat
* @return string
*/
Expand Down Expand Up @@ -821,9 +800,8 @@ function multiloquent_category_list_as_hierarchy($cat = '0') {

/**
* generates the homepage featured posts box
*
* @api
*
*
* @return string
*/
function multiloquent_paralax_slider() {
Expand Down Expand Up @@ -911,9 +889,8 @@ function multiloquent_paralax_slider() {

/**
* generates the featured posts mini-boxes
*
* @api
*
*
* @return string
*/
function multiloquent_paralax_featured_sliders() {
Expand Down Expand Up @@ -981,9 +958,8 @@ function multiloquent_paralax_featured_sliders() {

/**
* gets the users avatar
*
* @api
*
*
* @param string $avatar
* @return mixed
*/
Expand All @@ -994,9 +970,8 @@ function multiloquent_get_avatar($avatar) {

/**
* renders the archive lists in the colour supplied
*
* @api
*
*
* @param string $colour
*
* @todo make this return rather than echo
Expand Down Expand Up @@ -1043,9 +1018,8 @@ function multiloquent_render_the_archive($colour) {

/**
* renders the tags or the excerpt for the supplied post id, depending on the setting in the wp_customize setting
*
* @api
*
*
* @param object $val
* @param bool $force_tags
* (set to true to force tag output)
Expand Down

0 comments on commit b9d973a

Please sign in to comment.