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

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

The Loop in Action

提供: WordPress Codex 日本語版
2018年8月25日 (土) 15:16時点におけるGblsm (トーク | 投稿記録)による版 (en:The Loop in Action 09:32, 10 April 2018 Ggueli 版をマージ(未訳)。)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

このページ「The Loop in Action」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

ページ名検討中: このページ名「The Loop in Action」について改名が提案されています。ご意見をお寄せください。

はじめに

ループ」は WordPress のメイン処理を参照する用語です。訪問者に WordPress の投稿を表示するためにテンプレートの中で使います。ループなしでもテンプレートを作れますが、1つの投稿からデータを表示することしかできません。

WordPress は最初に、必要なファイルがすべて揃っているか確認します。次にデータベースからブログ管理者によって定義されたデフォルト設定を取得します。これには1ページに表示する投稿数や、コメント機能が使用可能かどうかなどが含まれます。これらのデフォルト設定が揃ったら、WordPress はユーザが何を必要としているのかを確認します。この情報はどの投稿をデータベースから取得するか決めるために使われます。

ユーザが投稿、カテゴリ、ページ、日付を特に指定しなかったとき、WordPress はどの投稿かを決めるために先ほど取得したデフォルト値を使います。例えば、ブログ管理者が 管理画面/表示設定 で1ページに表示する最大投稿数を5に設定していた場合、 WordPress は最新 5 件の投稿をデータベースから取得します。ユーザが特定の投稿、カテゴリ、ページ、日付を指定したときは、WordPress はどの投稿(複数の場合もあります)をデータベースから取得するのか決めるためにその情報を使います。

以上の処理がすべて終わったら WordPress はデータベースに接続し、指定された情報を読み込み、結果を変数に保存します。そしてループはテンプレート内で表示するためにこの変数の値を使います。

デフォルトでは、訪問者が投稿、カテゴリ、ページ、日付を特に指定しなければ、WordPress はすべてを表示するために index.php を使います。この文書の前半では index.php およびデフォルトのブログ表示にのみ焦点を当てます。そして、どのように動くのか理解した後、他のテンプレートファイルでループを使用する方法などについて詳細に説明します。

もっとも単純なインデックスページ

下記のコードはシンプルではありますが、一通り機能するインデックスページです。各投稿のコンテンツ (本当に本文だけ) をループの状態に応じて表示します。これをお見せしたのはループを機能させるのに必要なものがどれだけ少ないかを示すためです。

<?php
get_header();
if (have_posts()) :
   while (have_posts()) :
      the_post();
      the_content();
   endwhile;
endif;
get_sidebar();
get_footer(); 
?>

index.php の大半はループの内容を装飾するための CSS、HTML、PHP 宣言と言えます。それではその装飾の部分を見ていきましょう。

デフォルトループ

以下では WordPress 1.5 に同梱されていた defaultclassic テーマを例に、1つずつループの使い方を見ていきます。

ループのはじまり

デフォルトの index.php テンプレートファイルの始めの方に、ループを開始するコードがあります。

<?php if (have_posts()) : ?>
<?php while (have_posts()) : the_post(); ?>
  1. はじめに have_posts() 関数を使って1つでも投稿が読み込まれたかどうかを確認します。
  2. 投稿があった場合、PHP の while ループが始まり、カッコ内の条件が真である限り実行されます。従って have_posts() 関数が真を返す限り、while ループは回り続けます(繰り返します)

have_posts() 関数は単純に投稿リストの次の投稿を確認します。もしまだあれば真を返しますし、それ以上次がなければ偽を返します。 Internally, this is based on a posts counter, which is compared to the total number of posts in the collection. The the_post() function then retrieves that next post and updates the internal posts counter. At the next evaluation of have_posts() in the while clause, if another item is present, the while loop body is executed again for the next post. When the posts collection is exhausted (the posts counter matches the total number of posts), the while loop ends and The Loop moves on to whatever instructions it has beyond the while statement, still within the if test. For example, the if might have an else clause with statements to be executed if the posts collection did not contain any data in the first place.

投稿の生成

