__construct($plugin_name, $version, $core_file, $textdomain, $options_entry, $default_options); } // End of EG_Plugin_127 /** * Class contructor * Define the plugin url and path. Declare action INIT and HEAD. * * @package EG-Plugins * @return object */ function __construct($plugin_name, $version, $core_file, $textdomain, $options_entry, $default_options=FALSE) { $this->name = $plugin_name; $this->version = $version; $this->textdomain = $textdomain; $this->options_entry = $options_entry; $this->default_options = $default_options; /* Define the plugin path */ $this->path = trailingslashit(str_replace('\\', '/', WP_PLUGIN_DIR.'/'.dirname(plugin_basename($core_file)))); $this->url = plugin_dir_url($core_file); $this->corefile = $core_file; } // End of __construct /** * Class destructor * * @package EG-Plugins * @return boolean true */ function __destruct() { // Nothing } // End of __destruct /** * plugins_loaded * * Call by plugins_loaded WP action * * @package EG-Plugins * @param none * @return none */ function plugins_loaded () { /* --- Check if WP version is correct --- */ //$this->check_requirements(); /* --- Get Plugin options --- */ if (! $this->options) $this->options = get_option($this->options_entry);; } // End of plugins_loaded /** * init * * Perform init * * @package EG-Plugins * * @param none * @return none */ function init() { if ($this->textdomain != '') load_plugin_textdomain( $this->textdomain, FALSE, dirname( plugin_basename( $this->corefile ) ).'/lang'); if (! is_admin()) { add_action('wp_enqueue_scripts', array(&$this, 'load_styles')); } else { // Add only in Rich Editor mode if ( isset($this->tinyMCE_buttons) && get_user_option('rich_editing') == 'true' ) { // && current_user_can('edit_posts') && current_user_can('edit_pages') ) { add_filter('tiny_mce_version', array(&$this, 'tiny_mce_version' )); add_filter('mce_external_plugins', array(&$this, 'add_tinymce_plugin' )); add_filter('mce_buttons', array(&$this, 'register_button' )); } } // End of is_admin } // End of init function desactivation() { } // End of desactivation /** * upgrade * * Create or update plugin environment (options, database, files ...) * * @package EG-Plugins * @param none * @return none */ /* To use this function: function install_upgrade() { $current_version = parent::install_upgrade(); put here your upgrade or install features } */ function install_upgrade() { if (! $this->options) $this->options = get_option($this->options_entry); if ($this->options === FALSE) { $previous_options = FALSE; // Create option from the defaults if ($this->default_options !== FALSE) { $this->options = $this->default_options; } $this->options['version'] = $this->version; add_option($this->options_entry, $this->options); } // End of options empty (first install) else { $previous_options = $this->options; if (version_compare($this->options['version'], $this->version, '<')) { //$current_version = (isset($this->options['version'])? $this->options['version']: '0.0.0'); // Plugin previously installed. Check the version and update options //if (version_compare($current_version, $this->version, '<')) { if ($this->default_options === FALSE) { $new_options = $this->options; } else { $new_options = array(); foreach ($this->default_options as $key => $value) { if (isset($this->options[$key])) $new_options[$key] = $this->options[$key]; else $new_options[$key] = $value; } } $new_options['version'] = $this->version; update_option($this->options_entry, $new_options); $this->options = $new_options; // } // End of version compare } // End of options not empty (update) } return ($previous_options); } // End of install_upgrade function admin_init() { $this->install_upgrade(); add_action('admin_notices', array(&$this, 'display_notice_error')); add_action('admin_enqueue_scripts', array (&$this, 'load_styles')); } // End of admin_init /** * admin_head * * Implement Head action * * @package EG-Plugins * @param none * @return none */ function admin_head() { } // End of admin_head /** * admin_footer * * Implement footer admin actions * * @package EG-Plugins * @param none * @return none */ function admin_footer() { } // End of admin_footer /** * Implement Head action * * Add links to the style sheet * * @package EG-Plugins * @param none * @return none */ function head() { } // End of head /** * Implement Footer action * * @package EG-Plugins * @param none * @return none */ function footer() { } // End of footer function wp_logout() { } // End of wp_logout /** * Load * * @package EG-Plugins * @return none */ function load() { add_action('plugins_loaded', array(&$this, 'plugins_loaded') ); add_action('init', array(&$this, 'init') ); add_action('wp_logout', array(&$this, 'wp_logout') ); if (is_admin()) { register_deactivation_hook( $this->corefile, array(&$this, 'desactivation') ); //register_activation_hook( $this->corefile, array(&$this, 'install_upgrade') ); add_action('in_plugin_update_message-' . basename($this->corefile), array( &$this, 'plugin_update_notice') ); add_action('admin_menu', array( &$this, 'admin_menu') ); add_action('admin_init', array( &$this, 'admin_init') ); add_action('admin_header', array( &$this, 'admin_head') ); add_action('admin_footer', array( &$this, 'admin_footer') ); } else { add_action('wp_head', array( &$this, 'head') ); add_action('wp_footer', array( &$this, 'footer')); } } // End of load /** * set_stylesheet * * Set stylesheet for public and admin interface * * @package EG-Plugins * * @param string $stylesheet stylesheet for the public side * @param string $admin_stylesheet stylesheet for the admin side * @return none */ function set_stylesheets($stylesheet) { $this->stylesheet = $stylesheet; } // End of set_styleshhet function get_stylesheet_url() { $style_url = ''; if ($this->stylesheet != '') { if (is_admin()) { if (@file_exists($this->path.$this->stylesheet)) { $style_url = $this->url.$this->stylesheet; } } // End of is_admin else { $load_css = isset($this->options['load_css']) ? $this->options['load_css'] : 1; if ($load_css) { if (@file_exists(TEMPLATEPATH.'/'.$this->stylesheet)) { $style_url = get_stylesheet_directory_uri().'/'.$this->stylesheet; } else { if (@file_exists($this->path.$this->stylesheet)) { $style_url = $this->url.$this->stylesheet; } } } // End of load_css } // End of not is_admin } // End of stylesheet != '' return ($style_url); } // End of get_stylesheet_url /** * load_styles * * Register plugin style sheets * * @package EG-Plugins * @param none * @return none */ function load_styles() { $style_url = $this->get_stylesheet_url(); if ($style_url != '') wp_enqueue_style( $this->name.'_stylesheet', $style_url); } // End of load_styles /** * set_debug_mode * * Set debug mode: display messages or not * * @package EG-Plugins * * @param boolean $debug_mode TRUE to display message, FALSE to hide message * @param string $debug_file name of the file where store messages * @return none */ function set_debug_mode($debug_mode = FALSE, $debug_file='') { $this->debug_mode = $debug_mode; if ($debug_file != '') $this->debug_file = $this->path.$debug_file; } /** * display_debug_info * * @package EG-Plugin * * @param string $msg message to display * @param mixed $mixed variable to display * @return none */ function display_debug_info($mixed, $msg='') { if ($this->debug_mode) { $debug_info = debug_backtrace(FALSE); $output = date('d-M-Y H:i:s').' - '.$debug_info[1]['function'].' - '.$debug_info[2]['function'].($msg!=''?' - '.$msg:'').': '; if (! isset($mixed)) $output .= 'Not set'; else { switch (gettype($mixed)) { case 'boolean': $output .= ($mixed === TRUE ? 'TRUE' : 'FALSE'); break; case 'array': case 'object': case 'resource': $output .= var_export($mixed, TRUE); break; case 'NULL': $output .= 'NULL'; break; default: $output .= $mixed; } } if ($this->debug_file == '') echo $output.'
'; else file_put_contents($this->debug_file, $output."\n", FILE_APPEND); } // End of debug_mode } // End of display_debug_info /** * set_wp_versions * * Set compliance parameters with WordPress and WordPress MU * * @package EG-Plugins * * @param string $wp_version_min minimum version for WordPress * @param string $wp_version_max maximum version for WordPress * @param string $wpmu_version_min minimum version for WordPress MU * @param string $wpmu_version_max maximum version for WordPress MU * @return none */ function set_wp_versions($wp_version_min, $wp_version_max='', $multi_site=TRUE) { $this->wp_version_min = $wp_version_min; $this->wp_version_max = $wp_version_max; $this->multi_site = $multi_site; } // End of set_wp_versions /** * get_requirements_msg * * Build requirements string * * @package EG-Plugins * @param string name of the software (for example: WP, WP MU, PHP, MySQL) * @param int version minimum * @param int version maximum * @return string the message */ function get_requirements_msg($soft, $current='', $min=FALSE, $max=FALSE) { if (! $min) { $string = sprintf(__('%s cannot run with %s', $this->textdomain), $this->name, $soft).'.'; } else { $string = sprintf(__('You are using %s %s.
%s requires %s %s or upper.', $this->textdomain), $soft, $current, $this->name, $soft, $min).($max?sprintf(__(' The plugin is tested with %s up to version %s', $this->textdomain), $soft, $max):'').'.'; } return ($string); } // End of get_requirements_msg /** * check_wp_requirements * * Check WordPress version required to run the plugin * * @package EG-Plugin * * @param boolean display_msg display error message or not * @return boolean TRUE if required WordPress version, FALSE if not */ function check_wp_requirements() { global $wp_version; $value = version_compare($wp_version, $this->wp_version_min, '>='); if ($this->wp_version_max) $value = $value && version_compare($wp_version, $this->wp_version_max, '<='); if (!$value) $this->requirements_error_msg .= $this->get_requirements_msg('WordPress', $wp_version, $this->wp_version_min, $this->wp_version_max); // TODO: is_multisite exists only since 3.0. Manage previous version if (is_multisite() && ! $this->multi_site) { $this->requirements_error_msg .= '
'.$this->get_requirements_msg('Multisite mode of WordPress'); $value = FALSE; } return ($value); } // End of check_wp_requirements /** * Check_requirements * * Check if the wordpress version meets the plugin requirements. * * @package EG-Plugins * @param none * @return none */ function check_requirements() { global $pagenow; $value = TRUE; if ( is_admin() && $pagenow == 'plugins.php' ) { $value = $this->check_wp_requirements(); if (! $value) { echo '

