register_post_status()

Примеры использования

Регистрация нового статуса поста

function wpdocs_register_custom_post_status() {
    $args = array(
        'label'                     => _x( 'Custom Status', 'post' ),
        'public'                    => true,
        'exclude_from_search'       => false,
        'show_in_admin_all_list'    => true,
        'show_in_admin_status_list' => true,
        'label_count'               => _n_noop( 'Custom Status (%s)', 'Custom Status (%s)' ),
    );
    register_post_status( 'custom_status', $args );
}
add_action( 'init', 'wpdocs_register_custom_post_status' );

В этом примере кода мы регистрируем новый статус поста с названием «Custom Status». Опция «public» установлена в значение «true», что означает, что посты с этим статусом будут отображаться на фронтенде сайта. Опция «exclude_from_search» установлена в значение «false», что означает, что посты с этим статусом будут включены в результаты поиска. Опция «show_in_admin_all_list» установлена в значение «true», что означает, что посты с этим статусом будут отображаться в списке редактирования для их типа поста. Опция «show_in_admin_status_list» установлена в значение «true», что означает, что статус будет отображаться в списке статусов с количеством постов в верхней части списка редактирования. Опция «label_count» используется для указания текста в единственном и множественном числе для статуса.

Изменение названия статуса поста

function wpdocs_change_custom_post_status_label() {
    global $wp_post_statuses;
    $wp_post_statuses['custom_status']->label = 'New Custom Status';
}
add_action( 'init', 'wpdocs_change_custom_post_status_label' );

В этом примере кода мы изменяем название статуса поста «Custom Status» на «New Custom Status». Для этого мы обращаемся к глобальной переменной «$wp_post_statuses» и изменяем значение свойства «label» для статуса «custom_status».

Исключение постов с определенным статусом из результатов поиска

function wpdocs_exclude_custom_post_status_from_search( $query ) {
    if ( ! is_admin() && $query->is_main_query() ) {
        $query->set( 'post_status', array( 'publish', 'custom_status' ) );
    }
}
add_action( 'pre_get_posts', 'wpdocs_exclude_custom_post_status_from_search' );

В этом примере кода мы исключаем посты с статусом «custom_status» из результатов поиска. Для этого мы используем хук «pre_get_posts» и устанавливаем значение «post_status» в массиве параметров запроса.

Отображение постов с определенным статусом на фронтенде сайта

function wpdocs_show_custom_post_status_on_frontend( $query ) {
    if ( ! is_admin() && $query->is_main_query() ) {
        $query->set( 'post_status', array( 'publish', 'custom_status' ) );
    }
}
add_action( 'pre_get_posts', 'wpdocs_show_custom_post_status_on_frontend' );

В этом примере кода мы отображаем посты с статусом «custom_status» на фронтенде сайта. Для этого мы используем хук «pre_get_posts» и устанавливаем значение «post_status» в массиве параметров запроса.

Защита постов с определенным статусом

function wpdocs_protect_custom_post_status( $protected, $post ) {
    if ( 'custom_status' === $post->post_status ) {
        $protected = true;
    }
    return $protected;
}
add_filter( 'protected_post_status', 'wpdocs_protect_custom_post_status', 10, 2 );

В этом примере кода мы защищаем посты с статусом «custom_status». Для этого мы используем фильтр «protected_post_status» и устанавливаем значение переменной «$protected» в «true» для постов с указанным статусом.

Установка постов с определенным статусом как приватных

function wpdocs_set_custom_post_status_as_private( $private, $post ) {
    if ( 'custom_status' === $post->post_status ) {
        $private = true;
    }
    return $private;
}
add_filter( 'private_post_status', 'wpdocs_set_custom_post_status_as_private', 10, 2 );

В этом примере кода мы устанавливаем посты с статусом «custom_status» как приватные. Для этого мы используем фильтр «private_post_status» и устанавливаем значение переменной «$private» в «true» для постов с указанным статусом.

Возможность публичного запроса постов с определенным статусом

function wpdocs_make_custom_post_status_publicly_queryable( $publicly_queryable, $post ) {
    if ( 'custom_status' === $post->post_status ) {
        $publicly_queryable = true;
    }
    return $publicly_queryable;
}
add_filter( 'publicly_queryable_post_status', 'wpdocs_make_custom_post_status_publicly_queryable', 10, 2 );

В этом примере кода мы разрешаем публичный запрос постов с статусом «custom_status». Для этого мы используем фильтр «publicly_queryable_post_status» и устанавливаем значение переменной «$publicly_queryable» в «true» для постов с указанным статусом.

Отображение постов с определенным статусом в списке редактирования для их типа поста

function wpdocs_show_custom_post_status_in_edit_listing( $statuses ) {
    $statuses['custom_status'] = _x( 'Custom Status', 'post' );
    return $statuses;
}
add_filter( 'display_post_states', 'wpdocs_show_custom_post_status_in_edit_listing' );

В этом примере кода мы отображаем статус «Custom Status» в списке редактирования для его типа поста. Для этого мы используем фильтр «display_post_states» и добавляем новый статус в массив «$statuses».

Отображение статусов с количеством постов в верхней части списка редактирования

function wpdocs_show_custom_post_status_with_counts( $views ) {
    $args = array(
        'post_type'   => 'post',
        'post_status' => 'custom_status',
        'posts_per_page' => -1,
    );
    $count = new WP_Query( $args );
    $count = $count->found_posts;
    $views['custom_status'] = sprintf( __( 'Custom Status (%s)', 'textdomain' ), number_format_i18n( $count ) );
    return $views;
}
add_filter( 'views_edit-post', 'wpdocs_show_custom_post_status_with_counts' );

В этом примере кода мы отображаем статус «Custom Status» с количеством постов в верхней части списка редактирования. Для этого мы используем фильтр «views_edit-post» и добавляем новый статус в массив «$views». Мы также используем функцию «WP_Query» для подсчета количества постов с указанным статусом.

Установка плавающей даты создания поста

function wpdocs_set_custom_post_status_date_floating( $date_floating, $post ) {
    if ( 'custom_status' === $post->post_status ) {
        $date_floating = true;
    }
    return $date_floating;
}
add_filter( 'date_floating_post_status', 'wpdocs_set_custom_post_status_date_floating', 10, 2 );

В этом примере кода мы устанавливаем плавающую дату создания для постов с статусом «custom_status». Для этого мы используем фильтр «date_floating_post_status» и устанавливаем значение переменной «$date_floating» в «true» для постов с указанным статусом.