166 lines
5.2 KiB
PHP
166 lines
5.2 KiB
PHP
<?php
|
|
|
|
if ( ! class_exists( 'GFForms' ) ) {
|
|
die();
|
|
}
|
|
|
|
class GF_Field_Post_Excerpt extends GF_Field {
|
|
|
|
public $type = 'post_excerpt';
|
|
|
|
public function get_form_editor_field_title() {
|
|
return esc_attr__( 'Excerpt', 'gravityforms' );
|
|
}
|
|
|
|
/**
|
|
* Returns the field's form editor description.
|
|
*
|
|
* @since 2.5
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_form_editor_field_description() {
|
|
return esc_attr__( 'Allows users to submit data that is then used as the excerpt of a post.', 'gravityforms' );
|
|
}
|
|
|
|
/**
|
|
* Returns the field's form editor icon.
|
|
*
|
|
* This could be an icon url or a gform-icon class.
|
|
*
|
|
* @since 2.5
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_form_editor_field_icon() {
|
|
return 'gform-icon--excerpt';
|
|
}
|
|
|
|
function get_form_editor_field_settings() {
|
|
return array(
|
|
'post_status_setting',
|
|
'post_category_setting',
|
|
'post_author_setting',
|
|
'conditional_logic_field_setting',
|
|
'prepopulate_field_setting',
|
|
'error_message_setting',
|
|
'label_setting',
|
|
'label_placement_setting',
|
|
'admin_label_setting',
|
|
'size_setting',
|
|
'maxlen_setting',
|
|
'rules_setting',
|
|
'visibility_setting',
|
|
'default_value_textarea_setting',
|
|
'placeholder_textarea_setting',
|
|
'description_setting',
|
|
'css_class_setting',
|
|
);
|
|
}
|
|
|
|
public function is_conditional_logic_supported() {
|
|
return true;
|
|
}
|
|
|
|
public function get_field_input( $form, $value = '', $entry = null ) {
|
|
|
|
$form_id = absint( $form['id'] );
|
|
$is_entry_detail = $this->is_entry_detail();
|
|
$is_form_editor = $this->is_form_editor();
|
|
|
|
$id = (int) $this->id;
|
|
$field_id = $is_entry_detail || $is_form_editor || $form_id == 0 ? "input_$id" : 'input_' . $form_id . "_$id";
|
|
|
|
$value = esc_textarea( $value );
|
|
$size = $this->size;
|
|
$class_suffix = $is_entry_detail ? '_admin' : '';
|
|
$class = $size . $class_suffix;
|
|
$class = esc_attr( $class );
|
|
|
|
$disabled_text = $is_form_editor ? 'disabled="disabled"' : '';
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
$placeholder_attribute = $this->get_field_placeholder_attribute();
|
|
$required_attribute = $this->isRequired ? 'aria-required="true"' : '';
|
|
$invalid_attribute = $this->failed_validation ? 'aria-invalid="true"' : 'aria-invalid="false"';
|
|
$aria_describedby = $this->get_aria_describedby();
|
|
|
|
return "<div class='ginput_container ginput_container_post_excerpt'>
|
|
<textarea name='input_{$id}' id='{$field_id}' class='textarea {$class}' {$tabindex} {$placeholder_attribute} {$required_attribute} {$invalid_attribute} {$aria_describedby} {$disabled_text} rows='10' cols='50'>{$value}</textarea>
|
|
</div>";
|
|
}
|
|
|
|
public function allow_html() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Format the entry value for when the field/input merge tag is processed. Not called for the {all_fields} merge tag.
|
|
*
|
|
* Return a value that is safe for the context specified by $format.
|
|
*
|
|
* @since Unknown
|
|
* @access public
|
|
*
|
|
* @uses GF_Field::get_allowable_tags()
|
|
*
|
|
* @param string|array $value The field value. Depending on the location the merge tag is being used the following functions may have already been applied to the value: esc_html, nl2br, and urlencode.
|
|
* @param string $input_id The field or input ID from the merge tag currently being processed.
|
|
* @param array $entry The Entry Object currently being processed.
|
|
* @param array $form The Form Object currently being processed.
|
|
* @param string $modifier The merge tag modifier. e.g. value
|
|
* @param string|array $raw_value The raw field value from before any formatting was applied to $value.
|
|
* @param bool $url_encode Indicates if the urlencode function may have been applied to the $value.
|
|
* @param bool $esc_html Indicates if the esc_html function may have been applied to the $value.
|
|
* @param string $format The format requested for the location the merge is being used. Possible values: html, text or url.
|
|
* @param bool $nl2br Indicates if the nl2br function may have been applied to the $value.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_value_merge_tag( $value, $input_id, $entry, $form, $modifier, $raw_value, $url_encode, $esc_html, $format, $nl2br ) {
|
|
|
|
if ( $format === 'html' ) {
|
|
$form_id = absint( $form['id'] );
|
|
$allowable_tags = $this->get_allowable_tags( $form_id );
|
|
|
|
if ( $allowable_tags === false ) {
|
|
// The value is unsafe so encode the value.
|
|
$return = esc_html( $value );
|
|
} else {
|
|
// The value contains HTML but the value was sanitized before saving.
|
|
$return = $value;
|
|
}
|
|
|
|
// If $nl2br is true nl2br() may have already been run in GFCommon::format_variable_value().
|
|
if ( ! $nl2br ) {
|
|
// Run nl2br() to preserve line breaks when auto-formatting is disabled on notifications/confirmations.
|
|
$return = nl2br( $return );
|
|
}
|
|
} else {
|
|
$return = $value;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
// # FIELD FILTER UI HELPERS ---------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the filter operators for the current field.
|
|
*
|
|
* @since 2.4
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_filter_operators() {
|
|
$operators = parent::get_filter_operators();
|
|
$operators[] = 'contains';
|
|
|
|
return $operators;
|
|
}
|
|
|
|
}
|
|
|
|
GF_Fields::register( new GF_Field_Post_Excerpt() );
|