Automattic / Automattic/VIP-Coding-Standards

Support when esc_xml() should be used

オープン
#555 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
Standard: VIP-Go Type: Enhancement
主要言語
PHP
スター
261
フォーク
44
平均マージ
19分
マージ済み PR(30日)
1

説明

## What problem would the enhancement address for VIP?

`esc_xml()` is being [introduced in WP 5.5](https://make.wordpress.org/core/2020/07/21/new-esc_xml-function-in-wordpress-5-5/).

It would be great if WordPressVIPMinimum.Security.ProperEscapingFunction sniff could recognise when an escaping function is being used (typically `esc_html()` up to now, but someone may have used an incorrect escaping function) in an XML context.

## Describe the solution you'd like

Update the existing sniff.

Update our public docs to better clarify when `esc_xml()` should be used.

## What code should be reported as a violation?

{Needs examples}

## What code should *not* be reported as a violation?

{Needs examples}

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、既存の WordPressVIPMinimum.Security.ProperEscapingFunction sniff と、それが参照している公開ドキュメントを読みます。esc_xml() の導入と、要求されている XML コンテキストでの動作を使って、代表的な報告対象および報告対象外の例を定義します。完了の条件は、sniff が正しいエスケープ関数を認識し、ドキュメントで esc_xml() を使用すべき場合が説明されていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
php
領域
documentation, tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。