the_post() 関数は投稿リストの中の現在の投稿を取得し、それをループの繰り返しの内部で使えるようにします。the_post() 関数がないと、テーマで使用されているほとんどのテンプレートタグは正しく機能しません。

投稿データが利用できる状態になった後、テンプレートは投稿データを HTML に変換して訪問者に表示する処理を始めることができます。

タイトル、日付、著者

次のテンプレートタグは現在の投稿タイトル、投稿日時、誰による投稿なのか (著者名) を取得して表示します。

<h2 id="post-<?php the_ID(); ?>">
<a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title(); ?>">
<?php the_title(); ?></a></h2>
<small><?php the_time('F jS, Y') ?> <!-- by <?php the_author() ?> --></small>

本文

the_content() テンプレートタグは投稿の内容を取得し、フィルターを適用した後に、表示します。これはループの各繰り返しにおける重要な部分です。

<div class="entry">
<?php the_content('Read the rest of this entry »'); ?>
</div>

the_content() の説明ページに示されているように、もしクイックタグmore (<!--more--> として記述される) が本文に含まれていた場合、閲覧者にはその行より上の部分のみが表示されます。そのためトップページに各投稿の最初の1文または2文のみを表示させたいときは、単純に <!--more--> を各投稿の最初の1文の直後に入れればよいわけです。 The string passed to the_content() is used for the "Read More" link after the excerpt. For more about excerpts, the <!--more--> quicktag, and the "Read More" link see Template Tags/the_content and Customizing the Read More.

メタデータ

index.php テンプレートファイルにおいて、各投稿の下の部分は投稿のもっと細かな情報を表示する場所です。具体的にはカテゴリ、投稿日時、コメント情報などが表示され、投稿メタデータセクションとしても知られています。充分な権限を持つログイン済みユーザ (または投稿者) の場合、edit_post_link() テンプレートタグ関数によって「編集する」というリンクが表示されます。

<p class="postmetadata">
Posted in <?php the_category(', ') ?> 
<strong>|</strong>
<?php edit_post_link('Edit','','<strong>|</strong>'); ?>  
<?php comments_popup_link('No Comments »', '1 Comment »', '% Comments »'); ?></p>

コメント機能が使用可能になっているか、もしくは投稿にコメントが付いている場合、comments_popup_link() テンプレートタグはコメントへのリンクを表示します。コメントポップアップウィンドウを使っている場合はクリックすることでコメントウィンドウが開きますが、そうでない場合はこの投稿のコメントに飛びます。

またもし訪問者が投稿のリストを見ている場合(ループで複数の投稿を表示している場合)は、comments_popup_link() テンプレートタグは訪問者を個別の投稿記事ページへ飛ばします。

トラックバックの自動検出

trackback_rdf テンプレートタグの働きにより、トラックバックの自動検出に使用される機械可読コードを出力します。

<!--
<?php trackback_rdf(); ?>
-->

Note: The trackback_rdf() tag is intentionally used within an HTML comment; it is not being "turned off". The reason for this is that, otherwise, RDF breaks validation in non-XML documents, and in XHTML documents it is parsed incorrectly by most browsers.

ループの終わり

次のコードはループを終了させます。これより後のコードでは、様々な投稿データに関連したテンプレートタグが期待通り機能しません (またはループの最後の投稿データが使用されます)。これはテンプレートタグをループ内で使いたければ、この行より前にそのタグを置く必要があることを意味しています。

<?php endwhile; ?>

次のセクションは、ループの終わりの直後にあります。これはページ間を前後に移動するためのナビゲーションコントロールを表示します。 More information is available in function reference for posts_nav_link().

<div class="navigation">
<div class="alignleft"><?php posts_nav_link('','','« Previous Entries') ?></div>
<div class="alignright"><?php posts_nav_link('','Next Entries »','') ?></div>
</div>

ブログが1ページあたり10件の投稿をを表示するように設定されていて、ループが全部で25件の投稿を保持している場合、10件のページが2ページと、5件のページが1ページの合わせて3ページ、移動可能なページが存在します。ナビゲーションリンクは訪問者が各ページ間を前後に移動できるようにします。

