WordPress.org

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/fa load plugin textdomain

فارسیUser:iEhsan.ir/fa_load_plugin_textdomain

This article is a ROUGH DRAFT. The author is still working on this document, so please do not edit this without the author's permission. The content within this article may not yet be verified or valid. This information is subject to change.

This article is in Persian and article need to be "Right-to-Left" (RTL)

توضیحات

این تابع، فایل‌های زبان مربوط به افزونه را باز و به سیستم معرفی می‌کند.

اگر مسیری به این تابع داده نشود، تابع در دایرکتوری خود افزونه به دنبال فایل زبان (mo) خواهد گشت. نام‌گذاری فایل mo بر اساس نامک افزونه (Slug) و شناسه‌ی زبان (تعریف‌شده در WPLANG) صورت می‌گیرد. برای مثال، شناسه‌ی زبان پارسی 'fa_IR' و زبان آلمانی 'de_DE' است. در صورتی که شناسه‌ی دامنه متنی (Text Domain ID) شما my-plugin باشد و زبان وردپرس شما fa_IR

باشد، این تابع به دنبال فایل 'my-plugin-fa_IR.mo' خواهد گشت.

در صورتی که شما این تابع در چندین زمان مختلف فراخوانی کنید، فایل‌های زبان با یکدیگر ترکیب (Merge) خواهند شد.

نحوه‌ی استفاده

<?php load_plugin_textdomain$domain$abs_rel_path$plugin_rel_path ?>

پارامترها

$domain
(string) (required) شناسه‌ی یکتا برای برگرداندن رشته‌ها
Default: None
$abs_rel_path
(string) (optional) مسیر Relative به دایرکتوری فایل‌های زبان. این پارامتر کارایی ندارد و حذف شده، ولی تا نسخه‌ی 2.7 پشتیبانی می‌شود. باید برای آن مقدار false قرار دهید
Default: false
$plugin_rel_path
(string) (optional) مسیر Relative به دایرکتوری فایل‌های زبان. این نشانی باید با اسلش (/) تمام شود
Default: false

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

boolean 
در صورتی که فایل زبان به‌درستی باز شود و به سیستم وردپرس متصل شود، مقدار true بازمی‌گرداند و در غیر این صورت مقدار false.

مثال

add_action( 'plugins_loaded', 'myplugin_load_textdomain' );
/**
 * Load plugin textdomain.
 *
 * @since 1.0.0
 */
function myplugin_load_textdomain() {
  load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/langs/' ); 
}

مرتبط با این نوشته

Localization: get_locale(), load_textdomain(), load_default_textdomain(), load_plugin_textdomain(), load_theme_textdomain()

See also index of Function Reference and index of Template Tags.