چگونه از APIهای وردپرس برای توسعه استفاده کنیم

سلام خدمت تمامی همراهان و کاربران وب سایت رایهام وب، امیدواریم حالتون عالی باشه. در این مقاله قصد داریم که راجب چگونه از APIهای وردپرس برای توسعه ویژگی‌های سفارشی استفاده کنیم.

مدت زمان مطالعه: ۱۰ دقیقه

وردپرس یکی از محبوب‌ترین سیستم‌های مدیریت محتوا (CMS) در جهان است که به دلیل انعطاف‌پذیری و قابلیت‌های گسترده خود، به ویژه برای توسعه‌دهندگان وب، مورد استفاده قرار می‌گیرد. یکی از ابزارهای قدرتمندی که وردپرس به توسعه‌دهندگان ارائه می‌دهد، APIهای مختلف آن است. APIها (رابط‌های برنامه‌نویسی کاربردی) امکان ایجاد و توسعه ویژگی‌های سفارشی و ارتباط با سایر سیستم‌ها را فراهم می‌کنند. در این مقاله، به بررسی نحوه استفاده از APIهای وردپرس برای توسعه ویژگی‌های سفارشی می‌پردازیم.

APIهای اصلی وردپرس

وردپرس مجموعه‌ای از APIهای مختلف را ارائه می‌دهد که هر کدام برای هدف خاصی طراحی شده‌اند. مهم‌ترین APIهای وردپرس عبارتند از:

REST API

REST API یکی از قدرتمندترین APIهای وردپرس است که امکان ارتباط با وردپرس از طریق درخواست‌های HTTP را فراهم می‌کند. با استفاده از این API، می‌توانید داده‌ها را از وردپرس دریافت کرده و یا داده‌های جدید به آن اضافه کنید.

Plugins API

این API به شما امکان می‌دهد تا افزونه‌های سفارشی ایجاد کرده و آن‌ها را به راحتی در وردپرس نصب کنید. با استفاده از این API، می‌توانید عملکردهای جدید به سایت خود اضافه کنید.

Settings API

Settings API به شما اجازه می‌دهد تا صفحات تنظیمات سفارشی ایجاد کنید. این API برای افزودن گزینه‌های تنظیمات به افزونه‌ها و تم‌ها بسیار مفید است.

Widgets API

با استفاده از Widgets API می‌توانید ویجت‌های سفارشی ایجاد کرده و آن‌ها را در نواحی ویجت سایت خود قرار دهید. این API برای افزودن محتوای داینامیک به نوار کناری یا فوتر سایت بسیار کاربردی است.

Shortcode API

Shortcode API به شما امکان می‌دهد تا کدهای کوتاه سفارشی ایجاد کرده و آن‌ها را در صفحات و پست‌های وردپرس استفاده کنید. این API برای افزودن محتوای داینامیک به مطالب بسیار مفید است.

استفاده از REST API

REST API یکی از پرکاربردترین APIهای وردپرس است که به توسعه‌دهندگان اجازه می‌دهد تا از طریق درخواست‌های HTTP با وردپرس تعامل داشته باشند.

مطلبی که شاید براتون مفید باشه گوگل دنس چیست-دنس گوگل چیه؟

دریافت داده‌ها

برای دریافت داده‌ها از وردپرس با استفاده از REST API، می‌توانید از درخواست‌های GET استفاده کنید. به عنوان مثال، برای دریافت لیستی از پست‌ها، می‌توانید از URL زیر استفاده کنید:

https://example.com/wp-json/wp/v2/posts

این درخواست یک لیست از پست‌های موجود در سایت را برمی‌گرداند. شما می‌توانید پارامترهای مختلفی را به درخواست اضافه کنید تا نتایج را فیلتر کنید.

ارسال داده‌ها

برای ارسال داده‌ها به وردپرس، می‌توانید از درخواست‌های POST استفاده کنید. به عنوان مثال، برای ایجاد یک پست جدید، می‌توانید از کد زیر استفاده کنید:

				
					php