ナビゲーションコントロールはループの外側にありますが、それらは何らかの投稿がある場合にのみ表示するため、if 条件文の内側に含まれます。 The navigation functions themselves also check whether or not there is anything to which they will link, based on the current Loop, and only display links if there's something to link.

<?php else : ?>
 <h2 class="center">Not Found</h2>
 <p class="center">
<?php _e("Sorry, but you are looking for something that isn't here."); ?></p>

else : 節には最初の have_posts() が偽のときに実行されるコードが書かれています。つまりこの else 以降の部分は投稿が1件もないときにのみ実行・表示されます。例えば訪問者が投稿が1つもない日付を指定したリクエストや検索をするとこれが表示されます。

<?php endif; ?>

このコードによって条件分岐「もし投稿があるときはこれ、そうでないときはそれ」が終わります。その後、デフォルトの index.php テンプレートはサイドバーを、最後にフッターを読み込みます。


他のテンプレートにおけるループ

WordPress can use different template files for displaying your blog in different ways. In the default WordPress theme, there are template files for the index view, category view, and archive view, as well as a template for viewing individual posts. Each of these uses The Loop, but does so with slightly different formatting, as well as different uses of the template tags.

For any view which does not have a separate template file, WordPress will use index.php by default. If a visitor requests a single post, WordPress will first look for a file named single.php. If that file exists, it will be used to present the post to the visitor. If that file does not exist, WordPress will use index.php to present the post to the visitor. This is called the Template Hierarchy.

If you are making your own Theme, it's often helpful to look at the template files from the default Theme as a point of reference. It's also helpful to use your theme's index.php as a template for your other template files. Doing so may give you a known and working page from which to begin making changes as you create more template files.

Different Archive Format

An archive is a collection of historical posts. In the default usage, the posts displayed on your main index are recent chronological postings. When a visitor clicks on one of your archive links, or if they manually request a specific date (http://www.example.com/blog/index.php?m=200504 or http://www.example.com/blog/2005/04 to select all posts from April, 2005), WordPress will display an archive view. By default, the archive will use index.php, and thus look the same as your front page, just displaying the posts from April 2005.

When WordPress prepares an archive view for a visitor, it specifically looks for a file named archive.php in your current theme's directory. If you'd like to visually disambiguate archives from your front page, simply copy index.php to archive.php, and edit archive.php as necessary!

For example, if you want to show only post titles, and no post content, for your list of archives, you could use something like this:

<?php get_header(); ?>
 <div id="content" class="narrowcolumn">

  <?php if (have_posts()) : ?>
   <?php while (have_posts()) : the_post(); ?>
     <div class="post">
     <h2 id="post-<?php the_ID(); ?>">
<a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>"><?php the_title(); ?></a></h2>
     <small><?php the_time('F jS, Y') ?> <!-- by <?php the_author() ?> --></small>
      </div>
    <?php endwhile; ?>
<div class="navigation">
<div class="alignleft">
<?php posts_nav_link('','','&laquo; Previous Entries') ?>
</div>
<div class="alignright">
<?php posts_nav_link('','Next Entries &raquo;','') ?>
</div>
  </div>
<?php else : ?>
  <h2 class="center">Not Found</h2>
 <p class="center"><?php _e("Sorry, but you are looking for something that isn't here."); ?></p>
  <?php endif; ?>
</div>
<?php get_sidebar(); ?>
<?php get_footer(); ?>

Different Category Format

Like the archive views, WordPress looks for a separate template file for category views. If a visitor clicks on a link for a category in your blog, they will be taken to the category view. WordPress will prepare The Loop with posts from that category only, limiting the number of posts per the blog's default settings.

To make your category view different from your index view, copy index.php and rename it category.php. For a category view, it's probably not necessary to list the categories to which a post is assigned, so let's remove that portion. Instead, let's announce the category at the top of the page:

<?php get_header(); ?>
 <div id="content" class="narrowcolumn">
 <p>
 <strong>
  <?php single_cat_title('Currently browsing '); ?>
  </strong><br />
 <?php echo category_description(); ?>
 </p>
 <?php if (have_posts()) : ?>
   <?php while (have_posts()) : the_post(); ?>
     <div class="post">
      <h2 id="post-<?php the_ID(); ?>">
<a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>">
<?php the_title(); ?></a></h2>
   <small>
     <?php the_time('F jS, Y') ?> 
        <!-- by <?php the_author() ?> -->
   </small>
 </div>
<?php endwhile; ?>
 <div class="navigation">
   <div class="alignleft">
    <?php posts_nav_link('','','&laquo; Previous Entries') ?>
   </div>
   <div class="alignright">
    <?php posts_nav_link('','Next Entries &raquo;','') ?>
   </div>
 </div>
<?php else : ?>
  <h2 class="center">Not Found</h2>
<p class="center"><?php _e("Sorry, but you are looking for something that isn't here."); ?></p>
 <?php endif; ?>
</div>
<?php get_sidebar(); ?>
<?php get_footer(); ?>

Different Formats for Different Categories

As explained in the Template Hierarchy, it is possible to create separate template files for each category. Simply name the file category-X.php, where X is the numerical ID of the category. Consider carefully whether you need a whole new template for a specific category.

Let's look at two categories, "Plants" and "Flowers", with category IDs 3 and 4, respectively. Next to each post title in the output you want to have picture of either a plant, or a flower, depending on which category is being displayed. You could:

  • Use two separate files, category-3.php and category-4.php, each with a different img tag for each post title.
  • Use a conditional test inside your default category.php file to check whether the current category is "Plants" or "Flowers" (or neither), and display the appropriate image:
<?php if (is_category('3') ):
 // we're in the Plants category, so show a plant ?>
 <img src='/images/plant.png' alt='a plant' />
<?php } elseif (is_category('4') ):
 // we're in the Flowers category, so show a flower ?>
 <img src='/images/flower.png' alt='a pretty flower' />
