type = $type; $this->attributes = $attributes; $this->dismiss_url = $dismiss_url; } /** * Display the admin notice. * * Will print the notice if called during the 'admin_notices' action. Otherwise will attach a callback and display the notice when the 'admin_notices' is triggered. * * @since 2.3.0 */ public function display() { if ( 'admin_notices' !== current_filter() ) { add_action( 'admin_notices', array( $this, __FUNCTION__ ) ); return; } wc_get_template( 'html-admin-notice.php', array( 'notice' => $this ), '', plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'templates/admin/' ); } /** * Whether the admin notice is dismissible. * * @since 2.3.0 * @return boolean */ public function is_dismissible() { return ! empty( $this->dismiss_url ); } /** * Whether the admin notice has a heading or not. * * @since 2.3.0 * @return boolean */ public function has_heading() { return ! empty( $this->heading ); } /** * Whether the admin notice has actions or not. * * @since 2.3.0 * @return boolean */ public function has_actions() { return ! empty( $this->actions ) && is_array( $this->actions ); } /* Printers */ /** * Print the notice's heading. * * @since 2.3.0 */ public function print_heading() { echo esc_html( $this->heading ); } /** * Get the notice's content. * * Will wrap simple notices in paragraph elements (

) for correct styling and print HTML notices unchanged. * * @since 2.3.0 */ public function print_content() { switch ( $this->content_type ) { case 'simple': echo '

' . wp_kses_post( $this->content ) . '

'; break; case 'html': echo wp_kses_post( $this->content ); break; case 'template': wc_get_template( $this->content['template_name'], $this->content['args'], '', $this->content['template_path'] ); break; } } /** * Print the notice's attributes. * * Turns the attributes array into 'id="id" class="class class class"' strings. * * @since 2.3.0 */ public function print_attributes() { $attributes = $this->attributes; $attributes['class'][] = $this->type; if ( $this->is_dismissible() ) { $attributes['style'][] = 'position: relative;'; } foreach ( $attributes as $attribute => $values ) { $attributes[ $attribute ] = $attribute . '="' . implode( ' ', array_map( 'esc_attr', $values ) ) . '"'; } echo wp_kses_post( implode( ' ', $attributes ) ); } /** * Print the notice's dismiss URL. * * @since 2.3.0 */ public function print_dismiss_url() { echo esc_attr( $this->dismiss_url ); } /* Getters */ /** * Get the notice's actions. * * @since 2.3.0 * @return array */ public function get_actions() { return $this->actions; } /* Setters */ /** * Set the notice's content to a simple string. * * @param string $content The notice content. */ public function set_simple_content( $content ) { $this->content_type = 'simple'; $this->content = $content; } /** * Set the notice's content to a string containing HTML elements. * * @param string $html The notice content. */ public function set_html_content( $html ) { $this->content_type = 'html'; $this->content = $html; } /** * Set the notice's content to a string containing HTML elements. * * @since 2.3.0 * @param string $template_name Template name. * @param string $template_path Template path. * @param array $args Arguments. (default: array). */ public function set_content_template( $template_name, $template_path, $args = array() ) { $this->content_type = 'template'; $this->content = array( 'template_name' => $template_name, 'template_path' => $template_path, 'args' => $args, ); } /** * Set actions the user can make in response to this notice. * * @since 2.3.0 * @param array $actions The actions the user can make. Example format: * array( * array( * 'name' => 'The actions's name', // This arg will appear as the button text. * 'url' => 'url', // The url the user will be directed to if clicked. * 'class' => 'class string', // The class attribute string used in the link element. Optional. Will default to 'docs button' - a plain button. * ) * ) */ public function set_actions( array $actions ) { $this->actions = $actions; } /** * Set notice's heading. If set this will appear at the top of the notice wrapped in a h2 element. * * @since 2.3.0 * @param string $heading The notice heading. */ public function set_heading( $heading ) { $this->heading = $heading; } }