Theme Integration Technical – Including Easy Social Share Buttons for WordPress in a WordPress Theme

Article sections

    Overview

    If you are author you may want to integrate Easy Social Share Buttons for WordPress right into your WordPress product.

    Separate “Extended” license is required for each of your products where you will bundle plugin.

    What Will Be The Difference For Your Customers Using Bundled Plugin Version

    The bundled inside product version of Easy Social Share Buttons for WordPress has the same core features as the one they can buy directly. The differences are:

    • The bundled version can’t be registered by users (with the code of your product). Your customers will see a theme integrated license message instead of not registered. 
    • The bundled versions do not have access to direct support from us (AppsCreo) as a plugin author. You will be responsible to answer questions from your customers or contact us for issues you can’t solve.
    • The bundled versions do not receive automatic plugin updates. You as a developer should provide an update for your customers.
    • You are not allowed to bundle the free plugin extensions that come with the plugin. And your customers won’t have access to download those free extensions.

    Bundled into a product for sale versions of Easy Social Share Buttons can be updated to a full version by your customers. To do this they should make a direct purchase of plugin and activate with the purchase code. The activation will change their state to activated (not theme integrated) and they will have access to all features listed above.

    Theme Integration Tutorial

    Set Theme Integrated License of Plugin

    This step is important to avoid further messages from your customers “Why plugin is not activated or not licensed”. To complete and change the license state to theme activated you need to place the following simple code inside functions.php file of your theme. This code can be also placed in a plugin (separate or core plugin of your theme/product).

    add_filter('essb_is_theme_integrated', 'my_theme_essb_is_in_theme'); 
    function my_theme_essb_is_in_theme() { 
        return true;
    }

    Adding Plugin With TGM Activation Class

    To meet new theme submission requirements follow this steps:

    1. Include TGM Activation class into your theme PHP files (ex. in functions.php file)
    2. Add settings for TGM Activation class and hook them to the tgmpa_register action
    <?php
    /**
     * Include the TGM_Plugin_Activation class.
     */
    require_once dirname( __FILE__ ) . '/class-tgm-plugin-activation.php';
    add_action( 'tgmpa_register', 'my_theme_register_essb_plugins' );
    /**
     * Register the required plugins for this theme.
     *
     * The variable passed to tgmpa_register_plugins() should be an array of plugin
     * arrays.
     *
     * This function is hooked into tgmpa_init, which is fired within the
     * TGM_Plugin_Activation class constructor.
     */
    function my_theme_register_essb_plugins() {
        /**
         * Array of plugin arrays. Required keys are name and slug.
         * If the source is NOT from the .org repo, then source is also required.
         */
        $plugins = array(
            // This is an example of how to include a plugin pre-packaged with a theme
            array(
                'name'          => 'Easy Social Share Buttons for WordPress', // The plugin name
                'slug'          => 'easy-social-share-buttons3', // The plugin slug (typically the folder name)
                'source'            => get_stylesheet_directory() . '/easy-social-share-buttons3.zip', // The plugin source
                'required'          => true, // If false, the plugin is only 'recommended' instead of required
                'version'           => '4.2', // E.g. 1.0.0. If set, the active plugin must be this version or higher, otherwise a notice is presented
                'force_activation'      => false, // If true, plugin is activated upon theme activation and cannot be deactivated until theme switch
                'force_deactivation'    => false, // If true, plugin is deactivated upon theme switch, useful for theme-specific plugins
                'external_url'      => '', // If set, overrides default API URL and points to an external URL
            )
        );
      
        // Change this to your theme text domain, used for internationalising strings
        $theme_text_domain = 'tgmpa';
      
        /**
         * Array of configuration settings. Amend each line as needed.
         * If you want the default strings to be available under your own theme domain,
         * leave the strings uncommented.
         * Some of the strings are added into a sprintf, so see the comments at the
         * end of each line for what each argument will be.
         */
        $config = array(
            'domain'        => $theme_text_domain, // Text domain - likely want to be the same as your theme.
            'default_path'      => '', // Default absolute path to pre-packaged plugins
            'parent_menu_slug'  => 'themes.php', // Default parent menu slug
            'parent_url_slug'   => 'themes.php', // Default parent URL slug
            'menu'          => 'install-required-plugins', // Menu slug
            'has_notices'       => true, // Show admin notices or not
            'is_automatic'      => false, // Automatically activate plugins after installation or not
            'message'       => '', // Message to output right before the plugins table
            'strings'       => array(
                'page_title'            => __( 'Install Required Plugins', $theme_text_domain ),
                'menu_title'            => __( 'Install Plugins', $theme_text_domain ),
                'installing'            => __( 'Installing Plugin: %s', $theme_text_domain ), // %1$s = plugin name
                'oops'              => __( 'Something went wrong with the plugin API.', $theme_text_domain ),
                'notice_can_install_required'   => _n_noop( 'This theme requires the following plugin: %1$s.', 'This theme requires the following plugins: %1$s.' ), // %1$s = plugin name(s)
                'notice_can_install_recommended'    => _n_noop( 'This theme recommends the following plugin: %1$s.', 'This theme recommends the following plugins: %1$s.' ), // %1$s = plugin name(s)
                'notice_cannot_install'     => _n_noop( 'Sorry, but you do not have the correct permissions to install the %s plugin. Contact the administrator of this site for help on getting the plugin installed.', 'Sorry, but you do not have the correct permissions to install the %s plugins. Contact the administrator of this site for help on getting the plugins installed.' ), // %1$s = plugin name(s)
                'notice_can_activate_required'  => _n_noop( 'The following required plugin is currently inactive: %1$s.', 'The following required plugins are currently inactive: %1$s.' ), // %1$s = plugin name(s)
                'notice_can_activate_recommended'   => _n_noop( 'The following recommended plugin is currently inactive: %1$s.', 'The following recommended plugins are currently inactive: %1$s.' ), // %1$s = plugin name(s)
                'notice_cannot_activate'        => _n_noop( 'Sorry, but you do not have the correct permissions to activate the %s plugin. Contact the administrator of this site for help on getting the plugin activated.', 'Sorry, but you do not have the correct permissions to activate the %s plugins. Contact the administrator of this site for help on getting the plugins activated.' ), // %1$s = plugin name(s)
                'notice_ask_to_update'      => _n_noop( 'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.', 'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.' ), // %1$s = plugin name(s)
                'notice_cannot_update'      => _n_noop( 'Sorry, but you do not have the correct permissions to update the %s plugin. Contact the administrator of this site for help on getting the plugin updated.', 'Sorry, but you do not have the correct permissions to update the %s plugins. Contact the administrator of this site for help on getting the plugins updated.' ), // %1$s = plugin name(s)
                'install_link'          => _n_noop( 'Begin installing plugin', 'Begin installing plugins' ),
                'activate_link'         => _n_noop( 'Activate installed plugin', 'Activate installed plugins' ),
                'return'                => __( 'Return to Required Plugins Installer', $theme_text_domain ),
                'plugin_activated'          => __( 'Plugin activated successfully.', $theme_text_domain ),
                'complete'              => __( 'All plugins installed and activated successfully. %s', $theme_text_domain ), // %1$s = dashboard link
                'nag_type'              => 'updated' // Determines admin notice type - can only be 'updated' or 'error'
            )
        );
        tgmpa( $plugins, $config );
    }
    ?>

     

    Was this article helpful?
    YesNo
    in Developers
    Was this article helpful?
    YesNo