<?php endif; // end the if, no images for other other categories ?>

If you added another category, "Cars", which you wanted to display in a significantly different way, then a separate category-X.php would be more appropriate.

Different CSS For Different Categories

Many users want to create separate CSS files for a specific category. This, too, can be easily accomplished. It is important to remember that stylesheets are defined and loaded in the <head> section of the HTML document. WordPress uses the header.php file for this. In the default header.php, find this line:

<link rel="stylesheet" href="<?php bloginfo('stylesheet_url'); ?>" type="text/css" media="screen" />

And change it to something like this:

<?php if ( is_category('5') ) { // Load special CSS for "Cars" category ?>
  <link rel="stylesheet" href="<?php bloginfo('template_url'); ?>/category-5.css" type="text/css" media="screen" />;
<?php } else { ?>
   <link rel="stylesheet" href="<?php bloginfo('stylesheet_url'); ?>" type="text/css" media="screen" />
<?php } ?>

Note: The Cars template uses the category-5.css file to override the default layout. In this example the CSS file is named after the category template file to which it will be applied, rather than the actual name of the category. Thus, you know that category-5.css goes with category-5.php.

Different Single Post Format

When viewing any single post (or permalink), WordPress will use single.php, if present.

This portion, from the WordPress default single.php, provides the post meta data information about the current post:

<p class="postmetadata alt">
<small>
This entry was posted on <?php the_time('l, F jS, Y') ?> at <?php the_time() ?> 
and is filed under <?php the_category(', ') ?>.
You can follow any responses to this entry through 
the <?php comments_rss_link('RSS 2.0'); ?> feed.
<?php
if ( comments_open() && pings_open() ) {
// Both Comments and Pings are open
?>
  You can <a href="#respond">leave a response</a>, or 
  <a href="<?php trackback_url(display); ?>">trackback</a> 
from your own site.
<?php 
} elseif ( !comments_open() && pings_open() ) {
// Only Pings are Open 
?>
  Responses are currently closed, but you can 
  <a href="<?php trackback_url(display); ?> ">trackback</a> 
from your own site.
<?php
} elseif ( comments_open() && !pings_open() ) { 
// Comments are open, Pings are not 
?>
  You can skip to the end and leave a response. Pinging is currently not allowed.
<?php
} else { 
// Neither Comments, nor Pings are open 
?>
  Both comments and pings are currently closed.
<?php 
} 
edit_post_link('Edit this entry.','',''); ?>
</small>
</p>

