sanitize_post_field() │ WP 2.3.0

Очищає вказане значення вказаного поля посту. Рівень очищення вказується у параметрі $context .

Основа для:
sanitize_post() ,
get_post_field()

Хуки з функції

Повертає

Разное. Очищене значення.

Використання

sanitize_post_field( $field, $value, $post_id, $context );
$field
(рядок) (обов’язковий)

Назва поля об’єкта посту. Можливі значення:

ID
post_author
post_date
post_date_gmt
post_content
post_title
post_excerpt
post_status
comment_status
ping_status
post_password
post_name
to_ping
pinged
post_modified
post_modified_gmt
post_content_filtered
post_parent
guid
menu_order
post_type
post_mime_type
comment_count
filter
$value
(змішаний) (обов’язковий)
Значення поля об’єкта посту.
$post_id
(число) (обов’язковий)
ID посту.
$context
(рядок) (обов’язковий)

Як проводити очищення вказаного поля. Може бути:

  • raw– для використання у рядку;
  • edit– для подальшого редагування;
  • db– для використання у запиті;
  • display– для виведення на екран;
  • attribute– для використання в атрибуті;
  • js– для використання у даних скрипта.

Типово: ‘display’

Приклади

0

#1 Очищення для виведення на екран

Очистимо заголовок посту перед виведенням його на екран:

$post = get_post(35);

$post_title = sanitize_post_field( 'post_title', $post->post_title, $post->ID, 'display' );

echo $post_title;
0

#2 Очищення атрибутів

Очистимо значення поля перед використанням його в атрибуті HTML тега. Видаляє теги та інше, щоб значення можна було використовувати в атрибуті і воно не викликало помилок:

$post = get_post(543);

$post_title = sanitize_post_field( 'post_title', $post->post_title, $post->ID, 'attribute' );

echo '<input type="hidden" name="post-title" value="' . $post_title . '" />';

список змін

З версії 2.3.0Введено.
З версії 4.4.0Як sanitize_post () , $context defaults to ‘display’ .

Код sanitize_post_field() WP 6.0.2

wp-includes/post.php 
function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
	$int_fields = array( 'ID', 'post_parent', 'menu_order' );
	if ( in_array( $field, $int_fields, true ) ) {
		$ value = (int) $ value;
	}

	// Fields which contain arrays of integers.
	$array_int_fields = array( 'ancestors' );
	if ( in_array( $field, $array_int_fields, true ) ) {
		$value = array_map( 'absint', $value );
		return $value;
	}

	if ( 'raw' === $context ) {
		return $value;
	}

	$prefixed = false;
	if ( false !== strpos( $field, 'post_' ) ) {
		$prefixed = true;
		$field_no_prefix = str_replace( 'post_', '', $field );
	}

	if ( 'edit' === $context ) {
		$format_to_edit = array( 'post_content', 'post_excerpt', 'post_title', 'post_password');

		if ( $prefixed ) {

			/**
			 * Filters є значенням для конкретного польового поля до edit.
			 *
			 * The dynamic portion of hook name, `$field`, refers to the post
			 * field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of the post field.
			 * @param int $post_id Post ID.
			 */
			$value = apply_filters( "edit_{$field}", $value, $post_id );

			/**
			 * Filters є значенням для конкретного польового поля до edit.
			 *
			 * The dynamic portion of hook name, `$field_no_prefix`, refers to
			 * the post field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of the post field.
			 * @param int $post_id Post ID.
			 */
			$value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
		} else {
			$value = apply_filters( "edit_post_{$field}", $value, $post_id );
		}

		if ( in_array( $field, $format_to_edit, true ) ) {
			if ( 'post_content' === $field ) {
				$value = format_to_edit( $value, user_can_richedit() );
			} else {
				$ Value = format_to_edit ($ Value);
			}
		} else {
			$ value = esc_attr ($ value);
		}
	} elseif ( 'db' === $context ) {
		if ( $prefixed ) {

			/**
			 * Filters the value of a specific post field before saving.
			 *
			 * The dynamic portion of hook name, `$field`, refers to the post
			 * field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of the post field.
			 */
			$value = apply_filters( "pre_{$field}", $value );

			/**
			 * Filters the value of a specific field before saving.
			 *
			 * The dynamic portion of the hook name, `$field_no_prefix`, refers
			 * to the post field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of the post field.
			 */
			$value = apply_filters( "{$field_no_prefix}_save_pre", $value );
		} else {
			$value = apply_filters( "pre_post_{$field}", $value );

			/**
			 * Filters the value of a specific post field before saving.
			 *
			 * The dynamic portion of hook name, `$field`, refers to the post
			 * field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of the post field.
			 */
			$value = apply_filters( "{$field}_pre", $value );
		}
	} else {

		// Use display filters by default.
		if ( $prefixed ) {

			/**
			 * Filters значення для specific post field for display.
			 *
			 * The dynamic portion of hook name, `$field`, refers to the post
			 * field name.
			 *
			 * @ Since 2.3.0
			 *
			 * @param mixed $value Value of prefixed post field.
			 * @param int $post_id Post ID.
			 * @param string $context Context for how to sanitize the field.
			 * Accepts 'raw', 'edit', 'db', 'display',
			 * 'attribute', or 'js'. Default 'display'.
			 */
			$value = apply_filters( "{$field}", $value, $post_id, $context );
		} else {
			$value = apply_filters("post_{$field}", $value, $post_id, $context);
		}

		if ( 'attribute' === $context ) {
			$ value = esc_attr ($ value);
		} elseif ( 'js' === $context ) {
			$ value = esc_js ($ value);
		}
	}

	// Відновити тип для integer fields after esc_attr().
	if ( in_array( $field, $int_fields, true ) ) {
		$ value = (int) $ value;
	}

	return $value;
}

Очищення перевірка (sanitize_check)

Очищення даних