関数リファレンス/wp register style

このページ「関数リファレンス/wp register style」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています。

説明

後で wp_enqueue_style() に渡すために、CSS スタイルファイルを安全に登録します。

使い方

<?php wp_register_style( $handle, $src, $deps, $ver, $media ); ?>

重要: アクション wp_enqueue_scripts /en を使ってこの関数を呼び出してください。 アクションではないところから呼び出すと問題を引き起こす場合があります。詳しくは Trac チケット #17916 を見てください。

パラメータ

$handle

（文字列） （必須） スタイルシートの名称（これは全システムのなかでスクリプトを識別するために用いられるため、一意であるべきです。）

初期値： なし

$src

（文字列） （必須） スタイルシートのURL。 例: 'http://example.com/css/mystyle.css'. あなたは、ローカルなスタイルをハードコードするべきではありません。 例えば: plugins_url() (プラグインの場合) または get_template_directory_uri() (テーマの場合) を用いて、適切なURLを取得できます。リモートの要素はプロトコルに依存しないURLで記述できます。つまり、 '//otherdomain.com/css/theirstyle.css' といった形式です。

初期値： なし

$deps

（array） （オプション） このスタイルシートが依存する他のスタイルシートのハンドル配列、つまり、このスタイルシートより前に読み込まれる必要があるスタイルシート。依存関係がない場合は空の配列を指定。

初期値： array()

$ver

（文字列|真偽値） （optional） スタイルシートのバージョン番号を指定する文字列 (存在する場合) 。このパラメータはキャッシングに関わらず正しいバージョンがクライアントに送信されるようにするために使います。したがって、バージョン番号があってそれがスタイルシートに意味を持つ場合は含めるべきであす。バージョンは、クエリ文字列としてスタイルシートURLに、例えば ?ver=3.5.1のように追加されます。初期値またはfalseの場合、WordPressのバージョン文字列が使われます。もしもnullの場合、URLに追加しなくなります。

初期値： false

$media

（文字列|真偽値） （オプション） スタイルシートが定義されているメディアを指定する文字列。例: 'all'、'screen'、'handheld'、'print'。有効な CSS-media-types の全容についてはこちらの一覧を参照してください。

初期値： 'all'

Return Values

(bool)

Whether the style has been registered. True on success, false on failure.

Examples

In a Plugin (outside a PHP class)

// Register style sheet.
add_action( 'wp_enqueue_scripts', 'register_plugin_styles' );

/**
 * Register style sheet.
 */
function register_plugin_styles() {
	wp_register_style( 'my-plugin', plugins_url( 'my-plugin/css/plugin.css' ) );
	wp_enqueue_style( 'my-plugin' );
}

• Assumes the Plugin directory is named 'my-plugin'.
• Assumes the Plugin style sheet is named 'plugin.css'.

In a Plugin (inside a PHP class)

class my_plugin {

	/**
	 * @TODO Add class constructor description.
	 */
	function __construct() {
		// Register style sheet.
		add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) );
	}

	/**
	 * Register and enqueue style sheet.
	 */
	public function register_plugin_styles() {
		wp_register_style( 'my-plugin', plugins_url( 'my-plugin/css/plugin.css' ) );
		wp_enqueue_style( 'my-plugin' );
	}
}

• Assumes the Plugin class name is 'my_plugin'.
• Assumes the Plugin directory is named 'my-plugin'.
• Assumes the Plugin style sheet is named 'plugin.css'.

Notes

• Uses global: (WP_Styles /en object) $wp_styles
• See wp_default_styles() in wp-includes/script-loader.php for a complete list of styles WordPress registers by default.

Change Log

• Since: 2.1 (BackPress version: r79)

Source File

wp_register_style() is located in wp-includes/functions.wp-styles.php.

Resources

• WordPress Style Registration Generator

Related

• エンキュー関数:
  • スクリプト:wp_register_script(),wp_deregister_script(), wp_enqueue_script(), wp_dequeue_script() /en, wp_script_is() /en, wp_localize_script(), wp_enqueue_media()
  • スタイル: wp_register_style(),wp_deregister_style() /en,wp_enqueue_style(),wp_dequeue_style(), wp_style_is() /en

• エンキューアクション:
  • フロントエンド: wp_enqueue_scripts /en, wp_print_scripts /en, wp_print_styles /en
  • 管理画面: admin_enqueue_scripts /en, admin_print_scripts / en, admin_print_styles /en
  • ログイン: login_enqueue_scripts /en

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/wp register style （最新版との差分）

最新英語版: Reference / Functions / wp_register_style()