تابع wp_logout_url در وردپرس

در وردپرس، یکی از نیازهای معمول توسعه‌دهندگان، ایجاد امکان خروج کاربر از سیستم (Logout) است. تابع wp_logout_url() یکی از توابع داخلی وردپرس است که برای این منظور طراحی شده و به سادگی لینک خروج کاربر را برمی‌گرداند. در این آموزش، به بررسی نحوه کارکرد، پارامترها، مثال‌های کاربردی و بهترین شیوه‌های استفاده از این تابع خواهیم پرداخت.

تابع `wp_logout_url()` چیست؟

تابع wp_logout_url() یک URL (آدرس اینترنتی) تولید می‌کند که کاربر را پس از کلیک روی آن از حساب کاربری خارج می‌کند. به طور پیش‌فرض، پس از خروج، کاربر به صفحه ورود (login) هدایت می‌شود؛ اما شما می‌توانید مسیر بازگشت (redirect) را با استفاده از پارامتر تابع مشخص کنید.

ساختار تابع

wp_logout_url( string $redirect = '' )

توضیح پارامترها

نام پارامتر	نوع داده	توضیح
`$redirect`	`string`	آدرس URL که کاربر پس از خروج به آن هدایت می‌شود. اگر خالی باشد، وردپرس به صفحه ورود هدایت می‌کند.

مقدار بازگشتی

این تابع یک رشته (string) بازمی‌گرداند که شامل آدرس خروج از سیستم است.

مثال ساده از استفاده تابع `wp_logout_url()`

<a href="">خروج از حساب</a>

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

افزودن مسیر بازگشت سفارشی پس از خروج

گاهی اوقات نیاز دارید کاربر پس از خروج به صفحه خاصی از سایت هدایت شود؛ برای مثال صفحه اصلی یا صفحه تشکر. در این حالت می‌توانید از پارامتر $redirect استفاده کنید:

<a href="">خروج و بازگشت به صفحه اصلی</a>

در این کد، از تابع home_url() برای بازگشت به صفحه اصلی سایت پس از خروج استفاده شده است. به این ترتیب تجربه کاربری بهتری برای بازدیدکنندگان فراهم می‌شود.

استفاده از تابع در منوی ناوبری یا قالب

شما می‌توانید از تابع wp_logout_url() در منوی ناوبری، سایدبار یا هر بخش از قالب استفاده کنید تا کاربران بتوانند به سادگی از حساب خود خارج شوند. برای مثال:

<?php if ( is_user_logged_in() ) : ?>
    <a href="">خروج</a>
<?php else : ?>
    <a href="">ورود</a>
<?php endif; ?>

در این مثال، بررسی می‌شود که آیا کاربر وارد سیستم شده است یا خیر. اگر وارد شده باشد، لینک خروج نمایش داده می‌شود و در غیر این صورت، لینک ورود نمایش داده خواهد شد. این روش در منوهای سفارشی بسیار پرکاربرد است.

توضیح منطق کد بالا

is_user_logged_in(): بررسی می‌کند که کاربر وارد سیستم شده یا نه.
wp_logout_url(): لینک خروج از سیستم را برمی‌گرداند.
wp_login_url(): لینک ورود را برمی‌گرداند.
get_permalink(): لینک صفحه جاری را برای بازگشت پس از خروج استفاده می‌کند.

ایجاد دکمه خروج در منوی ناوبری با استفاده از فیلتر `wp_nav_menu_items`

اگر بخواهید دکمه خروج را به صورت پویا در منوی وردپرس اضافه کنید، می‌توانید از فیلتر wp_nav_menu_items استفاده کنید:

add_filter( 'wp_nav_menu_items', 'add_logout_link_to_menu', 10, 2 );

function add_logout_link_to_menu( $items, $args ) {
    if ( is_user_logged_in() && $args->theme_location === 'primary' ) {
        $items .= '<li><a href="' . wp_logout_url( home_url() ) . '">خروج</a></li>';
    }
    return $items;
}

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

نکات امنیتی هنگام استفاده از `wp_logout_url()`

همیشه از تابع esc_url() هنگام نمایش آدرس خروج استفاده کنید تا از بروز حملات XSS جلوگیری شود.
از ایجاد لینک‌های خروج در بخش‌هایی که برای کاربران ناشناس در دسترس است، پرهیز کنید.
در صورت استفاده از ریدایرکت، مطمئن شوید مسیر مقصد امن و داخلی است تا از حملات Open Redirect جلوگیری شود.

نمونه امن‌تر:

<a href="">خروج امن</a>

در این نسخه، از esc_url() برای امن‌سازی URL استفاده شده است. این کار جلوی تزریق اسکریپت در آدرس را می‌گیرد.

تفاوت `wp_logout_url()` با `wp_logout()`

تابع	کارکرد	زمان استفاده
`wp_logout_url()`	لینک خروج از سیستم را برمی‌گرداند (بدون اجرای خروج واقعی).	وقتی می‌خواهید در قالب یا منو لینک خروج نمایش دهید.
`wp_logout()`	کاربر را بلافاصله از سیستم خارج می‌کند.	زمانی که می‌خواهید خروج را به صورت خودکار در پردازش PHP اجرا کنید (مثلاً در یک هوک).

نمونه کاربردی: خروج خودکار کاربر پس از انجام عملیات خاص

فرض کنید می‌خواهید کاربر پس از تغییر رمز عبور به صورت خودکار از سیستم خارج شود. در این حالت می‌توانید از تابع wp_logout() درون یک هوک استفاده کنید:

add_action( 'after_password_reset', 'auto_logout_after_reset', 10, 2 );

function auto_logout_after_reset( $user, $new_pass ) {
    wp_logout();
    wp_redirect( home_url( '/login/' ) );
    exit;
}

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

جمع‌بندی و بهترین شیوه‌ها

برای نمایش لینک خروج از تابع wp_logout_url() استفاده کنید، نه wp_logout().
همیشه URL خروج را با esc_url() ایمن کنید.
برای تجربه کاربری بهتر، مسیر بازگشت مناسب (مثلاً home_url()) تعیین کنید.
از ترکیب با is_user_logged_in() برای نمایش شرطی لینک استفاده کنید.
در منوها یا نوارهای بالا، از فیلتر wp_nav_menu_items جهت افزودن لینک پویا بهره ببرید.

نتیجه‌گیری

تابع wp_logout_url() ابزاری ساده اما بسیار کاربردی برای مدیریت خروج کاربران در وردپرس است. با درک نحوه عملکرد و رعایت نکات امنیتی، می‌توانید تجربه‌ای کاربرپسند، ایمن و حرفه‌ای برای بازدیدکنندگان سایت خود فراهم کنید. این تابع یکی از پایه‌های اساسی در طراحی سیستم‌های کاربری سفارشی، پنل‌های اعضا و قالب‌های پیشرفته وردپرس محسوب می‌شود.

آیا این مطلب برای شما مفید بود ؟

خیر

بله