'.$this->requirements_error_msg.'

'; } } return ($value); } // End of check_requirements /** * set_update_notice * * @package EG-Plugins * * @param string $msg Message to add. * @return none */ function set_update_notice($msg) { $this->update_notice = $msg; } // End of set_update_notice /** * plugin_update_notice * * Display a specific message in the plugin update message. * * @package EG-Plugin * * @param none * @return none */ function plugin_update_notice() { if ($this->update_notice!= '') echo '' . strip_tags( __($this->update_notice, $this->textdomain), '
' ) . ''; } // End of plugin_update_notice /** * Filter_plugin_actions * * Add a "settings" link to access to the option page from the plugin list * * @package EG-Plugins * @param string $link list of existings links * @return none */ function filter_plugin_actions($links) { if ($this->options_page_id !='') { $settings_link = '' . __('Settings') . ''; array_unshift( $links, $settings_link ); } return $links; } // End of filter_plugin_actions /** * display_box * * Display a metabox-like in admin interface. * * @package EG-Plugin * * @param $id string id / name of the div containing box * @param $title string title of the box * @param $content string content of the box * @return none */ function display_box($id, $title, $content) { ?>

textdomain); ?>

textdomain); ?>
'', 'parent_id' => '', 'type' => 'options', 'page_title' => $this->name.__(' settings', $this->textdomain), 'menu_title' => $this->name, 'access_level' => 'manage_options', 'display_callback' => 'options_page', 'option_link' => FALSE, 'load_callback' => FALSE, 'load_scripts' => FALSE, 'shortname' => null, 'icon_url' => null, 'load_help' => FALSE ); $values = wp_parse_args($args, $default_args); if ($values['id']!='' && $values['display_callback']!='') { $this->pages[$values['id']] = $values; if ($values['option_link']) $this->options_page_id = $values['id']; return ($values['id']); } else return (FALSE); } // End of add_page function set_notice_error($errors_entry, $area_id, $pages_list) { $this->errors_entry = $errors_entry; foreach (explode(',',$pages_list) as $page) { $notice_pages[$page] = $area_id; } } // End of create_notice_area function add_notice($code, $msg, $level, $details=FALSE, $area='') { $errors = get_transient($this->errors_entry); if ($errors === FALSE) $errors = new WP_Error(); $string = ''; if ($details) { if (is_wp_error($details)) $string = $details->get_error_message().' ('. $details->get_error_code().')'; else if (is_string($details)) $string = $details; } $errors->add($code, $msg, array('level' => $level, 'details' => $string, 'area' => $area)); set_transient($this->errors_entry, $errors); } function display_notice_error() { if ($this->errors_entry != '') { $screen = get_current_screen(); $this->display_debug_info($screen->id, 'Screen ID for notice error'); if (isset($this->notice_pages[$screen->id])) { $area = $this->notice_pages[$screen->id]; $errors = get_transient($this->errors_entry); $this->display_debug_info($errors, 'Displaying errors: '); if ($errors !== FALSE) { foreach ($errors->get_error_codes() AS $code) { $msg = $errors->get_error_message($code); $data = $errors->get_error_data($code); if ($data['area']=='' || $data['area'] == $area) { echo '
'. '

