Utengenezaji wa Kiendelezi
Muundo wa Kiendelezi
my-addon/
├── my-addon.php # Main plugin file
├── inc/
│ ├── class-my-addon.php # Main addon class
│ ├── admin-pages/ # Admin interface
│ ├── models/ # Custom data models
│ └── integrations/ # Third-party integrations
├── assets/
│ ├── js/
│ └── css/
└── templates/ # Template files
Kiolezo cha Faili Kuu ya Kiendelezi
<?php
/**
* Plugin Name: My Ultimate Multisite Addon
* Description: Custom addon for Ultimate Multisite
* Version: 1.0.0
* Author: Your Name
* Requires PHP: 7.4
* Ultimate Multisite: 2.0.0
*/
namespace My_Addon;
// Exit if accessed directly
defined('ABSPATH') || exit;
// Define constants
define('MY_ADDON_VERSION', '1.0.0');
define('MY_ADDON_PLUGIN_FILE', __FILE__);
define('MY_ADDON_PATH', plugin_dir_path(__FILE__));
define('MY_ADDON_URL', plugin_dir_url(__FILE__));
// Check if Ultimate Multisite is active
add_action('plugins_loaded', function() {
if (!class_exists('WP_Ultimo\WP_Ultimo')) {
add_action('admin_notices', function() {
echo '<div class="notice notice-error"><p>';
echo 'My Addon requires Ultimate Multisite to be installed and activated.';
echo '</p></div>';
});
return;
}
// Initialize addon
My_Addon::get_instance();
});
/**
* Main addon class
*/
class My_Addon {
use \WP_Ultimo\Traits\Singleton;
/**
* Initialize the addon
*/
public function init() {
// Load dependencies
$this->load_dependencies();
// Setup hooks
$this->setup_hooks();
// Initialize components
$this->init_components();
}
/**
* Load required files
*/
private function load_dependencies() {
require_once MY_ADDON_PATH . 'inc/class-my-addon.php';
}
/**
* Setup WordPress hooks
*/
private function setup_hooks() {
// Activation/deactivation
register_activation_hook(MY_ADDON_PLUGIN_FILE, [$this, 'activate']);
register_deactivation_hook(MY_ADDON_PLUGIN_FILE, [$this, 'deactivate']);
// Ultimate Multisite hooks
add_action('wu_checkout_completed', [$this, 'on_checkout_completed'], 10, 3);
add_filter('wu_checkout_form_fields', [$this, 'add_custom_fields'], 10, 2);
}
/**
* Initialize addon components
*/
private function init_components() {
// Initialize admin pages, models, etc.
}
/**
* Plugin activation
*/
public function activate() {
// Create custom tables, set options, etc.
$this->create_custom_table();
update_option('my_addon_version', MY_ADDON_VERSION);
}
/**
* Plugin deactivation
*/
public function deactivate() {
// Cleanup if needed
}
/**
* Handle checkout completion
*/
public function on_checkout_completed($payment, $customer, $membership) {
// Custom logic when checkout completes
$this->send_welcome_email($customer);
$this->setup_customer_account($customer, $membership);
}
/**
* Add custom checkout fields
*/
public function add_custom_fields($fields, $form) {
$fields['company_size'] = [
'type' => 'select',
'title' => 'Company Size',
'options' => [
'small' => '1-10 employees',
'medium' => '11-100 employees',
'large' => '100+ employees'
],
'required' => false
];
return $fields;
}
}
Mfano wa Model Maalum
<?php
namespace My_Addon\Models;
/**
* Custom Lead model
*/
class Lead extends \WP_Ultimo\Models\Base_Model {
/**
* Model name
*/
protected $model = 'lead';
/**
* Set the database table
*/
protected function set_table() {
global $wpdb;
$this->table_name = "{$wpdb->prefix}my_addon_leads";
}
/**
* Get the company name
*/
public function get_company() {
return $this->get_meta('company');
}
/**
* Set the company name
*/
public function set_company($company) {
return $this->add_meta('company', $company);
}
/**
* Convert lead to customer
*/
public function convert_to_customer($user_data = []) {
// Create WordPress user
$user_id = wp_create_user(
$user_data['username'] ?? $this->get_email(),
$user_data['password'] ?? wp_generate_password(),
$this->get_email()
);
if (is_wp_error($user_id)) {
return $user_id;
}
// Create Ultimate Multisite customer
$customer = wu_create_customer([
'user_id' => $user_id,
'email_verification' => 'verified',
'type' => 'customer'
]);
if (is_wp_error($customer)) {
return $customer;
}
// Copy lead data to customer
$customer->add_meta('company', $this->get_company());
$customer->add_meta('lead_source', $this->get_source());
// Mark lead as converted
$this->set_status('converted');
$this->add_meta('converted_customer_id', $customer->get_id());
$this->save();
return $customer;
}
}
Ujumuishaji wa Ukurasa wa Admin
<?php
namespace My_Addon\Admin_Pages;
/**
* Custom admin page
*/
class Leads_Admin_Page extends \WP_Ultimo\Admin_Pages\Base_Admin_Page {
/**
* Page ID
*/
protected $id = 'my-addon-leads';
/**
* Menu position
*/
protected $position = 30;
/**
* Initialize page
*/
public function init() {
// Register with Ultimate Multisite
add_action('wu_register_admin_pages', [$this, 'register']);
}
/**
* Register the admin page
*/
public function register() {
wu_register_admin_page($this->id, [
'title' => __('Leads', 'my-addon'),
'menu_title' => __('Leads', 'my-addon'),
'capability' => 'wu_read_leads',
'position' => $this->position,
'parent' => 'ultimate-multisite',
'callback' => [$this, 'render']
]);
}
/**
* Render the page
*/
public function render() {
// Get leads data
$leads = My_Addon\Models\Lead::query([
'number' => 20,
'paged' => absint($_GET['paged'] ?? 1)
]);
// Render template
wu_get_template('admin/leads-list', [
'leads' => $leads,
'page_title' => __('Manage Leads', 'my-addon')
]);
}
}
Kujaribu Addon Yako
<?php
class Test_My_Integration extends WP_UnitTestCase {
public function setUp() {
parent::setUp();
// Create test customer
$this->customer = wu_create_customer([
'user_id' => $this->factory->user->create(),
'type' => 'customer'
]);
// Create test membership
$this->membership = wu_create_membership([
'customer_id' => $this->customer->get_id(),
'plan_id' => $this->create_test_plan()
]);
}
public function test_custom_field_saves_correctly() {
$checkout = new WP_Ultimo\Checkout\Checkout();
// Simulate form submission
$_POST['company_size'] = 'medium';
$result = $checkout->process_step_data([
'company_size' => 'medium'
]);
$this->assertTrue($result);
// Verify data was saved
$saved_value = $this->customer->get_meta('company_size');
$this->assertEquals('medium', $saved_value);
}
private function create_test_plan() {
return wu_create_product([
'name' => 'Test Plan',
'type' => 'plan',
'price' => 50,
'duration' => 1,
'duration_unit' => 'month'
])->get_id();
}
}
sehemu za upanuzi za v2.13.0
Ultimate Multisite v2.13.0 inaongeza sehemu kadhaa za upanuzi ambazo ni muhimu kwa addons zinazounganishwa na wapangaji huru, domains za checkout, au otomatiki ya DNS ya watoa huduma wa host.
SSO na URLs za usimamizi wa tovuti kuu
Use wu_with_sso($url) when linking customers across domains, especially when a sovereign tenant launches a main-site account, checkout, billing, invoice, template-switching, site-management, or domain-mapping action. The generated URL can be adjusted with wu_sso_url:
add_filter('wu_sso_url', function($sso_url, $user, $site_id, $redirect_to) {
return add_query_arg('source', 'my-addon', $sso_url);
}, 10, 4);
Domains za msingi za fomu ya checkout
Tumia wu_checkout_form_base_domains wakati addon yako inatoa domains za msingi za pamoja za ziada ambazo zinapaswa kufanya kazi kama domains za Site URL za fomu ya checkout badala ya mipangilio maalum ya kila tovuti:
add_filter('wu_checkout_form_base_domains', function($domains) {
$domains[] = 'sites.example.com';
return $domains;
});
Ultimate Multisite husawazisha hosts hizi na huruka rekodi za kiotomatiki za domain zilizopangwa kwa kila tovuti kwa ajili yake.
Uundaji wa kiotomatiki wa rekodi za domain
Tumia wu_should_create_domain_record_for_site wakati addon yako inahitaji kuzuia au kuahirisha uundaji wa kiotomatiki wa rekodi ya domain kwa tovuti iliyoundwa hivi karibuni:
add_filter('wu_should_create_domain_record_for_site', function($create, $site) {
$domain = (string) $site->domain;
if ('.internal.example' === substr($domain, -strlen('.internal.example'))) {
return false;
}
return $create;
}, 10, 2);
Miunganisho ya watoa huduma wa host inayosikiliza wu_add_subdomain inaweza kuunda rekodi za DNS upande wa mtoa huduma wakati tovuti zinaundwa. Ikiwa hakuna muunganisho uliosajiliwa kwa hatua hiyo, Ultimate Multisite huruka kazi tupu ya chinichini.
Hatua Zinazofuata
- Kagua Rejeleo la Hooks kwa actions na filters zinazopatikana
- Angalia Muhtasari wa REST API kwa muunganisho wa API
- Tumia Kiolezo cha Addon kama scaffold ya kuanzia