File: //var/www/wp-content/plugins/ocean-custom-sidebar/ocean-custom-sidebar.php
<?php
/**
* Plugin Name: Ocean Custom Sidebar
* Plugin URI: https://oceanwp.org/extension/ocean-custom-sidebar/
* Description: Generates an unlimited number of sidebars and place them on any page you wish.
* Version: 1.1.4
* Author: OceanWP
* Author URI: https://oceanwp.org/
* Requires at least: 5.6
* Tested up to: 6.8
*
* Text Domain: ocean-custom-sidebar
* Domain Path: /languages
*
* @package Ocean_Custom_Sidebar
* @category Core
* @author OceanWP
* @see https://github.com/pojome/pojo-sidebars/
*/
// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Returns the main instance of Ocean_Custom_Sidebar to prevent the need to use globals.
*
* @since 1.0.0
* @return object Ocean_Custom_Sidebar
*/
function Ocean_Custom_Sidebar() {
return Ocean_Custom_Sidebar::instance();
} // End Ocean_Custom_Sidebar()
Ocean_Custom_Sidebar();
/**
* Main Ocean_Custom_Sidebar Class
*
* @class Ocean_Custom_Sidebar
* @version 1.0.0
* @since 1.0.0
* @package Ocean_Custom_Sidebar
*/
final class Ocean_Custom_Sidebar {
/**
* Ocean_Custom_Sidebar The single instance of Ocean_Custom_Sidebar.
* @var object
* @access private
* @since 1.0.0
*/
private static $_instance = null;
protected $_menu_parent = '';
protected $_sidebars = null;
/**
* The token.
* @var string
* @access public
* @since 1.0.0
*/
public $token;
/**
* The version number.
* @var string
* @access public
* @since 1.0.0
*/
public $version;
/**
* The plugin url.
*
* @var string
* @access public
*/
public $plugin_url;
/**
* The plugin path.
*
* @var string
* @access public
*/
public $plugin_path;
/**
* The plugin data.
*
* @var array
* @access public
*/
public $plugin_data;
// Admin - Start
/**
* The admin object.
* @var object
* @access public
* @since 1.0.0
*/
public $admin;
/**
* Constructor function.
* @access public
* @since 1.0.0
* @return void
*/
public function __construct( $widget_areas = array() ) {
$this->token = 'ocean-custom-sidebar';
$this->plugin_url = plugin_dir_url( __FILE__ );
$this->plugin_path = plugin_dir_path( __FILE__ );
$this->plugin_data = get_file_data( __FILE__, array( 'Version' => 'Version' ), false );
$this->version = $this->plugin_data['Version'];
register_activation_hook( __FILE__, array( $this, 'install' ) );
add_action( 'init', array( $this, 'ocs_load_plugin_textdomain' ) );
add_action( 'init', array( $this, 'ocs_setup' ) );
}
/**
* Main Ocean_Custom_Sidebar Instance
*
* Ensures only one instance of Ocean_Custom_Sidebar is loaded or can be loaded.
*
* @since 1.0.0
* @static
* @see Ocean_Custom_Sidebar()
* @return Main Ocean_Custom_Sidebar instance
*/
public static function instance() {
if ( is_null( self::$_instance ) )
self::$_instance = new self();
return self::$_instance;
} // End instance()
/**
* Load the localisation file.
* @access public
* @since 1.0.0
* @return void
*/
public function ocs_load_plugin_textdomain() {
load_plugin_textdomain( 'ocean-custom-sidebar', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
}
/**
* Cloning is forbidden.
*
* @since 1.0.0
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?' ), '1.0.0' );
}
/**
* Unserializing instances of this class is forbidden.
*
* @since 1.0.0
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?' ), '1.0.0' );
}
/**
* Installation.
* Runs on activation. Logs the version number and assigns a notice message to a WordPress option.
* @access public
* @since 1.0.0
* @return void
*/
public function install() {
$this->_log_version_number();
}
/**
* Log the plugin version number.
* @access private
* @since 1.0.0
* @return void
*/
private function _log_version_number() {
// Log the version number.
update_option( $this->token . '-version', $this->version );
}
/**
* Setup all the things.
* Only executes if OceanWP or a child theme using OceanWP as a parent is active and the extension specific filter returns true.
* @return void
*/
public function ocs_setup() {
$theme = wp_get_theme();
if ( 'OceanWP' == $theme->name || 'oceanwp' == $theme->template ) {
if ( class_exists( 'Ocean_Extra' ) ) {
$this->_menu_parent = 'oceanwp';
} else {
$this->_menu_parent = 'themes.php';
}
$this->register_taxonomy();
$this->register_sidebars();
add_action( 'admin_menu', array( $this, 'register_menu' ), 11 );
add_action( 'admin_head', array( $this, 'menu_highlight' ) );
add_filter( 'manage_edit-ocean_sidebars_columns', array( $this, 'manage_columns' ) );
add_filter( 'manage_ocean_sidebars_custom_column', array( $this, 'manage_custom_columns' ), 10, 3 );
add_filter( 'manage_edit-ocean_sidebars_sortable_columns', array( $this, 'sortable_columns' ) );
add_action( 'admin_head', array( $this, 'admin_head' ) );
add_action( 'admin_footer', array( $this, 'admin_footer' ) );
}
}
/**
* Register Sidebars taxonomy.
*/
protected function register_taxonomy() {
$labels = array(
'name' => esc_html__( 'Sidebars', 'ocean-custom-sidebar' ),
'singular_name' => esc_html__( 'Sidebar', 'ocean-custom-sidebar' ),
'menu_name' => esc_html_x( 'Sidebars', 'Admin menu name', 'ocean-custom-sidebar' ),
'search_items' => esc_html__( 'Search Sidebars', 'ocean-custom-sidebar' ),
'all_items' => esc_html__( 'All Sidebars', 'ocean-custom-sidebar' ),
'parent_item' => esc_html__( 'Parent Sidebar', 'ocean-custom-sidebar' ),
'parent_item_colon' => esc_html__( 'Parent Sidebar:', 'ocean-custom-sidebar' ),
'edit_item' => esc_html__( 'Edit Sidebar', 'ocean-custom-sidebar' ),
'update_item' => esc_html__( 'Update Sidebar', 'ocean-custom-sidebar' ),
'add_new_item' => esc_html__( 'Add New Sidebar', 'ocean-custom-sidebar' ),
'new_item_name' => esc_html__( 'New Sidebar Name', 'ocean-custom-sidebar' ),
);
$args = array(
'hierarchical' => false,
'labels' => $labels,
'public' => false,
'show_in_nav_menus' => false,
'show_ui' => true,
'capabilities' => array( 'manage_options' ),
'query_var' => false,
'rewrite' => false,
);
register_taxonomy(
'ocean_sidebars',
apply_filters( 'ocean_taxonomy_objects_sidebars', array() ),
apply_filters( 'ocean_taxonomy_args_sidebars', $args )
);
}
/**
* Return the sidebar.
*/
public function get_sidebars() {
if ( is_null( $this->_sidebars ) ) {
$this->_sidebars = get_terms(
'ocean_sidebars',
array(
'hide_empty' => false,
)
);
}
return $this->_sidebars;
}
/**
* If has sidebar.
*/
public function has_sidebars() {
$sidebars = $this->get_sidebars();
return ! empty( $sidebars );
}
/**
* Register the sidebar.
*/
public function register_sidebars() {
if ( ! self::has_sidebars() ) {
return;
}
$sidebars = self::get_sidebars();
foreach ( $sidebars as $sidebar ) {
$sidebar_classes = array( 'ocean-sidebar' );
register_sidebar(
array(
'id' => 'ocs-' . sanitize_title( $sidebar->name ),
'name' => $sidebar->name,
'description' => $sidebar->description,
'before_widget' => '<div class="sidebar-box %2$s clr">',
'after_widget' => '</div>',
'before_title' => '<h4 class="widget-title">',
'after_title' => '</h4>',
)
);
}
}
/**
* Register the Sidebars menu.
*/
public function register_menu() {
add_submenu_page(
$this->_menu_parent,
esc_html__( 'Sidebars', 'ocean-custom-sidebar' ),
esc_html__( 'Sidebars', 'ocean-custom-sidebar' ),
'manage_options',
'edit-tags.php?taxonomy=ocean_sidebars'
);
}
/**
* If has sidebar.
*/
public function menu_highlight() {
global $parent_file, $submenu_file;
if ( 'edit-tags.php?taxonomy=ocean_sidebars' === $submenu_file ) {
$parent_file = $this->_menu_parent;
}
}
/**
* Columns name.
*/
public function manage_columns( $columns ) {
$col = $columns;
$columns = array(
'cb' => $col['cb'],
'name' => $col['name'],
'ID' => esc_html__( 'ID', 'ocean-custom-sidebar' ),
'description' => $col['description'],
);
return $columns;
}
/**
* Sortable columns.
*/
public function sortable_columns( $sortable_columns ) {
$sortable_columns['ID'] = 'ID';
return $sortable_columns;
}
/**
* Add prefix to the ID column.
*/
public function manage_custom_columns( $value, $column_name, $term_id ) {
$term = get_term( $term_id, 'ocean_sidebars' );
switch ( $column_name ) {
case 'ID' :
$value = 'ocs-' . sanitize_title( $term->name );
break;
}
return $value;
}
/**
* Hide the slug input.
*/
public function admin_head() {
if ( 'edit-ocean_sidebars' !== get_current_screen()->id ) {
return;
} ?>
<style>#addtag div.form-field.term-name-wrap > p, #edittag tr.form-field.term-name-wrap p, #addtag div.form-field.term-description-wrap > p, #edittag tr.form-field.term-description-wrap p { opacity: 0; }#the-list tr.inline-editor .inline-edit-col label:last-child, #addtag div.form-field.term-slug-wrap, #edittag tr.form-field.term-slug-wrap { display: none; }</style>
<?php
}
/**
* Change the description of the inputs.
*/
public function admin_footer() {
if ( 'edit-ocean_sidebars' !== get_current_screen()->id ) {
return;
} ?>
<script>jQuery( document ).ready( function( $ ) {
var $wrapper = $( '#addtag, #edittag' );
$wrapper.find( 'tr.form-field.term-name-wrap p, div.form-field.term-name-wrap > p' ).text( '<?php _e( 'The name of the widgets area', 'ocean-custom-sidebar' ); ?>' ).css( 'opacity', '1' );
$wrapper.find( 'tr.form-field.term-description-wrap p, div.form-field.term-description-wrap > p' ).text( '<?php _e( 'The description of the widgets area (optional)', 'ocean-custom-sidebar' ); ?>' ).css( 'opacity', '1' );
} );</script>
<?php
}
} // End Class
#--------------------------------------------------------------------------------
#region Freemius
#--------------------------------------------------------------------------------
if ( ! function_exists( 'ocean_custom_sidebar_fs' ) ) {
// Create a helper function for easy SDK access.
function ocean_custom_sidebar_fs() {
global $ocean_custom_sidebar_fs;
if ( ! isset( $ocean_custom_sidebar_fs ) ) {
$ocean_custom_sidebar_fs = OceanWP_EDD_Addon_Migration::instance( 'ocean_custom_sidebar_fs' )->init_sdk( array(
'id' => '3810',
'slug' => 'ocean-custom-sidebar',
'public_key' => 'pk_e1fc615375e847fd4d955c62b2a34',
'is_premium' => false,
'is_premium_only' => false,
'has_paid_plans' => false,
) );
}
return $ocean_custom_sidebar_fs;
}
function ocean_custom_sidebar_fs_addon_init() {
if ( class_exists( 'Ocean_Extra' ) ) {
OceanWP_EDD_Addon_Migration::instance( 'ocean_custom_sidebar_fs' )->init();
}
}
if ( 0 == did_action( 'owp_fs_loaded' ) ) {
// Init add-on only after parent theme was loaded.
add_action( 'owp_fs_loaded', 'ocean_custom_sidebar_fs_addon_init', 15 );
} else {
if ( class_exists( 'Ocean_Extra' ) ) {
/**
* This makes sure that if the theme was already loaded
* before the plugin, it will run Freemius right away.
*
* This is crucial for the plugin's activation hook.
*/
ocean_custom_sidebar_fs_addon_init();
}
}
}
#endregion