'. ''.$code.': '.$msg. (isset($data['details']) ? '
'.$data['details'].'' : ''). '

'. '
'; } } // End of foreach delete_transient($this->errors_entry); } // End of errors to display } // Endif screen } // End of errors_entry define } // End of display_notice_error /** * admin_menu * * Run the amdin menu hook * * @package EG-Plugins * @param none * @return none */ function admin_menu() { $page_list = array ( 'dashboard' => 'index.php', 'posts' => 'edit.php', 'options' => 'options-general.php', 'settings' => 'options-general.php', 'tools' => 'tools.php', 'theme' => 'themes.php', 'users' => 'users.php', 'media' => 'upload.php', 'links' => 'link-manager.php', 'pages' => 'edit.php?post_type=page', 'comments' => 'edit-comments.php'); // Add a new submenu under Options: if (sizeof($this->pages)>0) { foreach ($this->pages as $id => $page) { // Create the menu if ($page['type'] == 'menu') { $hook = add_menu_page( __($page['page_title'], $this->textdomain), __($page['menu_title'], $this->textdomain), $page['access_level'], $id, array(& $this, $page['display_callback']), $page['icon_url'], $page['position'] ); } // End of menu else { if ($page['type'] != 'submenu') $page['parent_id'] = $page_list[$page['type']]; $hook = add_submenu_page( $page['parent_id'], __($page['page_title'], $this->textdomain), __($page['menu_title'], $this->textdomain), $page['access_level'], $id, array(& $this, $page['display_callback']) ); if (isset($this->pages[$page['parent_id']]) && $this->pages[$page['parent_id']]['shortname'] != '') { global $submenu; $submenu[$page['parent_id']][0][0] = $this->pages[$page['parent_id']]['shortname']; $this->pages[$page['parent_id']]['shortname'] = ''; } } // End of submenu // Get the hook of the page $this->hooks[$page['display_callback']][$id] = $hook; // Add load, and print_scripts functions (attached to the hook) if ($page['load_callback'] !== FALSE) { add_action('load-'.$hook, array(&$this, $page['load_callback'])); } if ($page['load_scripts'] !== FALSE) { add_action('admin_print_scripts-'.$hook, array(&$this, $page['load_scripts'])); } // Add the link into the plugin page if ($this->options_page_id == $id) { add_filter( 'plugin_action_links_' . plugin_basename($this->corefile), array( &$this, 'filter_plugin_actions') ); } // Manage help if ($page['load_help'] !== FALSE) { add_action('load-'.$hook, array(&$this, $page['load_help'])); } } // End of foreach unset($this->pages); } // End of isset this->pages } // End of admin_menu function add_help($id, $title, $content, $type='tab') { $screen = get_current_screen(); if ($type='tab') $screen->add_help_tab( array( 'id' => $id, 'title' => __($title, $this->textdomain), 'content' => __($content, $this->textdomain)) ); else $screen->set_help_sidebar( array( 'id' => $id, 'title' => __($title, $this->textdomain), 'content' => __($content, $this->textdomain)) ); } // End of page_help /** * get_page_hook * * Return the hook of the page * * @package EG-Plugins * * @param string $button_name Name of the button * @return none */ function get_page_hook($page_id='', $function = '') { if ($page_id == '' || $function == '') return FALSE; else return (isset($this->hooks[$function][$page_id]) ? $this->hooks[$function][$page_id] : FALSE); } // End of get_page_hook /** * add_tinyMCE_button * * Add a TinyMCE button * * @package EG-Plugins * * @param string $button_name Name of the button * @return none */ function add_tinyMCE_button($button_name, $tinymce_plugin_path, $js_file_name='editor_plugin.js') { $index = sizeof($this->tinyMCE_buttons); $this->tinyMCE_buttons[$index]->name = $button_name; $this->tinyMCE_buttons[$index]->js_file = $js_file_name; $this->tinyMCE_buttons[$index]->path = $tinymce_plugin_path; } // End of add_tinyMCE_button /** * register_button() * Insert button in wordpress post editor * * @package EG-Plugins * @param array $buttons list of buttons * @return array $buttons */ function register_button($buttons) { foreach ($this->tinyMCE_buttons as $value) { array_push($buttons, $value->name ); } return $buttons; } // End of register_button /** * add_tinymce_plugin() * Load the TinyMCE plugin : editor_plugin.js * * @package EG-Plugins * @param none * @return $plugin_array */ function add_tinymce_plugin($plugin_array) { foreach ($this->tinyMCE_buttons as $value) { $plugin_array[$value->name] = $this->url.$value->path.'/'.$value->js_file; } return $plugin_array; } // End of add_tinymce_plugin function tiny_mce_version($version) { return ++$version; } // End of tiny_mce_version function options_page() { if (isset($this->options_form)) $this->options_form->display_page($this->options); } // End of options_page function display_sidebar() { global $locale; $string = sprintf('', strtolower($this->name), __('Plugin\'s homepage', $this->textdomain), strtolower($this->name), __('Frequently Asked Questions',$this->textdomain), strtolower($this->name), __('Support forum', $this->textdomain), strtolower($this->name), __('Last changes', $this->textdomain)); $this->display_box('links', 'Links', $string); $string = '

'.__('This plugin required and requires many hours of work. If you use the plugin, and like it, feel free to show your appreciation to the author.', $this->textdomain).'

'; if (isset($_SERVER['SERVER_NAME']) && $_SERVER['SERVER_NAME']=='localhost') { $string .= 'PayPal - The safer, easier way to pay online!'; } else { $string .= '
'. ''. ''. ''. ''. ''. ''. ''. ''. '
'; } $this->display_box('paypal', 'Donate', $string); } // End of display_sidebar } // End of class } // End of class_exists ?>