This sort of information -- whether comments are open or closed -- is largely inappropriate on an index, archive, or category view; which is why it's only included in the single.php template file.


その他のループテクニック

Now that you have a good introduction to the basic uses for the WordPress Loop, let's introduce you to some more Loop effects and tricks.

Static Front Page

How can you display something special only on the front page of your blog? That's right, only on the front page or home page, and have it not be seen anywhere else on your site. Easy! We call this the static front page. The front or first page of your site isn't really static. It's just using the Loop to make it look that way.

To make this Loop trick work, use the is_home() conditional template tag function.

In your index.php, use an if () test to conditionally output additional content:

<?php get_header(); ?>
<?php if (is_home()) {
 // we're on the home page, so let's show a picture of our new kitten!
 echo "<img src='/images/new_kitty.jpg' alt='Our new cat, Rufus!' />";
 // and now back to our regularly scheduled home page
} ?> 

The function is_home() will only produce a true value if the visitor is not requesting a specific post, page, category, or date, so it only shows up on the "home" page.

For more information, see Creating a Static Front Page.

Excerpts Only

The easiest way to display excerpts, instead of the full content of posts, is to replace all instances of the_content() with the_excerpt(). If you have not created explicit excerpts for your posts, this function will automatically display the first 55 words of the post.

<div class="entry">
<?php the_excerpt(); ?>
</div>

Showing Excerpts or Full Post Depending Upon Number of Posts

In some circumstances, for example on archive pages, you may want to show the full post if there is only one post or excerpts if there are multiple posts. You can customize the loop to do this.

<?php if (have_posts()) : ?>

  <?php if (($wp_query->post_count) > 1) : ?>
     <?php while (have_posts()) : the_post(); ?>
       <!-- Do your post header stuff here for excerpts-->
          <?php the_excerpt() ?>
       <!-- Do your post footer stuff here for excerpts-->
     <?php endwhile; ?>

  <?php else : ?>

     <?php while (have_posts()) : the_post(); ?>
       <!-- Do your post header stuff here for single post-->
          <?php the_content() ?>
       <!-- Do your post footer stuff here for single post-->
     <?php endwhile; ?>

  <?php endif; ?>

<?php else : ?>
     <!-- Stuff to do if there are no posts-->

<?php endif; ?>

Different Headers/Sidebars/Footers

WordPress offers the get_header(), get_sidebar(), and get_footer() Include Tags for use in your template files. These functions make it easy to define a standard header/sidebar/footer which is easily editable. Any changes made to these files will immediately be made visible to viewers, without any work on your part.

But sometimes you might not want a sidebar. If you don't want a sidebar, simply exclude the call to the get_sidebar() function from your template. For example, the single.php template in the WordPress default theme does not include a sidebar.

To create your own different sidebar, you have two choices:

  1. Include the sidebar contents directly into the template file on which you're working. If you want category-3 to have a different sidebar, edit category-3.php and include the necessary HTML and PHP to generate your distinctive sidebar.
  2. Use the PHP include function, to include another file. The WordPress get_sidebar() function only loads sidebar.php. If you make a file named sideleft.php, you would include it like this:
<?php include(TEMPLATEPATH . '/sideleft.php'); ?>

In WordPress Version 2.5 and above you can also call a sidebar like this:

<?php get_sidebar('right'); ?>

This causes the template TEMPLATEPATH . 'sidebar-right.php' to be included.

Using the WordPress default Template Hierarchy, if you want to use the same elements on multiple or different templates, it's probably best to put them in separate template files and use the PHP include() function. If the element you're adding is specifically for one template file, it's probably best to include it directly in that template file.


まとめ

We've just scratched the surface of what can be done with the Loop. As a reminder, the following are resources that will help you customize your own WordPress Loop.

最新英語版: WordPress Codex » The_Loop_in_Action最新版との差分