is_sticky

説明

bool is_sticky( [ int $post_id = 0 ] )
投稿が「先頭に固定表示(sticky)」か調べる。

パラメータ

  • $post_id
    投稿IDを指定(省略時は0)。

返り値

対象の投稿が「先頭に固定表示(sticky)」の場合はtrueを、それ以外はfalseを返す。

注意

パラメータ$post_idの省略時(0の場合)、 get_the_ID関数にて現在の投稿情報のIDを取得している。

使用例

  • 現在の投稿記事がstickyか調べる。
    <?php if ( is_sticky() ) : ?>
  • $postの投稿記事がstickyか調べる。
    <?php if ( is_sticky( $post->ID ) ) : ?>

フィルター

[5.3.0]判定結果を返す前に'is_sticky'フィルターを呼び出す。パラメータ$is_stickyには判定結果が、$post_idには本関数が受け取った投稿IDが格納されている。
return apply_filters( 'is_sticky', $is_sticky, $post_id );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/post.php

最終更新 : 2019年11月19日 14:39



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。