Theme Doc

Übersicht

• Documentation
  • Tools

WordPress ToolSet Plugin

This WordPress plugin provides a foundation to configurate WordPress, provides PHP tools and Javascript assets for frequent tasks.
It is about NOT separately managing all the same repeating code on every WordPress project.

Strategie

• First, keep using configuration and tools simple and flexible.
• Use abstract interface to connect tools and presentation.
• Documenting changes and instructions since last update in the update changelog.

Taktik

• Provide the functionality, tools and assets as a single WordPress plugin.
• Use a single global config variable in the theme.
• Provide a abstract function to use all tools.

Structure

plugins/
	toolset/
		assets/
		tools/
			index.php
			{toolname}/
				index.php
				styles.css
				scripts.js
				readme.markdown
	 	toolset.php
themes/
	theme/
		config/
			config.php

Using a Tool Functionality

tool( array(
	'name' => 'the abstract name of functionality',
	'param' => array(
		'key' => 'value', // parameters of the functionality
	),
) );

The tool() Function
– detects the real tool function name and its sourcefile by plugins/toolset/tools/index.php
– checks wheter the function exists and autoload the sourcefile of the function from plugins/toolset/tools/…
– runs the function and returns a result.

Config

There is a single global variable, that holds any kind of global data to drive tools of the toolset. This variable must be set in the active theme in the function.php or better in an /config/config.php file.

$GLOBALS['toolset'] = array( /* toolset configuration options goes here */ );

Lets walk true the basic configuration options.

$GLOBALS['toolset'] = array(

	// THEME VERSION {

		// The theme version is used to force reloading all cached files of a theme
		// via example_changed_file.js?v=0.1 to make changes happen in a browser.

		'theme-version' => '0.1',

	// }

	// DOMAINS {

		// configurates the domains for the development, staging and production server

		'domains' => array(
			$_SERVER["HTTP_HOST"] => 'live',
			'kickstart.domain.de' => 'test',
			'kickstart.dev' => 'local',
		),

		// Notice if you are using MAMP on a Mac!
		// Avoide using '.local' domains. This makes your local Site realy slow because
		// '.local' conflict with Bonjour, which treats anything with a '.local' TLD as a Bonjour server.
		// read this: http://www.bram.us/2011/12/12/mamp-pro-slow-name-resolving-with-local-vhosts-in-lion-fix/
		// and this: https://discussions.apple.com/message/15834652#15834652.

	// }

	// SITES {

		// sites holds basic information for the site ore even mulitple sites on a WordPress multisite installation
		// this example intents, that we are using sites for building a multilanguage website

		'sites' => array(
			'1' => array(
				'key' => 1,
				'id' => 'en',
				'slug' => '',
				'name' => 'English',
			),
			'2' => array(
				'key' => 2,
				'id' => 'de',
				'slug' => 'de',
				'name' => 'German',
			),
		),

	// }

	// LANGUAGES {

		'langcode' => array(
			'en' => 'en',
			'de' => 'de',
		),
		'countrycode' => array(
			'en' => 'en-US',
			'de' => 'de-DE',
		),

		'admin_locale' => get_locale(),

	// }

	// REGISTER PHP CLASSES FOR AUTOLOAD FROM YOUR THEME {

		// You do not need to define classes from the toolset plugin

		'autoload_php_classes' => array(
			// 'ClassName' => 'path/to/class.php',
		),

	// }
);

Documentation

Initial Functionality

$GLOBALS['toolset'] = array(
	'inits' => array(
		// initial functionalities configurations
	)
);

• WordPress Head
• WordPress Meta Title
• WordPress Remove Footprint
• WordPress Postboxes
• WordPress Unregister Default Widgets
• WordPress Remove Metaboxes
• WordPress Add CSS Classes to Menu Items
• WordPress Notify Post Author if Comments
• WordPress Comment Moderation Email Recipients
• WordPress Images Sizes
• WordPress REST-API
• Adaptive Images
• ACF Save Post After
• ACF Translate
• API SiteData
• HTML5

Tools

• Array Positioning
• Array Layout
• Ajax Call
• Cookie Notice
• Countdown
• Filesize
• Form
• Hreflang
• Hierarchical Order Posts
• Instagram
• Javascript Recomended Message
• Get Locale by URL
• Meta Title
• Meta Description
• Meta Robots
• Multilanguage
• Register Navigation Menu
• Posttype
• Sortable Admin List Columns
• Transient
• Translate
• User Login/Logout

Assets

• YerScriptMediaQueries
• YerParallax
• YerWhen
• YerRespFontSize

Filters

• toolset/tool_html_buffer/buffer
• toolset/tool_fields_value/value