$url = 'https://example.com/wp-json/wp/v2/posts';
$data = array(
    'title' => 'عنوان پست',
    'content' => 'محتوای پست',
    'status' => 'publish'
);

$options = array(
    'http' => array(
        'header'  => "Content-type: application/json\r\n",
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);

این کد یک پست جدید با عنوان و محتوای مشخص شده ایجاد می‌کند.

استفاده از Plugins API

Plugins API به شما امکان می‌دهد تا افزونه‌های سفارشی ایجاد کنید و عملکردهای جدید به وردپرس اضافه کنید.

ایجاد افزونه جدید

برای ایجاد یک افزونه جدید، ابتدا باید یک پوشه در دایرکتوری wp-content/plugins ایجاد کرده و فایل اصلی افزونه را در آن قرار دهید. به عنوان مثال، فایل my-plugin.php را ایجاد کنید و کد زیر را در آن قرار دهید:

				
					php
<?php
/*
Plugin Name: My Custom Plugin
Description: این افزونه یک مثال ساده برای ایجاد افزونه سفارشی است.
Version: 1.0
Author: Your Name
*/

// کد افزونه سفارشی شما اینجا قرار می‌گیرد.
?>

افزودن عملکرد به افزونه

در فایل افزونه خود، می‌توانید عملکردهای سفارشی اضافه کنید. به عنوان مثال، برای افزودن یک منوی سفارشی به نوار مدیریت وردپرس، می‌توانید از کد زیر استفاده کنید:

				
					php
add_action('admin_menu', 'my_custom_menu');

function my_custom_menu() {
    add_menu_page(
        'My Custom Page',
        'Custom Menu',
        'manage_options',
        'my-custom-page',
        'my_custom_page_callback'
    );
}

function my_custom_page_callback() {
    echo '<h1>این یک صفحه سفارشی است</h1>';
}

این کد یک منوی سفارشی به نوار مدیریت وردپرس اضافه می‌کند که با کلیک بر روی آن، صفحه سفارشی نمایش داده می‌شود.

استفاده از Settings API

Settings API به شما اجازه می‌دهد تا صفحات تنظیمات سفارشی ایجاد کنید

ایجاد صفحه تنظیمات

برای ایجاد یک صفحه تنظیمات سفارشی، ابتدا باید یک تابع ایجاد کنید و آن را به هوک admin_menu اضافه کنید:

				
					php
add_action('admin_menu', 'my_custom_settings_page');

function my_custom_settings_page() {
    add_options_page(
        'تنظیمات سفارشی من',
        'تنظیمات سفارشی',
        'manage_options',
        'my-custom-settings',
        'my_custom_settings_page_callback'
    );
}

function my_custom_settings_page_callback() {
    echo '<h1>این یک صفحه تنظیمات سفارشی است</h1>';
}

افزودن فیلدهای تنظیمات

برای افزودن فیلدهای تنظیمات به صفحه سفارشی، باید از هوک admin_init استفاده کنید و فیلدهای مورد نظر را ثبت کنید:

				
					php
add_action('admin_init', 'my_custom_settings');

function my_custom_settings() {
    register_setting('my_custom_settings_group', 'my_custom_setting');
    
    add_settings_section(
        'my_custom_settings_section',
        'تنظیمات بخش سفارشی',
        'my_custom_settings_section_callback',
        'my-custom-settings'
    );
    
    add_settings_field(
        'my_custom_setting_field',
        'فیلد تنظیمات سفارشی',
        'my_custom_setting_field_callback',
        'my-custom-settings',
        'my_custom_settings_section'
    );
}

function my_custom_settings_section_callback() {
    echo 'توضیحی برای بخش تنظیمات سفارشی.';
}

function my_custom_setting_field_callback() {
    $setting = get_option('my_custom_setting');
    echo "<input type='text' name='my_custom_setting' value='$setting' />";
}

استفاده از Widgets API

Widgets API به شما امکان می‌دهد تا ویجت‌های سفارشی ایجاد کنید.

ایجاد ویجت سفارشی

برای ایجاد یک ویجت سفارشی، باید یک کلاس ایجاد کنید که از WP_Widget ارث‌بری کند و متدهای لازم را پیاده‌سازی کند:

				
					`php
class My_Custom_Widget extends WP_Widget {
    
    function construct() {
        parent::construct(
            'my_custom_widget',
            'ویجت سفارشی من',
            array('description' => 'این یک ویجت سفارشی است')
        );
    }
    
    public function widget($args, $instance) {
        echo $args['before_widget'];
        echo '<h2>' . apply_filters('widget_title', $instance['title']) . '</h2>';
        echo '<p>' . $instance['text'] . '</p>';
        echo $args['after_widget'];
    }
    
    public function form($instance) {
        $title = !empty($instance['title']) ? $instance['title'] : '';
        $text = !empty($instance['text']) ? $instance['text'] : '';
        ?>
        <p>
            <label for="<?php echo $this->get_field_id('title'); ?>">عنوان:</label>
            <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($title); ?>">
        </p>
        <p>
            <label for="<?php echo $this->get_field_id('text'); ?>">متن:</label>
            <textarea class="widefat" id="<?php echo $this->get_field_id('text'); ?>" name="<?php echo $this->get_field_name('text'); ?>"><?php echo esc_attr($text); ?></textarea>
        </p>
        <?php
    }
    
    public function update($new_instance, $old_instance) {
        $instance = array();
        $
        php
        $instance['title'] = (!empty($new_instance['title'])) ? strip_tags($new_instance['title']) : '';
        $instance['text'] = (!empty($new_instance['text'])) ? sanitize_text_field($new_instance['text']) : '';

        return $instance;
    }
}

// ثبت ویجت
function register_my_custom_widget() {
    register_widget('My_Custom_Widget');
}
add_action('widgets_init', 'register_my_custom_widget');

استفاده از Shortcode API

Shortcode API به شما امکان می‌دهد تا کدهای کوتاه سفارشی ایجاد کرده و از آن‌ها در پست‌ها و صفحات استفاده کنید.

ایجاد شورت‌کد سفارشی

برای ایجاد یک شورت‌کد سفارشی، باید تابعی ایجاد کنید که محتوای شورت‌کد را برگرداند و سپس آن را ثبت کنید:

				
					php
function my_custom_shortcode($atts, $content = null) {
    $atts = shortcode_atts(
        array(
            'title' => 'عنوان پیش‌فرض',
        ),
        $atts,
        'my_shortcode'
    );

    return '<h2>' . esc_html($atts['title']) . '</h2><p>' . $content . '</p>';
}
add_shortcode('my_shortcode', 'my_custom_shortcode');

اکنون می‌توانید از شورت‌کد [my_shortcode title=”عنوان سفارشی”]محتوای شما[/my_shortcode] در پست‌ها و صفحات وردپرس استفاده کنید.

استفاده از Settings API

Settings API به شما امکان می‌دهد تا صفحات تنظیمات سفارشی برای افزونه‌ها و تم‌ها ایجاد کنید.

ایجاد صفحه تنظیمات

برای ایجاد یک صفحه تنظیمات، باید یک تابع ایجاد کنید و آن را به هوک admin_menu اضافه کنید:

				
					php
add_action('admin_menu', 'my_custom_settings_page');

function my_custom_settings_page() {
    add_options_page(
        'تنظیمات سفارشی من',
        'تنظیمات سفارشی',
        'manage_options',
        'my-custom-settings',
        'my_custom_settings_page_callback'
    );
}

function my_custom_settings_page_callback() {
    echo '<h1>این یک صفحه تنظیمات سفارشی است</h1>';
}

افزودن فیلدهای تنظیمات

برای افزودن فیلدهای تنظیمات به صفحه سفارشی، باید از هوک admin_init استفاده کنید و فیلدهای مورد نظر را ثبت کنید:

				
					php
add_action('admin_init', 'my_custom_settings');

function my_custom_settings() {
    register_setting('my_custom_settings_group', 'my_custom_setting');
    
    add_settings_section(
        'my_custom_settings_section',
        'تنظیمات بخش سفارشی',
        'my_custom_settings_section_callback',
        'my-custom-settings'
    );
    
    add_settings_field(
        'my_custom_setting_field',
        'فیلد تنظیمات سفارشی',
        'my_custom_setting_field_callback',
        'my-custom-settings',
        'my_custom_settings_section'
    );
}

function my_custom_settings_section_callback() {
    echo 'توضیحی برای بخش تنظیمات سفارشی.';
}

function my_custom_setting_field_callback() {
    $setting = get_option('my_custom_setting');
    echo "<input type='text' name='my_custom_setting' value='$setting' />";
}

استفاده از Widgets API

Widgets API به شما امکان می‌دهد تا ویجت‌های سفارشی ایجاد کنید و آن‌ها را به نواحی ویجت سایت اضافه کنید.

ایجاد ویجت سفارشی

برای ایجاد یک ویجت سفارشی، باید یک کلاس ایجاد کنید که از WP_Widget ارث‌بری کند و متدهای لازم را پیاده‌سازی کند:

				
					`php
class My_Custom_Widget extends WP_Widget {
    
    function construct() {
        parent::construct(
            'my_custom_widget',
            'ویجت سفارشی من',
            array('description' => 'این یک ویجت سفارشی است')
        );
    }
    
    public function widget($args, $instance) {
        echo $args['before_widget'];
        echo '<h2>' . apply_filters('widget_title', $instance['title']) . '</h2>';
        echo '<p>' . $instance['text'] . '</p>';
        echo $args['after_widget'];
    }
    
    public function form($instance) {
        $title = !empty($instance['title']) ? $instance['title'] : '';
        $text = !empty($instance['text']) ? $instance['text'] : '';
        ?>
        <p>
            <label for="<?php echo $this->get_field_id('title'); ?>">عنوان:</label>
            <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($title); ?>">
        </p>
        <p>
            <label for="<?php echo $this->get_field_id('text'); ?>">متن:</label>
            <textarea class="widefat" id="<?php echo $this->get_field_id('text'); ?>" name="<?php echo $this->get_field_name('text'); ?>"><?php echo esc_attr($text); ?></textarea>
        </p>
        <?php
    }
    
    public function update($new_instance, $old_instance) {
        $instance = array();
        $instance['title'] = (!empty($new_instance['title'])) ? strip_tags($new_instance['title']) : '';
        $instance['text'] = (!empty($new_instance['text'])) ? sanitize_text_field($new_instance['text']) : '';
        return $instance;
    }
}

// ثبت ویجت
function register_my_custom_widget() {
    register_widget('My_Custom_Widget');
}
add_action('widgets_init', 'register_my_custom_widget');
`

این کد یک ویجت سفارشی ایجاد می‌کند که می‌توانید آن را به نواحی ویجت سایت خود اضافه کنید.

نتیجه‌گیری

APIهای وردپرس ابزارهای قدرتمندی هستند که به توسعه‌دهندگان امکان می‌دهند ویژگی‌های سفارشی به سایت‌های وردپرسی اضافه کنند. از REST API برای ارتباط با وردپرس از طریق درخواست‌های HTTP گرفته تا Plugins API برای ایجاد افزونه‌های سفارشی، هر یک از این APIها قابلیت‌های ویژه‌ای دارند که می‌توانند تجربه کاربری و عملکرد سایت را بهبود بخشند. با بهره‌گیری از این APIها، می‌توانید سایت‌های وردپرسی خود را به سطح جدیدی از عملکرد و کارایی برسانید.