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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

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

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