• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「テンプレートタグ/get permalink」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(使い方)
(残りを和訳しました。)
1行目: 1行目:
{{NeedTrans|一部}}
+
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 +
</div>
  
[[Glossary#PHP|PHP]] で使う用途の、投稿または固定ページの [[Glossary#パーマリンク|パーマリンク]] を取得します。このタグはパーマリンクを出力'''しません'''。[[ループ]] の外で使うことができます。失敗した場合は <code>false</code> を返します。
+
[[Glossary#PHP|PHP]] で使えるように、投稿または固定ページの [[Glossary#パーマリンク|パーマリンク]] を取得します。このタグはパーマリンクを出力'''しません'''。[[ループ]] の外で使うことができます。失敗した場合は <code>false</code> を返します。
  
In a Plugin or Theme, it can be used as early as the [[Plugin_API/Action_Reference/setup_theme|setup_theme]] Action. Any earlier usage, including [[Plugin_API/Action_Reference/plugins_loaded|plugins_loaded]], generates a Fatal Error.
+
プラグインやテーマの中では、[[プラグイン API/アクションフック一覧/setup_theme|setup_theme]]/[[:en:Plugin_API/Action_Reference/setup_theme|en]] アクション以降に使用できます。これ以前([[プラグイン API/アクションフック一覧/plugins_loaded|plugins_loaded]]/[[:en:Plugin_API/Action_Reference/plugins_loaded|en]] を含む)は、回復不可能なエラーを発生します。
  
IDパラメーターを指定せずに一覧ページ(インデックスやアーカイブなど)のループの外側で使用した場合、現在の表示しているページのパーマリンク'''ではなく'''ループの一番最後の投稿のURLを返すことに注意してください。参照: http://core.trac.wordpress.org/ticket/9963
+
'''注意''': パラメータの ID を指定せずに一覧ページ(インデックスやアーカイブなど)の[[ループ]]の外側で使用した場合、現在の表示しているページのパーマリンク'''ではなく'''、ループの一番最後の投稿の URL を返します。Trac [http://core.trac.wordpress.org/ticket/9963 チケット 9963] を参照してください。
  
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
  
 
  <?php $permalink = get_permalink( $id, $leavename ); ?>
 
  <?php $permalink = get_permalink( $id, $leavename ); ?>
  
== 引数 ==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$id|複合|投稿または固定ページの整数型のID、あるいは投稿オブジェクト|オプション|[[ループ]]内で使用した場合、表示中の投稿のID。}}
+
{{Parameter|$id|複合|投稿または固定ページの整数型の ID、あるいは投稿オブジェクト|オプション|[[ループ]]内で使用した場合、表示中の投稿の ID。}}
{{Parameter|$leavename|論理値|投稿名あるいは固定ページ名(注:%postname%)を保持するかどうか。<tt>true</tt>の場合、実際のURIではなく構造的なリンクを返します。 例: <tt><nowiki>http://www.example.com/my-post</nowiki></tt>ではなく<tt><nowiki>http://www.example.com/%postname%</nowiki></tt>|オプション|<tt>false</tt>}}
+
{{Parameter|$leavename|真偽値|投稿名あるいは固定ページ名(注: <tt>%postname%</tt>)を保持するかどうか。<tt>true</tt>の場合、実際の URI ではなく構造的なリンクを返します。 例: <tt><nowiki>http://www.example.com/my-post</nowiki></tt> ではなく <tt><nowiki>http://www.example.com/%postname%</nowiki></tt>|オプション|<tt>false</tt>}}
  
 +
<div id="Return_Values">
 
== 戻り値 ==
 
== 戻り値 ==
; (文字列|論理値) : パーマリンクURLまたは <tt>false</tt> (ページが存在しない場合)。
+
</div>
  
 +
; (文字列|真偽値) : パーマリンクの URL。失敗すると <tt>false</tt>(ページが存在しない場合)。
 +
 +
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 +
</div>
  
<pre>
 
 
  <a href="<?php echo get_permalink( 268 ); ?>">My link to a post or page</a>
 
  <a href="<?php echo get_permalink( 268 ); ?>">My link to a post or page</a>
</pre>
 
  
 +
<div id="Default_Usage">
 
=== デフォルトの使い方 ===
 
=== デフォルトの使い方 ===
 +
</div>
  
(ループ内で使用される)現在の投稿のパーマリンク。このタグはパーマリンクを出力しないので、この例ではPHPのechoコマンドを使用しています。
+
([[ループ]]内で使用される)現在の投稿のパーマリンク。このタグはパーマリンクを出力しないので、この例では PHP の echo コマンドを使用しています。
  
 
<pre>
 
<pre>
Permalink for this post:
+
Permalink for this post:
<?php echo get_permalink(); ?>
+
<?php echo get_permalink(); ?>
 
</pre>
 
</pre>
  
 +
<div id="Link_to_Specific_Post">
 
=== 特定の投稿へのリンク ===
 
=== 特定の投稿へのリンク ===
 +
</div>
  
関連情報の一覧の中のハイパーリンクとして、2つの特定の投稿(post IDが1と10)のパーマリンクを返しています。上記のようにこのタグはパーマリンクを出力しないので PHP の echo コマンドを使用しています。
+
あるお知らせリストの中に、特定の投稿 2 つ(投稿 ID が 1 と 10)のパーマリンクを出力します。上の例と同様に、パーマリンクを表示するために PHP の echo コマンドを使用しています。
  
 
<pre>
 
<pre>
50行目: 62行目:
 
</pre>
 
</pre>
  
=== IDの代わりに投稿のオブジェクトを渡す ===
+
<div id="Pass_in_a_post_object_instead_of_an_ID">
投稿のIDの代わりにページタイトルを使ってパーマリンクを取得する方法です。
+
=== ID の代わりに投稿オブジェクトを渡す ===
<pre><a href="<?php echo esc_url( get_permalink( get_page_by_title( 'Monthly Events' ) ) ); ?>">Monthly Events</a></pre>
+
</div>
  
 +
投稿 ID の代わりにページタイトルを使ってパーマリンクを取得する方法です。
 +
 +
<pre>
 +
<a href="<?php echo esc_url( get_permalink( get_page_by_title( 'Monthly Events' ) ) ); ?>">Monthly Events</a>
 +
</pre>
 +
 +
<div id="Change_Log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 +
</div>
  
Since: 1.0.0
+
1.0.0 : 新規導入
  
 +
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
 +
</div>
  
<tt>get_permalink()</tt> is located in {{Trac|wp-includes/link-template.php}}.
+
<tt>get_permalink()</tt> {{Trac|wp-includes/link-template.php}} にあります。
  
== 関連項目 ==
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
 
{{Permalink Tags}}
 
{{Permalink Tags}}
 
{{原文|Function Reference/get_permalink|146138}}<!-- 01:48, 27 August 2014 Adiant 版 -->
 
  
 
{{Tag Footer}}
 
{{Tag Footer}}
 +
 +
{{原文|Function Reference/get_permalink|146138}} <!-- 01:48, 27 August 2014 Adiant 版 -->
 +
 +
{{DEFAULTSORT:Get_permalink}}
 +
[[Category:テンプレートタグ]]
 +
 +
[[en:Template Tags/get_permalink]]

2015年5月26日 (火) 00:26時点における版

PHP で使えるように、投稿または固定ページの パーマリンク を取得します。このタグはパーマリンクを出力しませんループ の外で使うことができます。失敗した場合は false を返します。

プラグインやテーマの中では、setup_theme/en アクション以降に使用できます。これ以前(plugins_loaded/en を含む)は、回復不可能なエラーを発生します。

注意: パラメータの ID を指定せずに一覧ページ(インデックスやアーカイブなど)のループの外側で使用した場合、現在の表示しているページのパーマリンクではなく、ループの一番最後の投稿の URL を返します。Trac チケット 9963 を参照してください。

使い方

<?php $permalink = get_permalink( $id, $leavename ); ?>

パラメータ

$id
複合) (オプション) 投稿または固定ページの整数型の ID、あるいは投稿オブジェクト
初期値: ループ内で使用した場合、表示中の投稿の ID。
$leavename
真偽値) (オプション) 投稿名あるいは固定ページ名(注: %postname%)を保持するかどうか。trueの場合、実際の URI ではなく構造的なリンクを返します。 例: http://www.example.com/my-post ではなく http://www.example.com/%postname%
初期値: false

戻り値

(文字列|真偽値) 
パーマリンクの URL。失敗すると false(ページが存在しない場合)。

用例

<a href="<?php echo get_permalink( 268 ); ?>">My link to a post or page</a>

デフォルトの使い方

ループ内で使用される)現在の投稿のパーマリンク。このタグはパーマリンクを出力しないので、この例では PHP の echo コマンドを使用しています。

Permalink for this post:
<?php echo get_permalink(); ?>

特定の投稿へのリンク

あるお知らせリストの中に、特定の投稿 2 つ(投稿 ID が 1 と 10)のパーマリンクを出力します。上の例と同様に、パーマリンクを表示するために PHP の echo コマンドを使用しています。

<ul>
<li>MyBlog info:
    <ul>
    <li><a href="<?php echo get_permalink(1); ?>">About MyBlog</a></li>
    <li><a href="<?php echo get_permalink(10); ?>">About the owner</a></li>
    </ul>
</li>
</ul>

ID の代わりに投稿オブジェクトを渡す

投稿 ID の代わりにページタイトルを使ってパーマリンクを取得する方法です。

<a href="<?php echo esc_url( get_permalink( get_page_by_title( 'Monthly Events' ) ) ); ?>">Monthly Events</a>

変更履歴

1.0.0 : 新規導入

ソースファイル

get_permalink()wp-includes/link-template.php にあります。


get_permalink(), the_permalink(), post_permalink(), permalink_anchor(), permalink_single_rss()


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


最新英語版: WordPress Codex » Function Reference/get_permalink最新版との差分